Sm_PolicyApi_GetSchemeByName()

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_GetSchemeByName()

Sm_PolicyApi_GetSchemeByName()

Gets the contents of the authentication scheme identified by pszSchemeName. The results of this function are returned in a structure referenced by ppstructScheme.

Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

Authentication scheme function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetSchemeByName (
   void*                     pSessionHandle,
   const char*               pszSchemeName,
   Sm_PolicyApi_Scheme_t**   ppstructScheme
);

Parameter	I/O	Description
pSessionHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszSchemeName	I	A null-terminated string containing the name of an existing scheme.
ppstructScheme	O	The address of a pointer to a scheme structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Scheme_t.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a scheme.
Sm_PolicyApi_NotFound. The scheme name was not found.