DECwindows Motif for OpenVMS Guide to Non-C Bindings

GET TEXT PROPERTY

OpenVMS Format

status_return = X$GET_TEXT_PROPERTY
(display, window_id, text_prop_return, property_id)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	longword	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifer	uns longword	read	reference
text_prop_return	record	x$text_property	write	reference
property_id	identifier	uns longword	read	reference

Returns

status_return
Specifies whether the routine completed successfully.

Value Description

Non-zero Routine completed successfully.

0 Routine did not complete successfully.

Value	Description
Non-zero	Routine completed successfully.
0	Routine did not complete successfully.

GET TRANSIENT FOR HINT

OpenVMS Format

status_return = X$GET_TRANSIENT_FOR_HINT
(display, window_id, prop_window_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
prop_window_return	identifier	uns longword	read	reference

GET VISUAL INFO

OpenVMS Format

status_return = X$GET_VISUAL_INFO
(display, vinfo_mask, vinfo_template, num_items_return, [items_return] [items_size], [items_buff_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
vinfo_mask	mask_longword	uns longword	read	reference
vinfo_template	record	x$visual_info	read	reference
num_items_return	longword	longword	write	reference
items_return	address	uns longword	write	reference
items_size	longword	longword	read	reference
items_buff_return	record	uns longword	read	reference

Returns

status_return
Specifies whether the routine completed successfully. GET VISUAL INFO returns one of the following values:

Value Description

SS$_NORMAL Routine completed successfully.

X$_TRUNCATED Buffer not large enough; results truncated.

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_TRUNCATED	Buffer not large enough; results truncated.

Returns

items_return
The virtual address of a pointer to an array of visual information data returned by the routine and residing in space reserved by Xlib.
items_size
The size of the buffer specified in items_buff_return.
items_buff_return
A pointer to a data buffer, residing in space you have reserved, where each entry is one visual information element. The size of the buffer is specified by items_size.

GET WINDOW ATTRIBUTES

OpenVMS Format

status_return = X$GET_WINDOW_ATTRIBUTES
(display, window_id, window_attributes_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
window_attributes_return	array	x$window_attributes	write	reference

Returns

status_return
Specifies whether the routine completed successfully.
This argument returns one of the following values:

Value Description

X$_ERRORREPLY Error received from server; window no longer exists.

SS$_NORMAL Routine completed successfully.

Otherwise Failure for reason given.

Value	Description
X$_ERRORREPLY	Error received from server; window no longer exists.
SS$_NORMAL	Routine completed successfully.
Otherwise	Failure for reason given.

GET WINDOW PROPERTY

OpenVMS Format

status_return = X$GET_WINDOW_PROPERTY
(display, window_id, property_id, long_offset, long_len, delete, requested_type, actual_type_return, actual_format_return, num_elements_return, bytes_after_return, [property_data_return], [property_data_len], [property_data_buff_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
property_id	identifier	uns longword	read	reference
long_offset	longword	longword	read	reference
long_len	longword	longword	read	reference
delete	longword	uns longword	read	reference
requested_type	identifier	uns longword	read	reference
actual_type_return	identifier	uns longword	write	reference
actual_format_return	longword	longword	write	reference
num_elements_return	longword	longword	write	reference
bytes_after_return	longword	longword	write	reference
property_data_return	address	uns longword	write	reference
property_data_len	longword	longword	read	reference
property_data_buff_return	array	uns longword	write	reference

Returns

status_return
Specifies whether the routine completed successfully. This argument returns a zero if the routine completes successfully, and one of the following values if it does not complete successfully:

Value Description

X$_ERRORREPLY Error received from server.

X$_TRUNCATED Results truncated; user-supplied buffer not large enough.

Value	Description
X$_ERRORREPLY	Error received from server.
X$_TRUNCATED	Results truncated; user-supplied buffer not large enough.

Arguments

property_data_return
Virtual address of a pointer to an array of property data returned by the routine and residing in space reserved by Xlib.
property_data_len
The size of the data buffer specified in property_data_buff_return. This argument is optional.
property_data_buff_return
A pointer to a data buffer residing in space you reserved, where each entry is one property element. The length of the buffer is specified by property_data_len. The property data is returned by the routine. This argument is optional.

GET WM CLIENT MACHINE

OpenVMS Format

status_return = X$GET_WM_CLIENT_MACHINE
(display, window_id, property_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	longword	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifer	uns longword	read	reference
property_return	record	x$text_property	write	reference

Returns

status_return
Specifies whether the routine completed successfully.

Value Description

Non-zero Routine completed successfully.

0 Routine did not complete successfully.

Value	Description
Non-zero	Routine completed successfully.
0	Routine did not complete successfully.

GET WM COLORMAP WINDOWS

OpenVMS Format

status_return = X$GET_WM_COLORMAP_WINDOWS
(display, window_id, [colormap_windows_return], [count_return], [colormap_size], [colormap_buff_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
colormap_windows_return	address	array	write	reference
count_return	longword	uns longword	write	reference
colormap_size	longword	uns longword	read	reference
colormap_buff_return	array	uns longword	write	reference

Arguments

colormap_windows_return
List of identifiers stored in the WM_COLORMAP_WINDOWS property of the specified window. The list is returned by the routine and resides in space reserved by Xlib. This argument is optional.
count_return
Number of windows in the list. This argument is optional.
colormap_size
Size of the colormap_buff_return argument in bytes. This argument is optional.
colormap_buff_return
Pointer to a data buffer residing in space you have reserved, where each entry is a window ID. This argument is optional.

GET WM HINTS

OpenVMS Format

X$GET_WM_HINTS
(display, window_id, wmhints_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
wmhints_return	cond_value	x$wm_hints	write	reference

Arguments

wmhints_return
The window manager hints data structure returned by the routine.

GET WM ICON NAME

OpenVMS Format

status_return = X$GET_WM_ICON_NAME
(display, window_id, property_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	longword	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
property_return	record	x$text_property	write	reference

Returns

status_return
Specifies whether the routine completed successfully.

Value Description

Non-zero Routine completed successfully.

0 Routine did not complete successfully.

Value	Description
Non-zero	Routine completed successfully.
0	Routine did not complete successfully.

GET WM NAME

OpenVMS Format

status_return = X$GET_WM_NAME
(display, window_id, property_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	longword	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
property_return	record	x$text_property	write	reference

Returns

status_return
Specifies whether the routine completed successfully.

Value Description

Non-zero Routine completed successfully.

0 Routine did not complete successfully.

Value	Description
Non-zero	Routine completed successfully.
0	Routine did not complete successfully.

GET WM NORMAL HINTS

OpenVMS Format

status_return = X$GET_WM_NORMAL_HINTS
(display, window_id, hints_return, supplied_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	longword	uns longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
hints_return	record	x$size_hints	write	reference
supplied_return	mask_longword	uns longword	write	reference

Returns

status_return
Specifies whether the routine completed successfully.

Value Description

Non-zero Routine completed successfully.

0 Routine did not complete successfully.

Value	Description
Non-zero	Routine completed successfully.
0	Routine did not complete successfully.

Contents

Index