Previous section.

Common Security: CDSA and CSSM
Copyright © 1997 The Open Group

NAME

CSP_GetCapabilities

SYNOPSIS

CSSM_CSPINFO_PTR CSSMSPI  CSP_GetCapabilities
    (CSSM_CSP_HANDLE CSPHandle,
    CSSM_BOOL CompleteCapabilitiesOnly,
    uint32 *CSPInfoCount)

DESCRIPTION

This function is called by the CSSM when the registry indicates that capabilities information for a CSP is dynamic.

PARAMETERS

CSPHandle (input)

The handle that describes the add-in cryptographic service provider module used to perform up calls to CSSM for the memory functions managed by CSSM.

CompleteCapabilitiesOnly (input)

Boolean flag that indicates whether all devices controlled by the CSP should be represented in the return list. If TRUE, all devices are listed regardless of availability. If FALSE, only devices that are available for use are listed.

CSPInfoCount (output)

The number of CSSM_CSPINFO structures returned. One structure should be returned for each device controlled by the CSP.

RETURN VALUE

The return value is an array of CSSM_CSPINFO structures, with the length returned in the CSPInfoCount parameter. If CSPInfoCount is zero, the return value will be NULL.

ERRORS

CSSM_INVALID_POINTER

Invalid pointer.

CSSM_MEMORY_ERROR

Internal memory error.

CSSM_INVALID_GUID

Unknown GUID.

SEE ALSO

CSP_EventNotify

Why not acquire a nicely bound hard copy?
Click here to return to the publication details or order a copy of this publication.
You should also read the legal notice explaining the terms and conditions relating to the CDSA documentation.

Contents Next section Index