Category Creo Parametric fundamentals, Object ProMdl

Function ProMdlCombStateCreate


Description
Create combined state from references.
Replacement in Object TOOLKIT: wfcWSolid::CreateCombState
Synopsis
#include <ProCombstate.h>
ProErrorProMdlCombStateCreate(
ProSolid p_solid
/* (In)
Solid.
*/
ProName new_name
/* (In)
Name of the new state.
*/
ProModelitem* ref_arr
/* (In)
ProArray of references. Must be non empty array. See ProCombstateDataGet for possible types of items in this array. The PRO_XSEC item may represent either a valid ProXsec handle or a zone feature. Use ProModelitemIsZone to check it and, if it returns TRUE, change the item type to PRO_FEATURE and use ProFeatureZoneGet instead. Omit a reference for 'NO STATE', where comb state activation will not affect this aspect, and use id PRO_COMBSTATE_REF_MRU for Most Recently Used.
*/
ProCrossecClipOpt clip_opt
/* (In)
Cross section clip option. Not used if PRO_XSEC reference is not passed.
*/
ProBool is_expld
/* (In)
Is state exploded or not. Not relevant in Part.
*/
ProCombstate* cs_item
/* (Out)
Created combined state item. Allowed to be NULL.
*/
)
Returns
PRO_TK_NO_ERRORCombined state created.
PRO_TK_BAD_INPUTSInvalid solid or name (including that combined state with such name exists. Reference array is NULL or it's size is zero.
PRO_TK_INVALID_TYPEInvalid references. Possible errors:
- The type of one of the references is not valid.
- Reference of some type appears twice or more.
- Id and type of a reference don't match.

Manual References:

  1. Core: Solids, Parts, and Materials: Combined States of a Solid
  2. Core: Solids, Parts, and Materials: Combined States of a Solid