COM.documentationName Method

Definition

Returns the textual name of the COM object that is associated with the instance of the COM class.

public:
 virtual System::String ^ documentationName();
public virtual string documentationName ();
abstract member documentationName : unit -> string
override this.documentationName : unit -> string
Public Overridable Function documentationName () As String

Returns

The textual name of the COM object that is associated with the instance of the COM class; an empty string if there is no documentation name for the COM object.

Remarks

The textual name of a class is used by the class to describe itself. The textual name differs from the class name that is used to instantiate the class.

The following example shows how to retrieve the documentation name for a COM object.

str docName; 
; 
// The obj that was previously instantiated. 
docName = obj.documentationName(); 
info(strfmt("documentationName: %1", docName));

Applies to