Previous | Contents | Index |
X$GET_MODIFIER_MAPPINGArgument Information(display, modifier_keys_return)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
modifier_keys_return | record | x$modifier_keymap | write | reference |
modifier_keys_return
The modifier key map data structure containing the values for the modifier keys. GET MODIFIER MAPPING returns the values in this argument.
status_return = X$GET_MOTION_EVENTSArgument Information(display, window_id, start, stop, num_events_return, [time_return], [time_size], [time_buff_return])
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 |
start | longword | uns longword | read | reference |
stop | longword | uns longword | read | reference |
num_events_return | longword | longword | write | reference |
time_return | address | uns longword | write | reference |
time_size | longword | longword | read | reference |
time_buff_return | array | uns longword | write | reference |
status_return
Specifies whether the routine completed successfully. GET MOTION EVENTS returns one of the following values:
Value Description X$_ERRORREPLY Error received from server. X$_TRUNCATED User buffer specified in time_buff_return not large enough. SS$_NORMAL Routine completed successfully.
time_return
The address of the time coordinate data structure returned by the routine and residing in space reserved by Xlib. You can specify either time_return to receive the address of the time coordinate data structure, or the time_size and time_buff_return arguments to receive an array of time coordinates in a buffer. This argument is optional.time_size
The length of the time coordinate buffer. This argument is optional.time_buff_return
A pointer to an array of time coordinates. The length of the array is specified by time_size and resides in space that you have reserved. This argument is optional.
status_return = X$GET_NORMAL_HINTSArgument Information(display, window_id, hints_return)
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 |
status_return
Specifies whether the return completed successfully. The routine returns a non-zero value for success and zero for failure.
pixel_value_return = X$GET_PIXELArgument Information(ximage, x_coord, y_coord)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
pixel_value_return | longword | uns longword | write | reference |
ximage | record | x$image | read | reference |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
X$GET_POINTER_CONTROLArgument Information(display, [accel_numerator_return], [accel_denominator_return], [threshold_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
accel_numerator_return | longword | longword | write | reference |
accel_denominator_return | longword | longword | write | reference |
threshold_return | longword | longword | write | reference |
accel_numerator_return
The acceleration numerator. The accel_numerator_return and accel_denominator_return arguments specify the complete acceleration multiplier. This argument is optional.accel_denominator_return
The acceleration denominator. The accel_numerator_return and accel_denominator_return arguments specify the complete acceleration multiplier. This argument is optional.threshold_return
The acceleration threshold, specified in the number of pixels moved during one movement. This argument is optional.
num_elements_return = X$GET_POINTER_MAPPING(display, map_return, num_map)
Argument Information
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
num_elements_return | longword | longword | write | value |
display | identifier | uns longword | read | reference |
map_return | array | byte | write | reference |
num_map | word | uns word | read | reference |
status_return = X$GET_RGB_COLORMAPSArgument Information(display, window_id, [standard_colormap_return], [count_return], property_id, [colormap_size], [colormap_buff_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
display | identifer | uns longword | read | reference |
window_id | identifier | uns longword | read | reference |
standard_colormap_return | address | array | write | reference |
count_return | uns longword | uns longword | write | reference |
property_id | identifier | uns longword | read | reference |
colormap_size | uns longword | uns longword | read | reference |
colormap_buff_return | array | uns longword | write | reference |
colormap_size
Size of the colormap_buff_return argument in bytes. This argument is optional.colormap_buff_return
Pointer to an array residing in space reserved you have reserved. Each entry is a window ID. This argument is optional.
X$GET_SCREEN_SAVERArgument Information(display, [timeout_return], [interval_return], [prefer_blanking_return], [allow_exposures_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
timeout_return | longword | longword | write | reference |
interval_return | longword | longword | write | reference |
prefer_blanking_return | longword | longword | write | reference |
allow_exposures_return | longword | longword | write | reference |
timeout_return
The time, in seconds, that the screen saver waits before turning on. The time represents the number of seconds when no input from the keyboard or pointing device is received. A value of zero means that the screen saver is disabled. This argument is optional.interval_return
The time, in seconds, from one screen saver invocation to the next. This argument is optional.prefer_blanking_return
The screen blanking mode. The predefined values for prefer_blanking_return are as follows:X$C_DONT_PREFER_BLANKING
X$C_PREFER_BLANKING
X$C_DEFAULT_BLANKINGThis argument is optional.
allow_exposures_return
The current screen saver control values are returned. The predefined values for allow_exposures_return are as follows:X$C_DONT_ALLOW_EXPOSURES
X$C_ALLOW_EXPOSURES
X$C_DEFAULT_EXPOSURESThis argument is optional.
owner_id_return = X$GET_SELECTION_OWNERArgument Information(display, selection_id)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
owner_id_return | identifier | uns longword | write | value |
display | identifier | uns longword | read | reference |
selection_id | identifier | uns longword | read | reference |
status_return = X$GET_SIZE_HINTSArgument Information(display, window_id, hints_return, property_id)
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 |
hints_return | record | x$size_hints | write | reference |
property_id | identifier | uns longword | read | reference |
status_return = X$GET_STANDARD_COLORMAPArgument Information(display, window_id, standard_colormap_return, property_id)
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 |
standard_colormap_return | record | x$standard_colormap | write | reference |
property_id | identifier | uns longword | read | reference |
status_return
Specifies whether the routine completed successfully. The routine fails if the standard color map property is not defined for the specified window. This argument returns one of the following values.
Value Description SS$_NORMAL Routine completed successfully. X$_PROPUNDEF The standard color map property has not been defined for the specified window. X$_ERRORREPLY Error received from server. X$_TRUNCATED Buffer not large enough; results truncated.
status_return = X$GET_SUB_IMAGEArgument Information(display, drawable_id, x_coord, y_coord, width, height, plane_mask, image_format, dst_ximage_return, dst_x_coord, dst_y_coord)
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 |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
width | longword | uns longword | read | reference |
height | longword | uns longword | read | reference |
plane_mask | mask_longword | uns longword | read | reference |
image_format | longword | longword | read | reference |
dst_ximage_return | record | x$image | write | reference |
dst_x_coord | longword | longword | read | reference |
dst_y_coord | longword | longword | read | reference |
status_return
Specifies whether the routine completed successfully. GET SUB IMAGE returns one of the following values:
Value Description SS$_NORMAL Routine completed successfully. X$_ERRORREPLY Error received from server.
image_format
The format of the image. The predefined values for image_format are as follows:X$C_XY_BITMAPOther values specified in this argument are not valid.
X$C_XY_PIXMAP
X$C_Z_PIXMAP
Previous | Next | Contents | Index |