Sm_PolicyApi_GetAdminByName()

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

Sm_PolicyApi_GetAdminByName()

Gets the contents of the administrator object identified by szAdminName.

The results of this function are returned in a structure referenced by ppstructAdmin. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

Administrator function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetAdminByName (
   void*                    pSessionHandle,
   const char*              pszAdminName,
   Sm_PolicyApi_Admin_t**   ppstructAdmin
);

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.
pszAdminName	I	A null-terminated string containing the name of an existing administrator.
ppstructAdmin	O	The address of a pointer to an administrator structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_Admin_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 an administrator object.
Sm_PolicyApi_NotFound. The administrator name was not found.