Programming Guides › Programming Guide for C › Policy Management API › Function Declarations for the Policy Management API › Sm_PolicyApi_DeleteVariable()
Sm_PolicyApi_DeleteVariable()
Deletes a variable object.
Type
Variable function.
Syntax
int SM_EXTERN Sm_PolicyApi_DeleteVariable (
void* pSessionHandle,
const char* pszVariableOid
);
|
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.
|
|
pszVariableOid
|
I
|
A null-terminated string containing the object identifier of an existing variable.
|
Returns
- Sm_PolicyApi_Success. The delete operation was successful.
- Sm_PolicyApi_Failure. The delete operation was not successful.
- 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 delete a variable.
- Sm_PolicyApi_InvalidOid. The variable object identifier was not found.
- Sm_PolicyApi_FeatureNotSupported. The client who called this function initialized the API with a version less than SM_POLICY_API_VERSION_6_0.
