# EssClrSpanRelationalPartition

Description

EssClrSpanRelationalPartition() clears the Boolean bSpanRelPart field informing Essbase that pertinent data exists in an attached relational store. Some other API functions, such as EssQueryDatabaseMembers, read bSpanRelPart and access the relational store if bSpanRelPart is set.

Syntax

    ESS_FUNC_M EssClrSpanRelationalPartition (hCtx);

ESS_HCTX_T | hCtx

Parameters

hCtx | Essbase API context handle.

Return Value

None.

Notes

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

- EssQueryDatabaseMembers - returns member names from the relational store.
- EssGetMemberInfo - returns information on members in the relational store.
- EssCheckMemberName - checks in the relational store for valid member names.
- EssGetMemberCalc - recognizes a relational member passed as input and returns a null string for all relational members.

Access

This function requires the caller to have read privilege (ESS_PRIV_READ) to one or more members in the active database.

Example

    ESS_FUNC_M
    ESS_Report (ESS_HCTX_T   hCtx,
                ESS_HINST_T  hInst
               )
    {
       ESS_FUNC_M      sts     = ESS_STS_NOERR;
       ESS_STR_T     rString = NULL;
       sts = EssBeginReport (hCtx,ESS_TRUE,ESS_FALSE);
       if (!sts)
          sts = EssSendString (hCtx, "<Desc Year !");
       if (!sts)
          sts = EssClrSpanRelationalPartition (hCtx);
       /**************
        * Get report *
        **************/

       if (!sts)
          sts = EssGetString (hCtx, &rString);
       while ((!sts) && (rString != NULL))
       {
              printf ("%s", rString);
              EssFree (hInst, rString);
              sts = EssGetString (hCtx, &rString);
       }
       printf ("\r\n");

       return(sts);
    }

See Also

EssSetSpanRelationalPartition