EssOtlGetEnabledDTSMembers

Description

EssOtlGetEnabledDTSMembers() gets (the info structures for) the enabled DTS members for the outline.

Syntax

ESS_STS_T EssOtlGetEnabledDTSMembers (hOutline, pusCount, ppEnabledDTSMemberList); 

ESS_HOUTLINE_T hOutline
ESS_PUSHORT_T pusCount
ESS_PPDTSMBRINFO _T ppEnabledDTSMemberList

Parameters

hOutline Essbase outline handle. This must have been returned from the EssOtlOpenOutlineQuery call.
pusCount The number of enabled DTS Members.
ppEnabledDTSMemberList Pointer to an array of DTS member info structures (for the enabled DTS members for the outline).

Return Value

If successful the return value is zero. Otherwise, returns the status of the EssOtlQueryMembers() call.

Notes

Example

#include "essapi.h"
#include "essotl.h"
#include "esserror.h"

ESS_STS_T ESS_OtlGetEnabledDTSMembers(ESS_HCTX_T hCtx) 
{
	ESS_STS_T 	sts =ESS_STS_NOERR;
	ESS_HOUTLINE_T	hOutline;
	ESS_OBJDEF_T	Object;
	ESS_APPNAME_T	szAppName;
	ESS_DBNAME_T	szDbName;
	ESS_OBJNAME_T	szFileName;
	ESS_USHORT_T	usCount, i;
	ESS_PDTSMBRNAME_T	pEnabledDTSMbrList;

	strcpy(szAppName, "Sample");	
	strcpy(szDbName, "Basic");
	strcpy(szFileName, "Basic");

	memset(&Object, '\0', sizeof(ESS_OBJDEF_T));
	Object.hCtx = hCtx;
	Object.ObjType = ESS_OBJTYPE_OUTLINE;
	Object.AppName = szAppName;
	Object.DbName = szDbName;
	Object.FileName = szFileName;

	sts = EssOtlOpenOutline(hCtx, &Object, ESS_FALSE, ESS_TRUE, &hOutline);
	if(sts)
	{	
		printf("Could not open outline\n");
		return sts;
	}

	sts = EssOtlGetEnabledDTSMembers(hOutline, &usCount, &pEnabledDTSMbrList);
	if(sts)
	{	
		printf("Could not get enabled DTS member alias\n");
	}
	else
	{
		printf("No of enabled DTS members is %u\n", usCount);
		for (i = 0; i < usCount; i++)
		{
			printf("%s\n", pEnabledDTSMbrList[i]);
		}
	}	
	EssOtlCloseOutline(hOutline);
	return sts;
}

See Also

EssOtlEnableDTSMember()
EssOtlDeleteDTSMemberAlias()
EssOtlGetDTSMemberAlias()
EssOtlSetDTSMemberAlias()