Digital

NAME

XieQueryMap − This routine returns the attributes of a server image. 

C Format

XieQueryMap (pho_id, width_ret, height_ret, cmp_map_ret, cmp_cnt_ret, cmp_lvl_ret, pxl_pol_ret, pxl_ratio_ret, pxl_prog_ret, scn_prog_ret, constrained_ret)

C Argument Information

XiePhoto     pho_id;
unsigned long  ∗width_ret;
unsigned long  ∗height_ret;
unsigned char  ∗cmp_map_ret;
unsigned char  ∗cmp_cnt_ret;
unsigned char  ∗cmp_lvl_ret;
unsigned char  ∗pxl_pol_ret;
double     ∗pxl_ratio_ret;
unsigned char  ∗pxl_prog_ret;
unsigned char  ∗scn_prog_ret;
unsigned char  ∗constrained_ret;

RETURN VALUES

None. 

PARAMETERS

pho_idThe pho_id argument specifies the identifier of the image you want to query. The image can be an unbound photomap, a photomap bound to a photoflo, a phototap, or a photoflo. The photoflo is specified explicitly if the image is a photoflo, or implicitly if the image is a photomap bound to the photoflo or a phototap. If the image is a photoflo, the routine queries the photomap or phototap currently at the end of the photoflo. 

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

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

cmp_map_retThe cmp_map_ret argument specifies the pointer to the location to which the routine returns the component mapping attribute. 

cmp_cnt_retThe cmp_cnt_ret argument specifies the pointer to the location to which the routine returns the component count attribute. 

cmp_lvl_retThe cmp_lvl_ret argument specifies the pointer to the array to which the routine returns the bits per component attribute. The array length must be at least equal to XieK_MaxComponents. 

pxl_pol_retThe pxl_pol_ret argument specifies the pointer to the location to which the routine returns the pixel polarity attribute. 

pxl_ratio_retThe pxl_ratio_ret argument specifies the pointer to the location to which the routine returns the pixel aspect ratio attribute. 

pxl_prog_retThe pxl_prog_ret argument specifies the pointer to the location to which the routine returns the pixel progression attribute. 

scn_prog_retThe scn_prog_ret argument specifies the pointer to the location to which the routine returns the scanline progression attribute. 

constrained_retThe constrained_ret argument specifies the pointer to the location where the routine returns the Boolean flag indicating whether or not the image data is constrained. 

DESCRIPTION

This routine returns the attributes of a server image. If you do not want to retrieve a particular attribute, set the associated pointer to null. 

XIE Events and Error Messages

Protocol Messages: X_ieQueryResource

XIE event returned: None

XieLib errors: Reply error, BadLength

Returns null if invalid photomap

XieServer errors: BadIDChoice -- Invalid identifier