TokenBindingGenerateMessage function (tokenbinding.h)

Article
02/22/2024

Assembles the list of token bindings and generates the final message for the client device to the server.

Syntax

SECURITY_STATUS TokenBindingGenerateMessage(
  [in]  const void * [] tokenBindings,
  [in]  const DWORD []  tokenBindingsSize,
  [in]  DWORD           tokenBindingsCount,
  [out] void            **tokenBindingMessage,
  [out] DWORD           *tokenBindingMessageSize
);

Parameters

[in] tokenBindings

Pointer to an array of token binding structures.

[in] tokenBindingsSize

An array that contains the sizes of the corresponding token binding structures that the array in the tokenBindings parameter contains, in bytes.

[in] tokenBindingsCount

The number of elements that the array in the tokenBindings parameter contains. This value cannot be 0.

[out] tokenBindingMessage

A pointer that receives the address of the buffer that is allocated for the token binding message. Use the HeapAlloc function to allocate the memory for this buffer, and the HeapFree method to free that memory.

[out] tokenBindingMessageSize

A pointer to a variable that contains the size of the buffer allocated for the tokenBindingMessage parameter.

Return value

Returns a status code that indicates the success or failure of the function.

Remarks

You can call TokenBindingGenerateMessage from user mode.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	tokenbinding.h
Library	Tokenbinding.lib
DLL	Tokenbinding.dll