Category Geometry items, Object ProGeomitem

Function ProGeomitemIsGtolref


DEPRECATED: Wildfire 5.0
SUPERSEDED BY: ProGeomitemSetdatumGet
Description

Note: This function is deprecated. Use ProGeomitemSetdatumGet() instead.

Shows whether a datum plane or axis is a gtol reference.
Synopsis
#include <ProGtol.h>
ProErrorProGeomitemIsGtolref(
ProGeomitem* geomitem
/* (In)
The datum plane or axis
*/
ProBoolean* ref_datum
/* (Out)
TRUE is the datum is a gtol reference
*/
ProBoolean* is_in_dim
/* (Out)
TRUE if the datum is "In dim", FALSE if "Free"
*/
ProDimension* in_dim
/* (Out)
If is_in_dim==TRUE, the dimension
*/
)
Returns
PRO_TK_NO_ERRORThe function completed successfully.
PRO_TK_BAD_INPUTSThe input argument is invalid.
PRO_TK_GENERAL_ERRORAn error occurred and the function failed.

Manual References:

  1. Annotations: Annotation Features and Annotations: Accessing Set Datums for Datum Axes or Planes

Sample Code References:

  1. pt_userguide ( UgGtolCreate.c )