EssGetDrillThruURL

Gets the drill-through URL within the active database outline.

Syntax

ESS_FUNC_M EssGetDrillThruURL (hCtx, URLName, &pUrl);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle
URLName	ESS_STR_T	Drill-through URL name
pUrl	ESS_PDURLINFO_T	URL definition

Return Value

If successful, gets the drill-through URL in the active database outline.
If unsuccessful, returns an error code.

Access

Caller must have database Read privilege (ESS_PRIV_READ) for the specified database.
Caller must have selected the specified database as the active database using EssSetActive().

Example

static void DisplayUrlDefn (ESS_PDURLINFO_T pUrls )
{
   ESS_UINT_T	i;

   printf("\tUrlname        : %s\n", pUrls->cpURLName );
   if (pUrls->bIsLevel0)
      printf("\tUrl Is Level-0 slice : Yes\n");
   else
      printf("\tUrl Is Level-0 slice : No\n");
	
   printf("\tUrlXmlsize    : %i\n", pUrls->iURLXmlSize );
   printf("\tUrlXml        : %s\n", (ESS_STR_T) pUrls->cpURLXml);

   printf("\tNumber of drill region(s): %d\n", pUrls->iCountOfDrillRegions);
   for ( i = 0; i < pUrls->iCountOfDrillRegions; i++ )
   {
   printf("\t\tDrillRegion[%d]: %s\n", i, pUrls->cppDrillRegions[i] );
   }
   printf("\n");
}
ESS_STS_T sts = ESS_STS_NOERR;
ESS_STR_T urlName = "";
ESS_USHORT_T usCountOfURLs, i;
ESS_PDURLINFO_T urlInfo;

/* Valid case*/

urlName = "Drill Through to EPMI";
sts = EssGetDrillThruURL(hCtx, urlName, &urlinfo);
printf("EssGetDrillThruURL sts: %ld\n",sts);
if(!sts)
   DisplayUrlDefn(urlInfo);

EssFreeStructure (hInst, ESS_DT_STRUCT_URLINFO, 1, (ESS_PVOID_T)urlInfo);