Object ProLayerstate

Function ProLayerstateCreate


Description
Create Layer state from references. Note: ProLayerItem of type PRO_LAYER_LAYER cannot be added to Layer States using ProLayerstateCreate.
Replacement in Object TOOLKIT: wfcWSolid::CreateLayerState
Synopsis
#include <ProLayerstate.h>
ProErrorProLayerstateCreate(
ProSolid p_solid
/* (In)
Solid.
*/
ProName state_name
/* (In)
New layer state name. The name may consist of alphanumeric, underscore and hyphen characters only.
*/
ProLayer* layers
/* (In)
ProArray of layers referenced by the new state.
*/
ProLayerDisplay* disp_arr
/* (In)
ProArray of layer display statuses. Must be equal in size to the layers array.
*/
ProLayerItem* hidden_items
/* (In)
ProArray of hidden items.
*/
ProAnnotation* annotations
/* (In)
ProArray of annotations on a layer.
*/
int* status_flags
/* (In)
ProArray of integers. Statuses of the annotations in the layer state. The statuses are true/false values. true = excluded from layer. Array size must be equal to annotations' size.
*/
ProLayerstate* p_state
/* (Out)
Returned newly created layer state.
*/
)
Returns
PRO_TK_NO_ERRORLayer state created successfully.
PRO_TK_BAD_INPUTSIncorrect Input parameters.
PRO_TK_INVALID_ITEMSize of arrays don't match. See description above.
PRO_TK_GENERAL_ERRORLayer state creation aborted.
PRO_TK_INVALID_NAMELayer state name is invalid. The name may be too long or contains invalid characters.
PRO_TK_E_FOUNDProvided layer state name already exists in the model.

Manual References:

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