XGetGCValues

Syntax

Status XGetGCValues(display, gc, valuemask, values_return)
      Display *display;
      GC gc;
      unsigned long valuemask;
      XGCValues *values_return;

Arguments

display	Specifies the connection to the X server.
gc	Specifies the GC.
valuemask	Specifies which components in the GC are to be returned in the values_return argument. This argument is the bitwise inclusive OR of zero or more of the valid GC component mask bits.
values_return	Returns the GC values in the specified XGCValues structure.

Description

The XGetGCValues() function returns the components specified by valuemask for the specified GC. If the valuemask contains a valid set of GC mask bits (GCFunction, GCPlaneMask, GCForeground, GCBackground, GCLineWidth, GCLineStyle, GCCapStyle, GCJoinStyle, GCFillStyle, GCFillRule, GCTile, GCStipple, GCTileStipXOrigin, GCTileStipYOrigin, GCFont, GCSubwindowMode, GCGraphicsExposures, GCClipXOrigin, GCCLipYOrigin, GCDashOffset, or GCArcMode) and no error occurs, XGetGCValues() sets the requested components in values_return and returns a nonzero status. Otherwise, it returns a zero status. Note that the clip-mask and dash-list (represented by the GCClipMask and GCDashList bits, respectively, in the valuemask) cannot be requested. Also note that an invalid resource ID (with one or more of the three most-significant bits set to 1) will be returned for GCFont, GCTile, and GCStipple if the component has never been explicitly set by the client.

See also

AllPlanes(), XChangeGC(), XCopyArea(), XCopyGC(), XCreateGC(), XCreateRegion(), XDrawArc(), XDrawLine(), XDrawRectangle(), XDrawText(), XFillRectangle(), XFreeGC(), XGContextFromGC(), XQueryBestSize(), XSetArcMode(), XSetClipOrigin(), "Manipulating Graphics Context/State".

---

Christophe Tronche, [email protected]