HM_ExtAPI::MeshGetFirstGrid()

Returns the first grid point in a mesh referenced by a mesh object.

Syntax

bool MeshGetFirstGrid(
const HM_EntityMesh& hmesh,
HM_EntityGrid & hgrid
);

Type

HyperMesh Ext API

Description

The function MeshGetFirstGrid is used together with the function HM_ExtAPI::MeshGetNextGrid() to iterate through all the grid points contained in the mesh referenced by the mesh object. The call to MeshGetFirstGrid resets internal grid counter of the mesh object to the first grid point. The following calls to MeshGetNextGrid increment the counter until all grid points are iterated. 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: [out] - Handle to the first grid point in the mesh referenced by mesh object. The value of the handle is zero in case the mesh does not have grid points.

Errors

None.