HP OpenVMS Systems Documentation

OpenVMS Format

status_return = X$GET_FONT_PATH

(display, num_paths_return, directories_return, [len_return])

Returns

status_return

Specifies whether the routine completed successfully. GET FONT PATH returns one of the following values:

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_NOTFOUND	Directory list not found.
X$_ERRORREPLY	Error received from server.

Arguments

directories_return

Comma separated list of directories that comprise the current font directory path.

len_return

The length of the returned string. This argument is optional.

OpenVMS Format

status_return = X$GET_FONT_PROPERTY

(font_struc, atom_id, value_return)

Returns

status_return

Specifies whether the return completed successfully. The routine returns zero for success and a non-zero value for failure.

OpenVMS Format

status_return = X$GET_GC_VALUES

(display, gc_id, valuemask, values_return)

Returns

status_return

Specifies whether the return completed successfully. The routine returns zero for success and a non-zero value for failure.

OpenVMS Format

status_return = X$GET_GEOMETRY

(display, drawable_id, [window_id_return], [x_coord_return], [y_coord_return], [width_return], [height_return], [border_width_return], [depth_return])

Returns

status_return

Specifies whether the routine completed successfully. GET GEOMETRY returns one of the following values:

Value	Description
X$_ERRORREPLY	Error received from server.
SS$_NORMAL	Routine completed successfully.

Arguments

window_id_return

The identifier of the root window of the specified drawable. This argument is optional.

x_coord_return

If the drawable is a window, x_coord_return specifies the x-coordinate of the window. The x- and y-coordinates define the upper left corner of the window, relative to the origin of the parent window. If the drawable is a pixmap, x_coord_return and y_coord_return equal zero. This argument is optional.

y_coord_return

If the drawable is a window, y_coord_return specifies the y-coordinate of the window. The x- and y-coordinates define the upper left corner of the window, relative to the origin of the parent window. If the drawable is a pixmap, x_coord_return and y_coord_return equal zero. This argument is optional.

width_return

The width, in pixels, of the drawable. GET GEOMETRY returns the width of the drawable to this argument. The width and height represent the inside area of the drawable, not including the border of the drawable. This argument is optional.

height_return

The height, in pixels, of the drawable. GET GEOMETRY returns the height of the drawable to this argument. The width and height represent the inside area of the drawable, not including the border of the drawable. This argument is optional.

border_width_return

The width, in pixels, of the new subwindow's border. If the drawable is a window, GET GEOMETRY returns the width of the window's border to this argument. If the drawable is a pixmap, GET GEOMETRY returns zero to this argument. This argument is optional.

depth_return

The depth of the pixmap. The depth must be supported by the root window of the specified drawable. GET GEOMETRY returns the depth, in bits per pixel, to this argument. This argument is optional.

OpenVMS Format

status_return = X$GET_ICON_NAME

(display, window_id, icon_name_return, [icon_len_return])

Returns

status_return

Specifies whether the routine completed successfully. GET ICON NAME returns one of the following values:

Value	Description
X$_ERRORREPLY	Error received from server.
X$_TRUNCATED	Results truncated; user-supplied buffer not large enough.
LIB$_STRTRU	Font names returned but truncated.
LIB$_FATALERR	LIB$SCOPY_R_DX fatal error.
LIB$_INSVIRMEM	Insufficient virtual memory; LIB$GET_VM call failed.
LIB$_INVSTRDES	Invalid string descriptor.
SS$_NORMAL	Routine completed successfully.
0	Indicates an error.

icon_len_return

Length of the icon name. This argument is optional.

OpenVMS Format

status_return = X$GET_ICON_SIZES

(display, window_id, [size_list_return], [count_return], [list_size], [list_buff_return])

Arguments

size_list_return

The virtual address of a pointer to an array of icon size data, returned by the routine and residing in space reserved by Xlib. The recommended icon size is defined by minimum, maximum, and incremental width and height specifications. If the incremental width and height specifications are zero, then a single size is recommended. If the incremental specifications are nonzero, then the minimum size plus an increment up to the maximum size is permitted. This argument is optional.

count_return

The number of items in size_list_return. This argument is optional.

list_size

The size of the buffer in list_buff_return. This argument is optional.

list_buff_return

A pointer to a data buffer residing in space you have reserved, where each entry is one icon size data element. The size of the buffer is specified by list_size. The icon size data is returned by the routine. This argument is optional.

OpenVMS Format

status_return = X$GET_IMAGE

(display, drawable_id, x_coord, y_coord, width, height, plane_mask, image_format, ximage_return)

Returns

status_return

Specifies whether the routine completed successfully. GET IMAGE returns one of the following values:

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_ERRORREPLY	Error received from server.

Arguments

image_format

The format of the image. The predefined values for image_format are as follows:

X$C_XY_BITMAP
X$C_XY_PIXMAP
X$C_Z_PIXMAP

Other values specified in this argument are not valid.

ximage_return

The returned image data structure containing the requested data.

OpenVMS Format

X$GET_INPUT_FOCUS

(display, [focus_id_return], [revert_to_return])

Arguments

focus_id_return

The identifier of the focus window, Pointer Root, or None. The identifier of the window was originally returned by CREATE SIMPLE WINDOW or CREATE WINDOW. This argument is optional.

revert_to_return

The current input focus state. One of the following predefined values can be returned:

X$C_REVERT_TO_PARENT
X$C_REVERT_TO_POINTER_ROOT
X$C_REVERT_TO_NONE

This argument is optional.

OpenVMS Format

X$GET_KEYBOARD_CONTROL

(display, state_values_return)

OpenVMS Format

status_return = X$GET_KEYBOARD_MAPPING

(display, first_keycode_wanted, keycode_count, [keysyms_per_keycode_return], [keysyms_return], [buff_size], [key_buff_return])

Returns

status_return

Specifies whether the routine completed successfully.

Arguments

keysyms_return

The virtual address of the symbol list returned by the routine and residing in space reserved by Xlib. If you specify this optional argument, GET KEYBOARD MAPPING determines the size of the buffer to create for the symbol list. If you specify keysyms_return, you do not need to specify buff_size and key_buff_return.

buff_size

The size of the key_buff_return buffer. This argument is optional.

key_buff_return

A pointer to an array residing in space you have reserved, in which each element is a key symbol. GET KEYBOARD MAPPING returns the key symbols to this array. This argument is optional.