HM_ExtAPI::CADDocumentGetFirstChild()

Returns the first child of the document in the model assembly hierarchy of the CAD model loaded into the database.

Syntax

bool CADDocumentGetFirstChild(
const HM_CAD_Document & doc,
HM_CAD_Document & child_doc
);

Type

HyperMesh Ext API

Description

The function CADDocumentGetFirstChild is used together with the functions HM_ExtAPI::GetRootCADDocument() and HM_ExtAPI::CADDocumentGetNext() to browse the model assembly hierarchy tree.

If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Requires including hm_extapi.h.

Inputs

doc: [in] - Handle to document object that was returned by previous calls to API functions.
child_doc: [out] - Handle to the child document. The value of the handle is zero if the document doc does not have any children.

Errors

None.