HM_ExtAPI::CADDocumentGetNext()

Returns next document from the same level of the model assembly hierarchy of the CAD model loaded into the database.

Syntax

bool CADDocumentGetNext(
const HM_CAD_Document & doc,
HM_CAD_Document & next_doc
);

Type

HyperMesh Ext API

Description

The function CADDocumentGetNext is used together with the functions HM_ExtAPI::GetRootCADDocument() andHM_ExtAPI::CADDocumentGetFirstChild() 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.
next_doc: [in/out] - Handle to the next document. The value of the handle is zero if the document doc is the last document in the list of documents on the same level.

Errors

None.