EssGetVersion

Gets the full version number of the connected Essbase Server, in the form Release.Version.Revision, e.g. 11.1.2.

Syntax

ESS_FUNC_M EssGetVersion (hCtx, pRelease, pVersion, pRevision);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

pRelease

ESS_PUSHORT_T

Address of variable to receive release number.

pVersion

ESS_PUSHORT_T

Address of variable to receive version number.

pRevision

ESS_PUSHORT_T

Address of variable to receive revision number.

Notes

You can call this function after connecting to a server, to ensure that the Essbase Server version supports all the features used by your program.

Return Value

If successful, returns the full incremental Essbase version number in pRelease, pVersion and pRevision.

Access

This function requires no special privileges.

Example

ESS_FUNC_M
ESS_GetVersion (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_USHORT_T  Release;
   ESS_USHORT_T  Version;
   ESS_USHORT_T  Revision;
       
   sts = EssGetVersion (hCtx, &Release, &Version,
         &Revision);
   if (!sts)
   {
      printf ("\r\nEssbase Application Server - Version %d.%d.%d\r\n", Release, Version, Revision);
   }
   
  return (sts);
}

See Also

  • EssInit