HM_ExtAPI::CADDocumentGetLinkName()

Returns the name of the link used as a reference to the model assembly hierarchy document in the assembly hierarchy tree.

Syntax

const char* CADDocumentGetLinkName(
const HM_CAD_Document & doc
);

Type

HyperMesh Ext API

Description

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

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

Do not attempt to free the returned pointer.

The link name is the name that is used within the assembly to reference the document within the assembly. The root documents normally do not have the link name.

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.