LRO Constant and Structure Definitions

The following constants and structures are defined specifically for use with Linked Reporting Objects (LRO):

Constants for Linked Reporting Objects
ESS_CELLADDR_API_T
ESS_LRODESC_API_T
ESS_LROHANDLE_API_T
ESS_LROINFO_API_T

Constants for Linked Reporting Objects

The following constants define various values used by Linked Reporting Objects (LRO) functions and structures in the Essbase API.

Data Type Field Description
ESS_LRODESCLEN_API 79 Maximum length of an object description
ESS_LRONOTELEN_API 599 Maximum length of a cell note
ESS_ONAMELEN_API 511 Length of an object name consisting of file name and path
ESS_DATESIZE 12 Size of date string
ESS_STORE_OBJECT_API 0x0010 Value to store a linked object on the server
ESS_NOSTORE_OBJECT_API 0x0001 Value to not store a linked object on the server
ESS_LROTYPE_CELLNOTE_API 0 Value specifying that a linked object is a cell note
ESS_LROTYPE_WINAPP_API 1 Value specifying that a linked object is a Windows application
ESS_LROTYPE_URL_API 2 Value specifying that a linked object is a URL

ESS_CELLADDR_API_T

This structure contains information about the address of a data cell in an Essbase database. Essbase derives the cell address from the member combination and uses the address to keep track of objects linked to data cells. You cannot modify fields in this structure through the API. The fields are described as follows:

Data Type Field Description
ESS_ULONG_T cellOffset Cell offset within a data block
ESS_SECPART_T blkOffset Block offset
ESS_SECPART_T segment Segment number

ESS_LRODESC_API_T

This structure contains information describing a specific object linked to a data cell in an Essbase database. The fields are described as follows:

Data Type Field Description
struct ESS_LRODESC_API_T next (The next field is for internal use only.)
ESS_USHORT_T usObjType The object type
ESS_USHORT_T status The catalog entry status
ESS_LROHANDLE_API_T hObject The object handle
ESS_CHAR_T userName[ESS_USERNAMELEN] The name of the last user to modify the object
ESS_TIME_T updateDate The last date the object was modified
ESS_ACCESS_T accessLevel The access level of the member combination
ESS_ULONG_T memCount The number of members in the member combination
ESS_PMBRNAME_T pMemComb The member combination associated with the object
ESS_LROINFO_API_T lroInfo The LRO information structure, associated by union
ESS_CHAR_T note[ESS_LRONOTELEN_API] A cell note, associated by union

ESS_LROHANDLE_API_T

This structure provides an identifier for a linked object. The identifier consists of a cell address and an internal object handle. You should not modify fields in this structure because it contains information concerning the linked object. The fields are described as follows:

Data Type Field Description
ESS_CELLADDR_API_T cellKey Cell address
ESS_LONG_T hObject Internal object handle

ESS_LROINFO_API_T

This structure contains information about a specific object linked to a data cell in an Essbase database. You should not modify fields in this structure because it contains information concerning the linked object. The fields are described as follows:

Data Type Field Description
ESS_CHAR_T objName[ESS_ONAMELEN_API] Source file name of object linked to a data cell. ESS_ONAMELEN_API specifies the maximum length of an object name; the default value is 511.
ESS_CHAR_T objDesc[ESSW_LRODESCLEN_API] Description of an object linked to a data cell. ESS_LRODESCLEN_API specifies the maximum length of the description; the default value is 79.