IPen.Name [Property][Get/Set]

Get or Set the name of this pen.

Defined As

• [VBA] String Name
• [Cicode] STRING Name
• [C++] BSTR Name

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the length of the name is wrong then the return value will be InvalidArgument. If the pen is deleted then the return value will be GeneralFailure.

Remarks

The Process Analyst will use this name extensively throughout the user interface to reference this pen.

The name of the pen does not have to be unique, but it needs to be between 1 and 250 character long.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)

 Dim name As String

		`Getting Property value

   name = pen.Name

   `Setting property value

   pen.Name = "NicePen"

End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)

	STRING name;

	// Getting current property value

 name = _ObjectGetProperty(hPen, "Name");

  // Setting property value

 _ObjectSetProperty(hPen, "Name", "NicePen");

END