DECwindows Motif for OpenVMS Guide to Non-C Bindings
Previous Contents Index

Part 1
DECwindows Motif for OpenVMS Xlib

 Part I documents Xlib routines and data structures and includes the following chapters:

Chapter 2
Xlib Routines

This chapter lists Xlib routines. Some bindings are provided for the Release 5 Xlib routines. See Section 1.1 for information about the format used to describe each routine.

Refer to the corresponding C routines in the X Window System for additional information about the description of each function and a discussion of related background information.

ACTIVATE SCREEN SAVER

OpenVMS Format

X$ACTIVATE_SCREEN_SAVER

(display)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference

ADD HOST

OpenVMS Format

X$ADD_HOST

(display, host)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference
host record x$host_address read reference

ADD HOSTS

OpenVMS Format

X$ADD_HOSTS

(display, hosts, num_hosts)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference
hosts array uns longword read reference
num_hosts longword uns longword read reference

ADD PIXEL

OpenVMS Format

X$ADD_PIXEL

(ximage, value)

Argument Information
Argument Usage Data Type Access Mechanism
ximage record x$image read reference
value longword longword read reference

ADD TO SAVE SET

OpenVMS Format

X$ADD_TO_SAVE_SET

(display, window_id)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference
window_id identifier uns longword read reference

ALLOC CLASS HINT

OpenVMS Format

X$ALLOC_CLASS_HINT

(class_hints_return)

Argument Information
Argument Usage Data Type Access Mechanism
class_hints_return record x$class_hint write reference

ALLOC COLOR

OpenVMS Format

status_return = X$ALLOC_COLOR

(display, colormap_id, screen_in_out)

Argument Information
Argument Usage Data Type Access Mechanism
status_return cond_value uns longword write value
display identifier uns longword read reference
colormap_id identifier uns longword read reference
screen_in_out record x$color modify reference

Returns

status_return

ALLOC COLOR returns one of the following values:
Value Description
SS$_NORMAL Routine completed successfully.
X$_ERRORREPLY Error received from server.

ALLOC COLOR CELLS

OpenVMS Format

status_return = X$ALLOC_COLOR_CELLS

(display, colormap_id, contig, plane_masks_return, num_planes, pixels_return, num_colors)

Argument Information
Argument Usage Data Type Access Mechanism
status_return cond_value uns longword write value
display identifier uns longword read reference
colormap_id identifier uns longword read reference
contig Boolean uns longword read reference
plane_masks_return array uns longword write reference
num_planes longword uns longword read reference
pixels_return array uns longword write reference
num_colors longword uns longword read reference

Returns

status_return

Specifies whether the routine completed successfully. ALLOC COLOR CELLS returns one of the following values:
Value Description
SS$_NORMAL Routine completed successfully.
X$_ERRORREPLY Error received from server.

Note
The X Protocol defines that only the least significant 16 bits of the following longword arguments are transmitted to the server: num_planes, num_colors.

ALLOC COLOR PLANES

OpenVMS Format

status_return = X$ALLOC_COLOR_PLANES

(display, colormap_id, contig, pixels_return, num_colors, num_reds, num_greens, num_blues, rmask_return, gmask_return, bmask_return)

Argument Information
Argument Usage Data Type Access Mechanism
status_return cond_value uns longword write value
display identifier uns longword read reference
colormap_id identifier uns longword read reference
contig Boolean uns longword read reference
pixels_return array uns longword write reference
num_colors longword longword read reference
num_reds longword longword read reference
num_greens longword longword read reference
num_blues longword longword read reference
rmask_return mask_longword uns longword write reference
gmask_return mask_longword uns longword write reference
bmask_return mask_longword uns longword write reference

Returns

status_return

Specifies whether the routine completed successfully. ALLOC COLOR PLANES returns one of the following values:
Value Description
SS$_NORMAL Routine completed successfully.
X$_ERRORREPLY Error received from server.

ALLOC ICON SIZE

OpenVMS Format

X$ALLOC_ICON_SIZE

(icon_size_return)

Argument Information
Argument Usage Data Type Access Mechanism
icon_size_return record x$icon_size write reference

ALLOC NAMED COLOR

OpenVMS Format

status_return = X$ALLOC_NAMED_COLOR

(display, colormap_id, color_name, [screen_def_return], [exact_def_return])

Argument Information
Argument Usage Data Type Access Mechanism
status_return longword longword write value
display identifier uns longword read reference
colormap_id identifier uns longword read reference
color_name char_string character string read descriptor
color_screen_return record x$color write reference
color_exact_return record x$color write reference

Arguments

color_screen_return

The color data structure that returns the color definition of the color actually used by the server. The color definition and the color index are returned in the color data structure. This argument is optional.

color_exact_return

The color data structure that defines the exact color as specified in the color database. The color definition is returned in the color definition data structure. This argument is optional.

ALLOC SIZE HINTS

OpenVMS Format

X$ALLOC_SIZE_HINTS

(size_hints_return)

Argument Information
Argument Usage Data Type Access Mechanism
size_hints_return record x$size_hints write reference

ALLOC STANDARD COLORMAP

OpenVMS Format

X$ALLOC_STANDARD_COLORMAP

(standard_colormap_return)

Argument Information
Argument Usage Data Type Access Mechanism
standard_colormap_return record x$standard_colormap write reference

ALLOW EVENTS

OpenVMS Format

X$ALLOW_EVENTS

(display, event_mode, time)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference
event_mode longword longword read reference
time longword uns longword read reference

Arguments

event_mode

The events to be released. The predefined values for event_mode are as follows:
X$C_ASYNC_POINTER
X$C_SYNC_POINTER
X$C_REPLAY_POINTER
X$C_ASYNC_KEYBOARD
X$C_SYNC_KEYBOARD
X$C_REPLAY_KEYBOARD
X$C_SYNC_BOTH
X$C_ASYNC_BOTH

ALL PLANES

OpenVMS Format

value_return = X$ALL_PLANES

Argument Information
Argument Usage Data Type Access Mechanism
value_return uns longword uns longword write value

AUTO REPEAT OFF

OpenVMS Format

X$AUTO_REPEAT_OFF

(display)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference

AUTO REPEAT ON

OpenVMS Format

X$AUTO_REPEAT_ON

(display)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference

BELL

OpenVMS Format

X$BELL

(display, percent)

Argument Information
Argument Usage Data Type Access Mechanism
display identifier uns longword read reference
percent longword longword read reference

BITMAP BIT ORDER

OpenVMS Format

order_return = X$BITMAP_BIT_ORDER

(display)

Argument Information
Argument Usage Data Type Access Mechanism
order_return longword longword write value
display identifier uns longword read reference

Returns

order_return

The value of the leftmost bit in the bitmap, as displayed on the screen. Valid values are shown in the following table:
Value Description
X$C_LSB_FIRST Least significant bit displayed first.
X$C_MSB_FIRST Most significant bit displayed first.

Previous Next Contents Index