Get

Author: Hiroshisa Mori / joshua@globalbase.org + [Transrate]Reiko Inoue Bendtsen c/o Suzaku Translations / (http://www.suzaku-translations.com/) +

PROTOTYPE

<Get> filename dim_code </Get>

ARGUMENTS

filename [1] XLT_STRING [UNDEF REF (XLT_STRING)]File path

dim_code [0-1] List of integers [UNDEF REF (XLT_PAIR)]Dimensional code

ATTRIBUTES

mode [arbitrary] Character string; Meta

EVALUATION TYPE

applicative

AGENT(S) BELONGS

gbmx

ENVIRONMENT BELONGS

Env0

EXPLANATION

This function is used by the XL server. It acquires matrix file information.

If mode is omitted, the function acquires the information from the file itself. It returns a list of node information corresponding to dim_code.

If you specify mode ="meta," the function returns the status information of the file. This is the same function as path_type="related" in the gmxStatus function . At this point, the format of the return value is given by the gmxStatus list .

[UP] Go To Page Top

RETURN VALUE

In case of mode ="meta, a gmxStatus list is returned.

If mode is omitted, XLT_RAW [UNDEF REF (XLT_RAW)]type node information is returned. The XLT_RAW contains the following information.

nlist_type 1byte
Format type of a child node list
- 0:Bit field type
- 1:dim_code enumeration type
Child node: In case of bit field type
1. nlist_dim_bit_field_len
  Length of bit field: compressed_code64 format integer
2. nlist_dim_bit_field
  Bit field of length nlist_dim_bit_field_len
Child node: In case of dim_code enumeration type
1. nlist_dim_addr_len
  Number of dim_codes counted: compressed_code64 format integer
2. dim_codes
  dim_code for the number of nlist_dim_addr_len. Each dim_code is a row of compressed_code64 format integers
channel_data
channel data Each channel data is formatted in the following order, repeated for the number of required channels.
1. id
  Channel ID: compressed_code64 format
2. len
  Channel data length: compressed_code64 format
3. data
  The data itself. The format conforms to the format of each data type.

ERRORS

XLE_SEMANTICS_TYPE_MISSMATCH [UNDEF REF (XLE_SEMANTICS_TYPE_MISSMATCH)]
The type of filename or point-data do not match.
XLE_PROTO_INV_PARAM [UNDEF REF (XLE_PROTO_INV_PARAM)]

REFERENCE

BUGS

[UP] Go To Page Top