EsbClrSpanRelationalSource

Description

EsbClrSpanRelationalSource() 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

Parameters

hCtx Essbase API context handle.

Return Value

None.

Notes

Several API functions have been enhanced to retrieve information from relational stores.

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 "ESBAPIW" (ByVal hCtx As Long) As Long
  
  Sub ESB_ClrRelationalSource ()
     Dim sts As Long
  
     '**************************
     ' Clear the bSpanRelPart  field
     '**************************
     sts = EsbClrRelationalSource (hCtx)
  
  End Sub


See Also

EsbSetSpanRelationalSource