EsbSetSpanRelationalSource

Sets 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 EsbSetSpanRelationalSource 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 EsbSetRelationalSource Lib "ESBAPIN" (ByVal hCtx As Long) As Long
  
  Sub ESB_SetRelationalSource ()
     Dim sts As Long
  
     '*************************
     ' Set the bSpanRelPart  field
     '*************************
     sts = EsbSetRelationalSource (hCtx)
  
  End Sub