# EssDTAPISetConnection

Description

Given a connection information string, and an Extended Member Comment string, EssDTAPISetConnection() initializes a drill-through handle, and starts the Drill-Through Wizard.

NOTE:
In future releases, the C Main API Drill-Through functions, including this function, will be deprecated and replaced by the corresponding Grid API functions. Programs should use the Grid API Drill-Through functions.

Syntax

ESS_FUNC_M EssDTAPISetConnection (pDTAPIInst, pEMC, ulCount, pDTInfo);

ESS_PDTAPIHINST_T | pDTAPIInst;
ESS_PSTR_T | pEMC;
ESS_ULONG_T | ulCount;
ESS_PSTR_T | pDTInfo;

Parameters

pDTAPIInst | Pointer to a drill-through initialization structure
pEMC | Extended Member Comment
ulCount | Number of Extended Member Comment blocks
pDTInfo | Connection information

Return Value

Notes

- Use EssGDTRequestDrillThrough() to initialize the drill-through instance handle, because:
  - EssDTAPISetConnection() currently does not initialize pDTAPIInst.
  - Due to security issues, pConnection (the connection information string) and pEMC (the extended member comment string) currently are not retrieved from the Essbase server.

See Also

Using the Main C API
Main C API Structures
EssDTAPIClose()
EssDTAPIConnect()
EssDTAPIExecuteReport()
EssDTAPIExit()
EssDTAPIGetColumns()
EssDTAPIGetData()
EssDTAPIGetError()
EssDTAPIGetInfo()
EssDTAPIGetReports()
EssDTAPIInit()
EssDTAPISetInfo()