HM_ExtAPI::ComponentGetImportedName()

Returns original name of the component in the model structure of imported CAD model.

Syntax

const char* ComponentGetImportedName(
const HM_EntityComponent& comp
);

Type

HyperMesh Ext API Function

Description

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

If the function succeeds, the return value is the pointer to zero terminated string that contains original name of the component. The return value can also be NULL. For valid components this means that either component was created within HyperMesh session or that the component mapping to original CAD model was not preserved during the import.

Do not attempt to free the returned pointer.

Specifics of the mapping of HyperMesh components to original CAD model structure depend on translator options used during the import. For example, to enable closer mapping of components to CATIA "geometric set" the option @SplitComponentsBySet has to be set to "on" in catia.ini file. See HyperMesh import translators documentation for more details.

Requires including hm_extapi.h.

Inputs

comp
[in] - Handle to component object that was returned by previous calls to API functions.

Errors

None.