AaIntro(3X) — DeltaWindows 1.3.3 Release 4 Version 4.3

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

NAME

XFunctionName — brief description of the function, interface definition or structure.

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_in_out;

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:

arg1Specifies 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_return
Returns a pointer to data to be filled in by XFunctionName. The description of arguments that return data from the function normally begins with the word "Returns."

arg3_in_out
Specifies information for XFunctionName, and also returns data from the function. The description of arguments that both pass data to the function and return data from the function normally uses both the words "Specifies" and "Returns."

RETURNS

This section describes what the function returns (as the return value, not in its arguments).

AVAILABILITY

The Availability section describes which specification releases include this function. They say either that a given function is available in Release 5 and later releases, or Release 4 and later releases. If there is no Availability section, the function is available in Release 3 and later.

DESCRIPTION

The Description section describes what the function does, what it returns, and what events or side-effects it causes. It also contains miscellaneous information such as examples of usage, special error cases, and pointers to related information in both volumes of this manual.

STRUCTURES

The Structures section contains the C definitions of the X-specific data types used by FunctionName as arguments or return values. It also contains definitions of important constants used by the function. Additional structures not shown can be found in Appendix F, Structure Reference.

ERRORS

The general description of the error types is contained in Appendix B, Error Messages and Protocol Requests. Some functions generate errors due to function-specific interpretation of arguments. Where appropriate, these function-specific causes have been listed along with the error event types they generate.

Museum