Sm_PolicyApi_GetHostConfigByName()

Retrieves an existing host configuration object.
casso10
Retrieves an existing host configuration object.
Type
Agent configuration function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetHostConfigByName (
void*pSessionHandle,            
const char*pszHostConfigName,
Sm_PolicyApi_HostConfig_t**ppstructHostConfig
);
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.
pszHostConfigName
I
Unique name of the host configuration object to retrieve.
ppstructHostConfig
O
Address of a pointer to a structure that defines the host configuration object. The function allocates the structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Generalized failure.
  • Sm_PolicyApi_NotFound. The unique name does not correspond to a host configuration object.
  • Sm_PolicyApi_NoPrivilege. The caller does not have the privilege to get a host configuration object.
  • Sm_PolicyApi_InvalidHandle. The session pointer is not valid.
  • Sm_PolicyApi_NoSession. The API user is not properly logged in.