Xlib Reference Manual for Version 11 of the X Window System

Xlib Function Reference

Introduction

—Xlib - Function Group

This page describes the format of each reference page in this volume.

Name

FunctionName — brief description of the function.

Synopsis

The Synopsis section presents the calling syntax for the routine, including the declarations of the arguments and return type. For example:

returntype XFunctionName (arg1, arg2, arg3);
      type1 arg1;
      type2 *arg2;    /* RETURN */
      type3 *arg3;    /* SEND and RETURN */

The return type Status is of type int; it returns either True or False to indicate whether the routine was successful.

Arguments

The Arguments section describes each of the arguments used by the function. There are three sorts of arguments: arguments that specify data to the function, arguments that return data from the function, and arguments that do both. An example of each type is shown below:

arg1	Specifies information for XFunctionName. The description of arguments that pass data to the function always begins with the word “Specifies,” as shown in this example.
arg2	Returns a pointer to data to be filled in by XFunctionName. The description of arguments that return data from the function always begins with the word “Returns.”
arg3	Specifies information for XFunctionName, and returns data from the function. The description of arguments that both pass data to the function and return data from the function uses both the words “Specifies” and “Returns.”

Description

The Description section describes what the function does, ...