HM_ExtAPI::CADDocumentGetInstanceName()

Returns the full instance name of the model assembly hierarchy document in the assembly hierarchy tree.

Syntax

const char* CADDocumentGetInstanceName(
const HM_CAD_Document & doc
);

Type

HyperMesh Ext API

Description

The string that is returned from the function HM_ExtAPI::CADDocumentGetInstanceName() should be copied for further use.

If the function succeeds, the return value is the pointer to zero terminated string that contains the full instance name of the document. The return value can also be NULL. This usually means that assembly hierarchy is not supported by the CAD translator used for loading the model.

Do not attempt to free the returned pointer.

The instance name of the document combines the document’s own name (independent on the assembly that it is contained in) and the link name that is used to reference this document in the assembly.

Requires including hm_extapi.h.

Inputs

doc: [in] - Handle to document object that was returned by previous calls to API functions.
Figure 1.

Errors

None.