SpUserModeInitializeFn callback function (ntsecpkg.h)

Article
02/22/2024

The SpUserModeInitialize function is called when a security support provider/authentication package (SSP/AP) DLL is loaded into the process space of a client/server application. This function provides the SECPKG_USER_FUNCTION_TABLE tables for each security package in the SSP/AP DLL.

Syntax

SpUserModeInitializeFn Spusermodeinitializefn;

NTSTATUS Spusermodeinitializefn(
  [in]  ULONG LsaVersion,
  [out] PULONG PackageVersion,
  [out] PSECPKG_USER_FUNCTION_TABLE *ppTables,
  [out] PULONG pcTables
)
{...}

Parameters

[in] LsaVersion

The version of the security provider DLL (either Secur32.dll or Security.dll).

[out] PackageVersion

Pointer that returns the version of the SSP/AP DLL.

[out] ppTables

Pointer that returns an array of SECPKG_USER_FUNCTION_TABLE structures. Each structure is a table of pointers to the user-mode functions implemented by a security package deployed in the SSP/AP DLL.

[out] pcTables

Pointer that returns the number of elements in the array pointed to by the ppTables parameter.

Return value

If the function succeeds, return STATUS_SUCCESS.

If the function fails, return an NTSTATUS code that indicates the reason it failed.

Remarks

The SpUserModeInitialize function must be implemented by SSP/AP DLLs that contain user-mode security packages.

The ppTables parameter should contain one SECPKG_USER_FUNCTION_TABLE for each user-mode security package deployed in the DLL. For more information on deploying security packages in DLLs, see User Mode Initialization.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntsecpkg.h