SpMarshallSupplementalCredsFn callback function (ntsecpkg.h)

Article
02/22/2024

The SpMarshallSupplementalCreds function converts supplemental credentials from a public format into a format suitable for local procedure calls.

Syntax

SpMarshallSupplementalCredsFn Spmarshallsupplementalcredsfn;

NTSTATUS Spmarshallsupplementalcredsfn(
  [in]  ULONG CredentialSize,
  [in]  PUCHAR Credentials,
  [out] PULONG MarshalledCredSize,
  [out] PVOID *MarshalledCreds
)
{...}

Parameters

[in] CredentialSize

Specifies the size of the supplemental credentials.

[in] Credentials

Pointer to the supplemental credentials.

[out] MarshalledCredSize

Pointer to the size of the MarshalledCreds buffer.

[out] MarshalledCreds

Pointer that receives the address of the buffer containing the serialized credentials. Allocate the memory for this buffer by calling the AllocateHeap 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

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

A pointer to the SpMarshallSupplementalCreds 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