XBlink Extension Function

X11R6 Technical Reference

XBlink Extension Function

Purpose

Causes the ColormapID parameter to be installed and the screen to blink with the specified information.

Library

Enhanced X-Windows Library (libXext.a)

C Syntax

void XBlink(DisplayPtr,  ColormapID, Rate,  XColorPtr)
Display *DisplayPtr; 
Colormap ColormapID; 
Time Rate; 
XColor *XColorPtr;

Description

The XBlink extension function causes the ColormapID to be installed and the screen to blink with the information specified in the XColorPtr parameter. If the color map is not already installed, the extension remembers the color and blinks whenever the color map is installed with a call to the XInstallColormap function or through the setting of the ColormapID attribute with the XSetWindowAttributes data structure. The blinking is accomplished by swapping the red, green, and blue (RGB) value in the color map at the index specified by the pixel field in the XColor data structure with the RGB value specified in the XColor data structure.

typedef struct {
    unsigned long pixel;    
         /* Index 
into the colormap /*
    unsigned short red, green, blue;
    char flags;      
             
   /* Not used in this call 
  /*    char pad;    
             
       /* Not used in 
this call   
/*
}XColor;

The color map entry continues to blink at the rate specified by the Rate parameter until the XBlink extension function is called with a rate of 0 (zero). If the XBlink extension function is called multiple times with the same color map and the same rate, all the colors blink synchronously.

Parameters

ColormapID	Specifies the color map resource ID of the color map used for the blinking.
DisplayPtr	Specifies the connection to the X server.
Rate	Specifies number of milliseconds to wait between blinks.
XColorPtr	Specifies the pointer to color information needed to blink.

Error Codes

BadAlloc

BadColor

BadValue

Related Information

Using Extensions in AIXwindows in AIX Version 4.3 AIXwindows Programming Guide.

The XColor data structure, XSetWindowAttributes data structure.

The XInstallColormap function.

AIXwindows Overview for Programmers in AIX Version 4.3 AIXwindows Programming Guide.