QueryKeySizeInBits

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

PassThrough

QuerySize

QueryKeySizeInBits

Library
Spi Parameters
Return Value
See Also

Api Parameters
Description
Errors

NAME

QueryKeySizeInBits: CSSM_QueryKeySizeInBits, CSP_QueryKeySizeInBits - Get CSP logical and effective sizes (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_QueryKeySizeInBits(CSSM_CSP_HANDLE CSPHandle,CSSM_CC_HANDLE CCHandle,const CSSM_KEY *Key,CSSM_KEY_SIZE_PTR KeySize)SPI:CSSM_RETURN CSSMCSPI CSP_QueryKeySizeInBits(CSSM_CSP_HANDLE CSPHandle,CSSM_CC_HANDLE CCHandle,const CSSM_CONTEXT *Context,const CSSM_KEY *Key,CSSM_KEY_SIZE_PTR KeySize)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

API PARAMETERS

`CSPHandle` (input/optional)
		The handle that describes the Cryptographic ServiceProvider module used to perform this function. For the API, this parameter is ignored if a valid cryptographiccontext handle is specified.
`CCHandle` (input/optional)
		A handle to a context that describes a cryptographicoperation. The cryptographic context should contain a handle tothe CSP that is being queried and the key about which key-size informationis being requested.
`Key` (input/optional)
		A pointer to a CSSM_KEY structure containing thekey about which key-size information is being requested. This parameteris ignored if a valid cryptographic context handle is specified.
`KeySize` (output)
		Pointer to a CSSM_KEY_SIZE data structure. The logicaland effective sizes (in bits) for the key are returned in this structure. For the API, if no context handle is provided, only the CSSM_KEY_SIZE `LogicalKeySizeInBits` fieldis set.

SPI PARAMETERS

`Context` (input)
		Pointer to CSSM_CONTEXT structure that describesthe attributes with this context.

DESCRIPTION

This function queries a Cryptographic Service Provider (CSP)for the logical and effective sizes of a specified key.

The Cryptographic Service Provider (handle) and the key canbe specified either in the cryptographic context or as parametersto the function call. If a valid cryptographic context handle parameteris specified, the CSP handle and key parameters are ignored.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSP_QUERY_SIZE_UNKNOWN