Category 3D drawings and annotations, Object ProDtlsyminstdata

Function ProDtlsyminstdataScaledheightGet


Description
Get the symbol instance height in the units of the drawing ormodel, consistent with the values shown in the Properties dialogfor the symbol instance.

Note: The scaled height is partially determined based onthe properties of the symbol definition (seeProDtlsyminstdataDefSet(). Changing the symbol definition maychange the calculated value for the scaled height.

Replacement in Object TOOLKIT: pfcDetailSymbolDefInstructions::ScaledHeight
pfcDetailSymbolInstInstructions::ScaledHeight
Synopsis
#include <ProDtlsyminst.h>
ProErrorProDtlsyminstdataScaledheightGet(
ProDtlsyminstdata data
/* (In)
The symbol instance data.
*/
double* height
/* (Out)
The height in drawing or model coordinates.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the height.
PRO_TK_BAD_INPUTSOne or more arguments were invalid.
PRO_TK_E_NOT_FOUNDThe symbol definition assigned to this data was not yet initialized so the scaled value cannot be accurately retrieved.

Manual References:

  1. Drawings: Symbol Instance Data
  2. Drawings: Symbol Instance Data

Sample Code References:

  1. pt_examples ( TestDtlsyminst.c )
  2. pt_examples ( TestDtlsyminst.c )