Previous Topic: SmDirLookup()Next Topic: SmDirRelease()

Programming Guides › Programming Guide for C › Directory API Guidance › Directory API Reference › SmDirQueryVersion()

SmDirQueryVersion()

SmDirQueryVersion() queries the Directory API to find out its version and its directory capabilities. Supported capabilities are enumerated in Sm_DirApi_Capability_t.

Syntax

int SM_EXTERN SmDirQueryVersion (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   unsigned long*           pnCapabilities
);

Parameter

I/O

Description

lpApiContext

I

Pointer to the API context structure.

pHandle

I

The address of the pointer returned by SmDirInit().

pnCapabilities

O

This parameter is used to pass the capabilities of the custom directory. The capabilities of a custom directory are enumerated in Sm_DirApi_Capability_t, which is defined in SmApi.h. For more information on Sm_DirApi_Capability_t, see Directory Capabilities.

Returns

Returns the version number of the Directory API that the custom library complies with. Currently the versions supported are Sm_Api_Version_V4 and Sm_Api_Version_V4_1. Version constants are defined in SmApi.h.