HM_ExtAPI::GridGetID()

Returns numeric ID of the grid point of a mesh.

Syntax

bool GridGetID(
const HM_EntityMesh & hmesh,
const HM_EntityGrid & hgrid,
int & grid_id
);

Type

HyperMesh Ext API Function

Description

The grid point referenced by the handle hgrid must belong to the mesh referenced by the handle hmesh. That is only the grid handles obtained in previous calls to API functions using the same mesh handle hmesh must be used.

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

hmesh: [in] - Handle to mesh object that was returned by previous calls to API functions.
hgrid: [in] - Handle referencing the grid point.
grid_id: [out] - Grid ID.

Errors

None.