NAME

xil_cis_get_by_name, xil_cis_get_name, xil_cis_set_name − get and set a compressed image sequence (CIS) object name

SYNOPSIS

#include <xil/xil.h>

XilCis xil_cis_get_by_name (XilSystemState State,

char ∗name);

char∗ xil_cis_get_name (XilCis cis);

void xil_cis_set_name (XilCis cis,

char ∗name);

DESCRIPTION

Use these functions to assign names to CIS objects, and to retrieve CIS objects by name. 

xil_cis_get_by_name () returns the handle to the CIS object with the specified name name.  If such an object  does not exist, NULL is returned.  xil_cis_get_by_name () does not make a copy of the CIS object.

xil_cis_get_name () returns a copy of the specified CIS object’s name.  A call to free (3) should be used to free the space allocated by xil_cis_get_name (). If the specified CIS object has no name, NULL is returned.

xil_cis_set_name () sets the name of the specified CIS object to the one provided.

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide. 

EXAMPLES

Allow a user to add images to a named CIS:

void add_image_to_cis(XilSystemState State, char∗ name, XilImage image);
{
   XilCis cis;
   cis = xil_cis_get_by_name (State, name);
   if (cis == NULL) {
      cis = xil_cis_create (State, "faxG3");
      xil_cis_set_name (cis, name);
   }
   xil_compress (image, cis);
   return;
}

NOTES

If you give two CIS objects the same name, it is not defined which CIS object will be retrieved by a call to xil_cis_get_by_name ().
 

SunOS   —  Last change: 10 June 1993