In Library Functions

 

InEval

InGuiDspMsg

InGuiSend

VxInpIdx

VxInpItem

VxInpList

VxInpStr

VxLogStr


 InEval

int InEval(OmStr16 name,int idx_in,int *idx_out)
OmStr16 name i
name of evaluator function 
int idx_in i
index of input data-object (class=VDATA) 
int *idx_out o
index of output data-object (class=VDATA) 

Description

Call the specified evaluator (type InFn) with the specified data (idx_in).
Output the results via "idx_out".


The input VDATA object (idx_in) is deleted unless it is used as the output object (idx_out).  Use "InAttachOut()" to compose an output object from the input VDATA object.
Return 1 if the evaluation failed, 0 if successful.

Memory-Management

 

Caveats

 

 Top


 InGuiDspMsg

void InGuiDspMsg(char *s)
char *s i
null-terminated ascii string 

Description

   Display specified message in text output field at bottom of GUI.
   Return 1 if error, else 0.

Memory-Management

 

Caveats

 

 Top


 InGuiSend

void InGuiSend(char *s)
char *s i
null-terminated ascii string 

Description

   Send a string to the GUI event manager.

Memory-Management

 

Caveats

 

 Top


 VxInpIdx

int VxInpIdx(int,int)
int idx_data i
index of data object (class=VDATA) 
int data_id i
data id (as defined in template) 

Description

Return the index of the data item associated with the
Nth element (N = data_id) of the specified data object (VDATA).
Return -1 if the index is undefined.

Memory-Management

 

Caveats

 

 Top


 VxInpItem

int VxInpItem(int ,int ,int *)
int idx_data i
index of data object (class=VDATA) 
int data_id i
data id (as defined in template) 
int *index i
data item index 

Description

Get the index of the data item associated with the
Nth element (N = data_id) of the specified data object (VDATA).
It is assumed that "idx_data" resides in PRJ_BIN.


This function restores the active bin setting before returning. Return 0 if the data was successfully retrieved, else 1. Don't log error messages if the field was empty (but return 1).

Memory-Management

 

Caveats

 

 Top


 VxInpList

int VxInpList(int ,int ,int *,int **)
int idx_data i
index of data object (class=VDATA) 
int data_id i
data id (as defined in template) 
int *cnt o
no. of data items 
int **index o
list of data item indices 

Description

Get a list of data item indices stored
as the Nth element (N = data_id) of the specified data object (VDATA).
Memory for the list is allocated by this function.  It must be deallocated
by the calling procedure.


It is assumed that "idx_data" resides in PRJ_BIN. This function restores the active bin setting before returning. No error is logged if there are no indices associated with the specified data item.  In this case, "cnt" is output as zero.
Return 0 if the data was successfully retrieved, else 1. Don't log error messages if the field was empty (but return 1).

Memory-Management

 

Caveats

 

 Top


 VxInpStr

extern int VxInpStr(int ,int ,int ,char *)

 

 

void InWiStrDeAct(void

Description

De-activate the string input widget.

Memory-Management

 

Caveats

 

 Top


 VxLogStr

int VxLogStr(int, int, char *)
int idx_data i
index of data object (class=VDATA) 
int data_id i
data id (as defined in template) 
char *s i
null-terminated ascii string 

Description

Add the specified string (s) as the Nth element (N = data_id)
of the specified data object (VDATA).  If the Nth element is
already defined, replace it.  For now, it is assumed that the
Nth data item is never the head of a group (i.e. a list).


It is assumed that "idx_data" resides in PRJ_BIN. This function restores the active bin setting before returning. Return 1 if error, else 0.

Memory-Management

 

Caveats

 

 Top

 

Return to VX CAD/CAM Index