Category Feature element trees, Object ProElement

Function ProElementWstringGet


Description
Returns a string value representation for the element.

Note: When called on an element driven by relations, the function will return the first appropriate relations string involving this element value. The relation string should be used only to identify that the element is driven by relations, and should not be used to calculate the element value. This is because the element value may be driven by more than one relation simultaneously in the feature's relation set. Refer to ProRelSet.h for more details about relations and relation sets.

Synopsis
#include <ProElement.h>
ProErrorProElementWstringGet(
ProElement element
/* (In)
The element.
*/
ProElementWstringOptions options
/* (In)
Options for how the string should be obtained. Can be NULL.
*/
wchar_t** value
/* (Out)
The wide-string value. Free this string using ProWstringFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more arguments is invalid.
PRO_TK_INVALID_TYPEThe element does not contain a value that can be represented as a this type.
See Also
ProElementwstroptsAlloc
ProAnalysis.h
ProAsmcomp.h
ProBeltFeat.h
ProChamfer.h
ProContact3dFeat.h
ProDamperFeat.h
ProDesignatedArea.h
ProDraft.h
ProDtmAxis.h
ProDtmCrv.h
ProDtmCsys.h
ProDtmPln.h
ProDtmPnt.h
ProElemId.h
ProExtrude.h
ProFeatIntr.h
ProFixture.h
ProFlatSrf.h
ProForeignCurve.h
ProHole.h
ProMfgoper.h
ProMerge.h
ProMirror.h
ProMove.h
ProNcseq.h
ProNcseqElem.h
ProPattern.h
ProProcstep.h
ProReplace.h
ProRevolve.h
ProRib.h
ProRound.h
ProShell.h
ProSmtFlangeWall.h
ProSmtFlatWall.h
ProSmtForm.h
ProSolidify.h
ProSmtPunchQuilt.h
ProStdSection.h
ProSurfReg.h
ProSweep.h
ProThicken.h
ProTrim.h
ProToolElem.h
ProValue.h
ProWcell.h

Manual References:

  1. Element Trees: Principles of Feature Creation: Access to ProElement Data
  2. Element Trees: Principles of Feature Creation: Access to ProElement Data

Sample Code References:

  1. pt_examples ( TestProcstep.c )
  2. pt_examples ( UtilFeats.c )
  3. pt_examples ( UtilSect.c )
  4. pt_examples ( TestCollect.c )
  5. pt_examples ( UtilTree.c )
  6. pt_examples ( UtilTree.c )
  7. pt_userguide ( UgMfgWcellCreate.c )