HM_ExtAPI::CADDocumentGetFileName()

Returns the complete path to the CAD model file, from which the model assembly hierarchy document was imported.

Syntax

const char* CADDocumentGetFileName(
const HM_CAD_Document & doc
);

Type

HyperMesh Ext API Function

Description

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

If the function succeeds, the return value is the pointer to zero terminated string that contains the full path to the original CAD model file name. If the function fails, the return value is NULL. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Do not attempt to free the returned pointer.

Requires including hm_extapi.h.

Inputs

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

Errors

None.