HP OpenVMS Systems Documentation

OpenVMS Format

X$FREE_GC

(display, gc_id)

OpenVMS Format

X$FREE_MODIFIERMAP

(modifier_keys)

OpenVMS Format

X$FREE_PIXMAP

(display, pixmap_id)

OpenVMS Format

X$FREE_STRING_LIST

(string_list)

OpenVMS Format

gc_resource_id_return = X$GCONTEXT_FROM_GC

(gc_id)

OpenVMS Format

mask_return = X$GEOMETRY

(display, screen_number, position, default_position, border_width, font_width, font_height, xadd, yadd, [x_coord_return], [y_coord_return], [width_return], [height_return])

Returns

mask_return

A bit mask that specifies which of four values (width, height, x offset, y offset) are actually found in the string, and whether the x and y values are negative. Each bit indicates whether the corresponding value was found in the parsed string. For each value found, the corresponding argument is updated; for each value not found, the argument is left unchanged.

Table 2-3 lists the predefined values and descriptions for mask_return.

Table 2-3 Parse Mask Bits

Bit	Predefined Value	Description
1	X$M_NO_VALUE	Reserved.
2	X$M_X_VALUE	The x-coordinate of the origin of a window.
3	X$M_Y_VALUE	The y-coordinate of the origin of a window.
4	X$M_WIDTH_VALUE	The width of the window in pixels.
5	X$M_HEIGHT_VALUE	The height of the window in pixels.
6	X$M_ALL_VALUES	Indicates if all values are present.
7	X$M_X_NEGATIVE_VALUE	Indicates if the x-coordinate is negative.
8	X$M_Y_NEGATIVE_VALUE	Indicates if the y-coordinate is negative.

Arguments

position

The position string that you want to parse. The position argument is the address of a character string descriptor that points to the string.

default_position

The default geometry specification string that you want to parse. The default_position argument is the address of a character string descriptor that points to the string.

x_coord_return

The x-coordinate to which GEOMETRY returns the x-offset from the specified string and is relative to the origin of the drawable. This argument is optional.

y_coord_return

The y-coordinate to which GEOMETRY returns the y-offset from the specified string and is relative to the origin of the drawable. This argument is optional.

width_return

Specifies the width value. This argument is optional.

height_return

Specifies the height value. This argument is optional.

OpenVMS Format

status_return = X$GET_ATOM_NAME

(display, atom_id, name_return, [name_len_return])

Returns

status_return

Specifies whether the routine completed successfully. The argument status_return can be set to any of the OpenVMS condition codes returned by LIB$SCOPY_R_DX.

The routine returns one of the following condition values:

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_ERRORREPLY	Error received from server.
X$_INSFMEM	Insufficient virtual memory.

Arguments

name_return

The name of the atom associated with the identifier specified in atom_id. The atom name is returned by the routine. The name_return argument is the address of a character string descriptor that points to the string.

name_len_return

The length of the atom name returned by the routine. This argument is optional.

OpenVMS Format

X$GET_CHAR_STRUCT

(font_info, char_code, char_struc)

OpenVMS Format

status_return = X$GET_CLASS_HINT

(display, window_id, class_hints_return)

Returns

status_return

Specifies whether the routine completed successfully for the specified window. This argument returns one of the following values:

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_PROPUNDEF	The property has not been defined.

OpenVMS Format

status_return = X$GET_COMMAND

(display, window_id, argv, argc, [name_len])

Returns

status_return

Specifies whether the routine completed successfully. The argument status_return can be set to any of the OpenVMS condition codes returned by LIB$SCOPY_R_DX. This argument returns one of the following values:

Value	Description
SS$_NORMAL	Routine completed successfully.
0	Property code does not exist.

Arguments

name_len

Length of the returned command string. This argument is optional.

OpenVMS Format

status_return = X$GET_DEFAULT

(display, program_name, option_name, default_name_return, [default_len_return])

Returns

status_return

Specifies whether the routine completed successfully.

Arguments

program_name

Name of the program that specifies the default property string for the user environment. The program_name argument is the address of a character string descriptor that points to the string.

option_name

Name of the property option for determining the user environment defaults. The option_name argument is the address of a character string descriptor that points to the string.

default_name_return

The address of a character string descriptor that points to the default property string.

default_len_return

The length of the default string minus any padding characters added to fill the string. This argument is optional.

OpenVMS Format

X$GET_ERROR_DATABASE_TEXT

(display, appl_name, message_name, default_message_name, buff_return, [len_return])

Arguments

message_name

The type of the error message. Xlib uses the following message types to report errors:

OpenVMS Binding	Description
X$C_PROTO_ERROR	The protocol error number used as a string for message_name.
X$C_XLIB_MESSAGE	The message strings used internally by Xlib.
X$C_REQUEST	The major protocol request number used for the message argument. If no string is found in the error database, the default string is returned to buff_return.

The message_name argument is the address of a character string descriptor that points to the string.

length

The size of the buffer that is passed in buff_return. This argument is optional.

OpenVMS Format

X$GET_ERROR_TEXT

(display, code, buff_return, [len_return])

Arguments

buff_return

A pointer to the buffer to which GET ERROR TEXT returns the description. The buff_return argument is the address of a character string descriptor that points to the string.

len_return

The size of the text string that GET ERROR TEXT returns. This argument is optional.