1. NAME

XDrawString, XDrawString16 - draw text characters

2. SYNTAX

int XDrawString(Display *display, Drawable d, GC gc, int x, int y, char *string, int length); int XDrawString16(Display *display, Drawable d, GC gc, int x, int y, XChar2b *string, int length);

3. ARGUMENTS

d 1i Specifies the drawable.

display 1i Specifies the connection to the X server.

gc 1i Specifies the GC.

length 1i Specifies the number of characters in the string argument.

string 1i Specifies the character string.

x 1i

y 1i Specify the x and y coordinates\*(Xy.

4. DESCRIPTION

Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. For fonts defined with 2-byte matrix indexing and used with .ZN XDrawString16 , each byte is used as a byte2 with a byte1 of zero.

Both functions use these GC components: function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin.

.ZN XDrawString and .ZN XDrawString16 can generate .ZN BadDrawable , .ZN BadGC , and .ZN BadMatch errors.

5. DIAGNOSTICS

  • .ZN BadDrawable
     A value for a Drawable argument does not name a defined Window or Pixmap.
  • .ZN BadGC
     A value for a GContext argument does not name a defined GContext.
  • .ZN BadMatch
     An .ZN InputOnly window is used as a Drawable.
  • .ZN BadMatch
     Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.

6. SEE ALSO