Previous | Contents | Index |
status_return = X$RM_ENUMERATE_DATABASEArgument Information(database_id, name_list_id, class_list_id, mode, proc, closure )
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | Boolean | longword | write | value |
database_id | identifier | uns longword | read | reference |
name_list | array | uns longword | read | reference |
class_list | array | uns longword | read | reference |
mode | longword | longword | read | reference |
proc | procedure | proc entry mask | read | reference |
closure | longword | uns longword | read | value |
database_id_return = X$RM_GET_DATABASEArgument Information(display )
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id_return | identifier | uns longword | write | value |
display | identifier | uns longword | read | reference |
database_id_return = X$RM_GET_FILE_DATABASEArgument Information(file_name)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id_return | identifier | uns longword | write | value |
file_name | char_string | character string | read | descriptor |
status_return = X$RM_GET_RESOURCEArgument Information(database_id, name_list_string, class_list_string, repr_type_return, [repr_value_return], [buf_len], [val_buf_return], [len_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
database_id | identifier | uns longword | read | reference |
name_list_string | char_string | character string | read | descriptor |
class_list_string | char_string | character string | read | descriptor |
repr_type_return | char_string | character string | write | descriptor |
repr_value_return | record | x$rm_value | write | reference |
buf_len | longword | longword | read | reference |
val_buf_return | uns longword | uns longword | write | reference |
len_return | longword | longword | write | reference |
status_return
Specifies whether the routine completed successfully. RM GET RESOURCE returns one of the following values:
Value Description SS$_NORMAL Routine completed successfully. X$_NOTFOUND Resource not found. X$_TRUNCATED Results truncated; user-supplied buffer not large enough.
val_buf_return
The address of the buffer containing the returned value. This argument is optional.len_return
The length of the returned value contained in the return value buffer. This argument is optional.
database_id = X$RM_GET_STRING_DATABASEArgument Information(data)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | write | value |
data | char_string | character string | read | descriptor |
status_return = X$RM_INITIALIZEArgument Information
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
status_return
Specifies whether the routine completed successfully.
status_return = X$RM_LOCALE_OF_DATABASEArgument Information(database_id, locale_string )
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
database_id | identifier | uns longword | read | reference |
locale_string | char_string | character string | read | descriptor |
X$RM_MERGE_DATABASESArgument Information(src_database_id, dst_database_id)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
src_database_id | longword | uns longword | read | reference |
dst_database_id | longword | uns longword | modify | reference |
X$RM_PARSE_COMMANDArgument Information(database_id, options, num_options, prefix_name, argc, argv)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | read | reference |
options | any | uns longword | read | reference |
num_options | longword | longword | read | reference |
prefix_name | char_string | character string | read | descriptor |
argc | longword | longword | modify | reference |
argv | any | byte | modify | reference |
repr_id_return = X$RM_PERM_STRING_TO_QUARKArgument Information(repr_name )
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
repr_id_return | identifier | uns longword | write | value |
repr_name | char_string | character string | read | descriptor |
X$RM_PUT_FILE_DATABASEArgument Information(database_id, file_name)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | read | reference |
file_name | char_string | character string | read | descriptor |
X$RM_PUT_LINE_RESOURCEArgument Information(database_id, resource_line)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | record | uns longword | modify | reference |
resource_line | char_string | character string | read | descriptor |
X$RM_PUT_RESOURCEArgument Information(database_id, specifier_name, type_name, [resource_value], [buf_len], [val_buf])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | modify | descriptor |
specifier_name | char_string | character string | read | descriptor |
type_name | char_string | character string | read | descriptor |
resource_value | record | x$rm_value | read | reference |
buf_len | longword | longword | read | reference |
val_buf | uns longword | uns longword | read | reference |
buf_len
Length of the value buffer. This argument is optional.val_buf
Address of the value buffer. This argument is optional.
X$RM_PUT_STRING_RESOURCEArgument Information(database_id, resource_name, value_name)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | modify | reference |
resource_name | char_string | character string | read | descriptor |
value_name | char_string | character string | read | descriptor |
status_return = X$RM_Q_GET_RESOURCEArgument Information(database_id, name_list_id, class_list_id, repr_type_id_return, [repr_value_id_return], [buf_len], [val_buf_return], [len_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
database_id | identifier | uns longword | read | reference |
name_list_id | identifier | uns longword | read | reference |
class_list_id | identifier | uns longword | read | reference |
repr_type_id_return | identifier | uns longword | write | reference |
repr_value_id_return | record | x$rm_value | write | reference |
buf_len | longword | longword | read | reference |
val_buf_return | record | byte | write | reference |
len_return | longword | longword | write | reference |
status_return
Specifies whether the routine completed successfully. RM Q GET RESOURCE returns one of the following values:
Value Description SS$_NORMAL Routine completed successfully. X$_NOTFOUND Resource not found. X$_TRUNCATED Results truncated; user-supplied buffer not large enough.
buf_len
The length of the buffer in which the value is returned. This argument is optional.val_buf_return
The address of the buffer containing the returned value. This argument is optional.len_return
The length of the returned value contained in the return value buffer. This argument is optional.
X$RM_Q_GET_SEARCH_LISTArgument Information(database_id, name_list_id, class_list_id, search_list_id_return, list_len)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
database_id | identifier | uns longword | read | reference |
name_list_id | identifier | uns longword | read | reference |
class_list_id | identifier | uns longword | read | reference |
search_list_id_return | Boolean | uns longword | write | reference |
list_len | uns longword | uns longword | read | reference |
X$RM_Q_GET_SEARCH_RESOURCEArgument Information(search_list_id, name_id, class_id, repr_type_id_return, [repr_value_return], [buf_len], [val_buf_return], [ret_len_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
search_list_id | identifier | uns longword | read | reference |
name_id | identifier | uns longword | read | reference |
class_id | identifier | uns longword | read | reference |
repr_type_id_return | Boolean | uns longword | write | reference |
repr_value_return | record | xrm$value | write | reference |
buf_len | longword | longword | read | reference |
val_buf_return | record | byte | write | descriptor |
ret_len_return | longword | longword | write | reference |
buf_len
The length of the following buffer. This argument is optional.val_buf_return
The returned buffer containing the value in the database. This argument is optional.ret_len_return
The length of the data written to the buffer. This argument is optional.
Previous | Next | Contents | Index |