Object ProCombstate

Function ProCombstateDataGet


Description
Getting combined state info.
Replacement in Object TOOLKIT: wfcCombState::GetCombStateData
Synopsis
#include <ProCombstate.h>
ProErrorProCombstateDataGet(
ProCombstate* cs_item
/* (In)
Combined state item.
*/
ProName cs_name
/* (Out)
Combined state name.
*/
ProModelitem** cs_ref_arr
/* (Out)
ProArray of reference states. Notes:

1. This array may contain items of these types:

2. A combined state may include the default view and/or the default simplified representation, which have their id equal to (-1).

3. 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. To free the array call ProArrayFree()<b/>.

*/
ProCrossecClipOpt* p_clip_opt
/* (Out)
pointer to cross section clip option value. The returned value is valid only in case when PRO_XSEC reference exists inside cs_ref_arr, meaning that combined state has valid cross section reference.
*/
ProBool* p_is_expld
/* (Out)
pointer to value. Is state exploded. Not used in part mode, since explode state does not exist in part mode.
*/
)
Returns
PRO_TK_NO_ERRORFunction successfully returned. The values of p_clip_opt, and p_is_expld are not assigned in case that cs_ref_arr is NULL.
PRO_TK_E_NOT_FOUNDNo such combined state in the specified model.
PRO_TK_BAD_INPUTSModel pointer is NULL.

Manual References:

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