HM_ExtAPI::ComponentGetFirstFreeGeomLine()
Returns the first free line of the component.
Syntax
bool ComponentGetFirstFreeGeomLine(
const HM_EntityComponent& comp,
HM_EntityGeomEdge& fline
);Type
HyperMesh Ext API Function
Description
The function ComponentGetFirstFreeGeomLine is used together with the function HM_ExtAPI::ComponentGetNextFreeGeomLine() to iterate through all free lines contained in the component. The call to ComponentGetFirstFreeGeomLine resets internal component counter to the first line. The following calls to ComponentGetNextFreeGeomLine increment the counter until all free lines of the component 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
- comp
- [in] - Handle to component object that was returned by previous calls to API functions.
- fline
- [out] - Handle to the first free line of the component. The value of the handle is zero in case if component does not contain free lines.
Errors
None.