NSSSRemoveSHSEntry

Removes a key or a value in a key-value pair stored in a Shared Secret.

Syntax

    #include <nssscl.h> 
     
    SS_EXTERN_LIBCALL(int) NSSSRemoveSHSEntry 
    (
     void            *handle, 
     unsigned char   *key, 
     unsigned char   *val, 
     unsigned long    ssCtxFlags
    );

Parameters

handle
(IN) Specifies the handle created by NSSSCreateSHSHandle.
key
(IN) Points to the value of the key-value pair desired to be removed.
val
(IN) Points to the value of the key-value pair desired to be removed.
ssCtxFlags
(IN) Specifies an optional structure that can be initialized by calling NSSSGetServiceInformation prior to use here. The flags field of the structure can take on the following values to indicate the type of context used.

NSSS_NCP_CTX_F—Directory Service API context indicator flag

NSSS_LDAP_CTX_F—LDAP context indicator flag <reserved>

Return Values

Value

Description

NSSS_SUCCESS

The operation succeeded in returning a key or value data.

NSSS_E_SH_SECRET_FAILURE

Shared Secret processing and operations failed.

NSSS_E_INVALID_PARAM

The API parameter is not initialized.

NSSS_E_SYSTEM_FAILURE

Some internal operating system services have not been available.

Remarks

This function contains the handle, pointers to user-allocated key and value buffers, and the unsigned long context flag member of the SSS_CONTEXT_T struct populated from calling NSSSGetServiceInformation.

See Also