COM.documentationName Method

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

Syntax

public str documentationName()

Run On

Called

Return Value

Type: str
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.

Examples

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));

See Also

Reference

COM Class