Category Sketches and sections, Object ProSection

Function ProSectionConstraintsGet


Description
Returns information about the specified section constraint.
Synopsis
#include <ProSection.h>
ProErrorProSectionConstraintsGet(
ProSection section
/* (In)
The section that belongs to a feature.
*/
int constraint_id
/* (In)
The constraint identifier for which the information is requested.
*/
ProConstraintType* type
/* (Out)
The constraint type.
*/
ProConstraintStatus* status
/* (Out)
The status of the constraint.
*/
int* num_refs
/* (Out)
The number of section entities referenced by the constraint.
*/
int** p_ent_ids
/* (Out)
A pointer to the array of size num_refs that contains the referenced entity identifiers. The function allocates the memory for this argument. Call ProArrayFree(ProArray*)p_ent_ids) to free the memory.
*/
ProSectionPointType** p_senses
/* (Out)
A pointer to the array of size num_refs that contains the codes for which part of the corresponding entity is affected by the constraint. The function allocates the memory for this argument. Call ProArrayFree(ProArray*)p_senses) to free the memory.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSThe input argument is invalid.
See Also
ProArrayFree

Manual References:

  1. Element Trees: Sections: Section Constraints
  2. Element Trees: Sections: Section Constraints

Sample Code References:

  1. pt_examples ( UtilSect.c )
  2. pt_examples ( UtilSect.c )