# Constant and Structure Definitions for Linked Objects

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

Constants for Linked Reporting Objects
ESB_CELLADDR_API_T
ESB_LRODESC_API_T
ESB_LROHANDLE_API_T
ESB_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 Visual Basic API.

Constant | Value | Definition
ESB_LRODESCLEN_API | 79 | Maximum length of an object description
ESB_LRONOTELEN_API | 599 | Maximum length of a cell note
ESB_ONAMELEN_API | 511 | Length of an object name consisting of file name and path
ESB_STORE_OBJECT_API | &H0010 | Value specifying to store a linked object on the server
ESB_NOSTORE_OBJECT_API | &H0001 | Value specifying not to store a linked object on the server
ESB_LRO_OBJ_API | 1 | Value specifying to update only the linked object file
ESB_LRO_CATALOG_API | 2 | Value specifying to update only the object's catalog entry
ESB_LRO_BOTH_API | 3 | Value specifying to update both the object file and the catalog entry
ESB_LROTYPE_CELLNOTE_API | 0 | Value specifying that a linked object is a cell note
ESB_LROTYPE_WINAPP_API | 1 | Value specifying that a linked object is a Windows application
ESB_LROTYPE_URL_API | 2 | Value specifying that a linked object is a URL

### ESB_CELLADDR_API_T

This structure contains information about the address of a data cell. Essbase derives the cell address from the member combination and uses the address to keep track of objects linked to data cells. The EsbLROAddObject() function returns the cell address in the object's description structure; you can use this information in subsequent API calls. You cannot modify fields in this structure through the API. The fields are described as follows:

Data Type | Field | Description
Long | cellOffset | Cell offset within a data block
Double | blkOffset | Block offset
Double | segment | Segment number

### ESB_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
Integer | ObjType | The object type
Integer | status | The catalog entry status
Long | memCount | The number of member names in the member combination identifying the data cell
ESB_LROHANDLE_API_T | LinkID | A link to the object's identification structure
Long | updateDate | The last date the object was modified
Integer | accessLevel | The access level for the data cell associated with the linked object
String * ESB_USERNAMELEN | userName | The name of the last user to modify the object
String | memComb | The member combination that identifies the data cell associated with the linked object
String * ESB_LRONOTELEN_API | note | A cell note, associated by union
ESB_LROINFO_API_T | lroInfo | The LRO information structure, associated by union

### ESB_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. The fields are described as follows:

Data Type | Field | Description
ESB_CELLADDR_API_T | cellKey | Cell address
Long | hObject | Internal object handle

### ESB_LROINFO_API_T

This structure contains descriptive information about a specific object linked to a data cell in an Essbase database. You might modify this structure when updating an object's source file name or object description. To do this, use EsbLROGetCatalog() to retrieve the object's catalog entry, modify the objName and/or objDesc fields as needed, then use EsbLROUpdateObject() save your changes on the server. The fields are described as follows:

Data Type | Field | Description
String * ESB_ONAMELEN_API | objName | Source file name of object linked to a data cell. ESB_ONAMELEN_API specifies the maximum length of an object name; the default value is 511.
String * ESB_LRODESCLEN_API | objDesc | Description of an object linked to a data cell. ESB_LRODESCLEN_API specifies the maximum length of the description; the default value is 79.