Previous | Contents | Index |
status_return = X$READ_BITMAP_FILEArgument Information(display, drawable_id, filename, [width_return], [height_return], [bitmap_id_return], [x_hot_coord_return], [y_hot_coord_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
display | identifier | uns longword | read | reference |
drawable_id | identifier | uns longword | read | reference |
filename | char_string | character string | read | descriptor |
width_return | longword | uns longword | write | reference |
height_return | longword | uns longword | write | reference |
bitmap_id_return | identifier | uns longword | write | reference |
x_hot_coord_return | longword | longword | write | reference |
y_hot_coord_return | longword | longword | write | reference |
status_return
READ BITMAP FILE returns one of the following values to indicate the status:X$C_BITMAP_SUCCESS
X$C_BITMAP_OPEN_FAILED
X$C_BITMAP_FILE_INVALID
X$C_BITMAP_NO_MEMORY
filename
The file specification of the bitmap file. The format of the file is dependent on the operating system on the client side of the client-server connection. File names are parsed using RMS$PARSE and logical names, search strings, and so on, are supported. The maximum length of a file specification is 255 bytes. Wildcards are not supported. The default file name is []bitmap.dat. The filename argument is the address of a character string descriptor that points to the string.width_return
The width of the read-in bitmap file. The width_return argument is optional.height_return
The height of the read-in bitmap file. The height_return argument is optional.bitmap_id_return
The bitmap identifier. The bitmap_id_return argument is optional.x_hot_coord_return
The x-coordinate of the hotspot, which is defined as the point in the cursor that corresponds to the x- and y-coordinates reported for the pointer, is returned. If x_hot_coord_return and y_hot_coord_return are not null, READ BITMAP FILE sets x_hot_coord_return and y_hot_coord_return to the value of the hotspot as defined in the file. If no hotspot is defined, READ BITMAP FILE sets x_hot_coord_return and y_hot_coord_return to (--1, --1). The x_hot_coord_return argument is optional.y_hot_coord_return
The y-coordinate of the hotspot, which is defined as the point in the cursor that corresponds to the x- and y-coordinates reported for the pointer, is returned. If x_hot_coord_return and y_hot_coord_return are not null, READ BITMAP FILE sets x_hot_coord_return and y_hot_coord_return to the value of the hotspot as defined in the file. If no hotspot is defined, READ BITMAP FILE sets x_hot_coord_return and y_hot_coord_return to (--1, --1). The y_hot_coord_return argument is optional.
X$REBIND_KEYSYMArgument Information(display, keysym_id, keysym_names, mod_count, lookup_string, num_bytes)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
keysym_id | identifier | uns longword | read | reference |
keysym_names | array | uns longword | read | reference |
mod_count | longword | longword | read | reference |
lookup_string | word | uns word | read | reference |
num_bytes | word | uns word | read | reference |
X$RECOLOR_CURSORArgument Information(display, cursor_id, foreground_color, background_color)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
cursor_id | identifier | uns longword | read | reference |
foreground_color | record | x$color | read | reference |
background_color | record | x$color | read | reference |
status_return = X$RECONFIGURE_WM_WINDOWArgument Information(display, window_id, screen_number, change_mask, values)
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 |
screen_number | uns longword | uns longword | read | reference |
change_mask | mask_longword | uns longword | read | reference |
values | record | x$window_changes | read | reference |
status_return
Specifies whether the routine completed successfully.
Value Description Non-zero Routine completed successfully. 0 Routine did not complete successfully.
answer_return = X$RECT_IN_REGIONArgument Information(region_id, x_coord, y_coord, width, height)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
answer_return | longword | longword | write | value |
region_id | identifier | uns longword | read | reference |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
width | longword | uns longword | read | reference |
height | longword | uns longword | read | reference |
answer_return
RECT IN REGION returns one of the following values:X$C_RECTANGLE_IN
X$C_RECTANGLE_OUT
X$C_RECTANGLE_PART
X$REFRESH_KEYBOARD_MAPPINGArgument Information(event_map)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
event_map | record | x$mapping_event | read | reference |
X$REMOVE_FROM_SAVE_SETArgument Information(display, window_id)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
window_id | identifier | uns longword | read | reference |
X$REMOVE_HOSTArgument Information(display, host)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
host | record | x$host_address | read | reference |
X$REMOVE_HOSTSArgument Information(display, hosts, num_hosts)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
hosts | array | uns longword | read | reference |
num_hosts | longword | longword | read | reference |
X$REPARENT_WINDOWArgument Information(display, window_id, parent_id, x_coord, y_coord)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
window_id | identifier | uns longword | read | reference |
parent_id | identifier | uns longword | read | reference |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
X$RESET_SCREEN_SAVERArgument Information(display)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
X$RESIZE_WINDOWArgument Information(display, window_id, width, height)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
window_id | identifier | uns longword | read | reference |
width | uns longword | uns longword | read | reference |
height | uns longword | uns longword | read | reference |
status_return = X$RESOURCE_MANAGER_STRINGArgument Information(display, rm_string_return, [length_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
display | identifier | uns longword | read | reference |
rm_string_return | char_string | character string | write | descriptor |
length_return | word | word | write | reference |
rm_string_return
A pointer to the resource manager string for the specified display.length_return
The length of the resource manager string. This argument is optional.
X$RESTACK_WINDOWSArgument Information(display, window_ids, num_windows)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
window_ids | record | uns longword | read | reference |
num_windows | longword | longword | read | reference |
X$RM_COMBINE_DATABASEArgument Information(src_database_id, dst_database_id, override )
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
src_database_id | identifier | uns longword | read | reference |
dst_database_id | identifier | uns longword | modify | reference |
override | Boolean | uns longword | read | reference |
X$RM_COMBINE_FILE_DATABASEArgument Information(file_name, dst_database_id, override)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
file_name | char_string | character string | read | descriptor |
dst_database_id | identifier | uns longword | modify | reference |
override | Boolean | uns longword | read | reference |
status_return = X$RM_DESTROY_DATABASEArgument Information(database_id)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | longword | uns longword | write | value |
database_id | identifier | uns longword | read | reference |
status_return
Specifies whether the routine completed successfully.
Value Description Non-zero Routine completed successfully. 0 Routine did not complete successfully.
Previous | Next | Contents | Index |