Clears the Boolean bSpanRelPart field informing Essbase that pertinent data exists in an attached relational store. Some other API functions, such as EsbQueryDatabaseMembers, read bSpanRelPart and access the relational store if bSpanRelPart is set.
Syntax
Declare Function EsbClrSpanRelationalSource Lib "esbapin" (ByVal hCtx As Long) As Long
Parameter | Description |
---|---|
hCtx | API context handle. |
Notes
Several API functions have been enhanced to retrieve information from relational stores.
EsbQueryDatabaseMembers—Returns member names from the relational store.
EsbGetMemberInfo—Returns information on members in the relational store.
EsbCheckMemberName—Checks in the relational store for valid member names.
EsbGetMemberCalc—Recognizes a relational member passed as input and returns a null string for all relational members.
Return Value
None.
Access
This function requires the caller to have read privilege (ESS_PRIV_READ) to one or more members in the active database.
Example
Declare Function EsbClrRelationalSource Lib "ESBAPIN" (ByVal hCtx As Long) As Long Sub ESB_ClrRelationalSource () Dim sts As Long '************************** ' Clear the bSpanRelPart field '************************** sts = EsbClrRelationalSource (hCtx) End Sub
See Also