Digital

NAME

XieQueryRoi − This routine obtains an ROI context from the server. 

C Format

XieQueryRoi(roi_id, x_ret, y_ret, width_ret, height_ret)

C Argument Information

XieRoi      roi_id;
long      ∗x_ret;
long      ∗y_ret;
unsigned long  ∗width_ret;
unsigned long  ∗height_ret;

RETURN VALUES

None. 

PARAMETERS

roi_idThe roi_id argument specifies the identifier of the ROI you want to query. 

x_retThe x_ret argument specifies the pointer to the location to which the routine returns the ROI x-coordinate information. 

y_retThe y_ret argument specifies the pointer to the location to which the routine returns the ROI y-coordinate information. 

width_retThe width_ret argument specifies the pointer to the location to which the routine returns the ROI width information. 

height_retThe height_ret argument specifies the pointer to the location to which the routine returns the ROI height information. 

DESCRIPTION

This routine obtains an ROI context from the server.  If you do not want to retrieve the information for a particular argument, set the pointer to null. 

XIE Events and Error Messages

Protocol Messages: X_ieQueryResource

XIE event returned: None

XieLib errors: Reply error, BadLength

XieServer errors: BadIDChoice -- Invalid identifier