HRS_GetHeaderFromHandle

NAME

CSSM_HRS_GetHeaderFromHandle, HRS_GetHeaderFromHandle — Retrieves the BIR header identified by handle

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_GetHeaderFromHandle
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_BIR_HANDLE Handle,
        CSSM_HRS_BIR_HEADER_PTR Header);

SPI

CSSM_RETURN CSSMHRI HRS_GetHeaderFromHandle
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_BIR_HANDLE Handle,
        CSSM_HRS_BIR_HEADER_PTR Header);

LIBRARY

HRS Extensible Module Manager (cdsa$inhrsemm_shr.exe)

PARAMETERS

The parameter definitions are the same for the API and the SPI.

`ModuleHandle` (input)		The handle of the attached HRS service provider.
`Handle` (input)		The handle of the BIR whose header is to be retrieved.
`Header` (output)		The header of the specified BIR.

DESCRIPTION

This function retrieves the BIR header identified by handle. The BIR handle is not freed by the HRS service provider.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSSM_NOT_INITIALIZED CSSMERR_CSSM_FUNCTION_FAILED CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL