SpInstanceInitFn callback function (ntsecpkg.h)

Article
02/22/2024

The SpInstanceInit function is called once for each security package contained in an SSP/AP, when the SSP/AP is loaded into a client/server process. Security packages should use this function to perform any user mode-specific initialization.

Syntax

SpInstanceInitFn Spinstanceinitfn;

NTSTATUS Spinstanceinitfn(
  [in]  ULONG Version,
  [in]  PSECPKG_DLL_FUNCTIONS FunctionTable,
  [out] PVOID *UserFunctions
)
{...}

Parameters

[in] Version

The version of the Local Security Authority (LSA).

[in] FunctionTable

Pointer to a SECPKG_DLL_FUNCTIONS structure containing the support functions that the security package can use in user-mode.

[out] UserFunctions

This parameter is not used.

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 SpInstanceInit function is called once when the SSP/AP is loaded into the user-mode process, after the SpUserModeInitialize function is called.

SSP/APs must implement the SpInstanceInit function; however, the actual name given to the implementation is up to the developer.

A pointer to the SpInstanceInit function is available in the SECPKG_USER_FUNCTION_TABLE structure received from the SpUserModeInitialize function.

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