NSSSGetNextSHSEntry

Specifies sequential calls required to obtain the Shared Secret data returned to NSSSReadSharedSecret.

Syntax

    #include <nssscl.h> 
     
    SS_EXTERN_LIBCALL(int) NSSSGetNextSHSEntry 
    (
     BOOL             bRestart, 
     void            *handle, 
     in              *keyLen, 
     unsigned long   *key, 
     int             *valLen, 
     unsigned char   *val, 
     unsigned long    ssCtxFlags);

Parameters

bRestart
(IN) Specifies location in the buffer to begin search. Set to 1 to begin from the beginning of the buffer, otherwise, set to 0.
handle
(IN) Points to the handle created by NSSSCreateSHSHandle.
keyLen
(OUT) Points to the length of the key.
key
(OUT) Points to the key used for storing key-value pair data as defined in the SharedSecret format.
valLen
(OUT) Points to the length of the value.
val
(OUT) Points to the value used to for storing key-value pair data as defined in the SharedSecret format.
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

–1

The operation has completed its search.

Remarks

Sequential calls to this function contain the handle, the unsigned long context flag from the user-populated SSS_CONTEXT_T struct passed into NSSSReadSharedSecret, and pointers to user-allocated key/value buffer and length parameters which are populated upon return of the call.

See Also