Object ProCavlayrule

Function ProCavlayruleRectDataGet


Description
Get the information about a rectangular rule from the Cavity Layout Rule structure.
Synopsis
#include <ProCavlayrule.h>
ProErrorProCavlayruleRectDataGet(
ProCvLayoutRule cvlrule
/* (In)
Cavity layout rule handle. It should be of rectangular or Variable built over rectangular type. A good programming style is to call first function ProCavlayruleRuleTypeGet() and make sure that one of the types it returns is Rectangular.
*/
ProCvLayoutOrient* orient
/* (Out)
pointer to layout orientation type;
*/
int* cavity_num_x
/* (Out)
pointer to number of columns in the layout;
*/
int* cavity_num_y
/* (Out)
pointer to number of rows in the layout;
*/
double* cavity_step_x
/* (Out)
pointer to displacement step in x direction;
*/
double* cavity_step_y
/* (Out)
pointer to displacement step in y direction.
*/
)
Returns
PRO_TK_NO_ERRORThe information is successfully retrieved;
PRO_TK_BAD_INPUTSThe Rule is of uncompatible type.
PRO_TK_GENERAL_ERRORCannot inialize the pointers.

Sample Code References:

  1. pt_examples ( TestCavityLayout.c )