cssm_GetAttachFunctions

NAME

cssm_GetAttachFunctions — Get SPI function table (CDSA)

SYNOPSIS

# include <cssm.h>

CSSM_RETURN CSSMAPI cssm_GetAttachFunctions
(CSSM_MODULE_HANDLE hAddIn,
CSSM_SERVICE_MASK AddinType,
void **SPFunctions,
CSSM_GUID_PTR Guid)

LIBRARY

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

PARAMETERS

`hAddIn` (`input`)		The handle identifying the attach-session whose function table is to be returned by this function.
`AddinType` (`input`)
		A CSSM_SERVICE_MASK value identifying the type of service module whose function table is to be returned by this function.
`SPFunctions` (`output`)
		A pointer to the service module function table, which CSSM acquired from the service module during module-attach processing. The module manager should use this table to forward application invocation of the elective APIs to their corresponding SPIs. The memory pointed to by the function pointers should not be freed by the EMM.
`Guid` (`output`)		A CSSM_GUID value identifying the service module whose function table is to be returned by this function.

DESCRIPTION

This function returns an SPI function table for the service module identified by the module handle. The module must be of the type specified by the service mask. The SPFunctions parameter contains the returned function table. The elective module manager must use this function table to forward an application's call to the elective APIs to their corresponding SPIs represented in the function table. The returned Guid identifies the service module. It can be used to locate credentials and other information about the service module.

This function sets a lock on the SP functions table. The CSSM service function cssm_ReleaseAttachFunctions() must be used to release the lock.

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.

cssm_GetAttachFunctions

» Table of Contents

» Glossary

» Index