SpGetUserInfoFn callback function (ntsecpkg.h)

Article
02/22/2024

The SpGetUserInfo function retrieves information about a logon session.

Syntax

SpGetUserInfoFn Spgetuserinfofn;

NTSTATUS Spgetuserinfofn(
  [in]  PLUID LogonId,
  [in]  ULONG Flags,
  [out] PSecurityUserData *UserData
)
{...}

Parameters

[in] LogonId

Pointer to an LUID containing the logon session for which information is to be retrieved.

[in] Flags

Specifies the acceptable length of the domain name as one of the following values.

Value	Meaning
NO_LONG_NAMES	The returned domain name cannot be longer than 15 characters.
UNDERSTANDS_LONG_NAMES	The returned domain name can be longer than 15 characters.

[out] UserData

Pointer to a pointer to a SecurityUserData structure. If the function call succeeds, the user information is returned in this structure. The security package should allocate the memory for this structure in the caller's address space. The caller is responsible for freeing the buffer by calling the FreeContextBuffer function.

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 Flags value NO_LONG_NAMES provides compatibility with Microsoft NTLM.

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

A pointer to the SpGetUserInfo function is available in the SECPKG_FUNCTION_TABLE structure received from the SpLsaModeInitialize 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