GetEnlistmentRecoveryInformation function (ktmw32.h)

Article
02/22/2024

Retrieves an opaque structure of recovery data from KTM. Recovery information is stored in a log on behalf of a resource manager (RM) by calling the SetEnlistmentRecoveryInformation function. After a failure, the RM can use the GetEnlistmentRecoveryInformation function to retrieve the information.

Syntax

BOOL GetEnlistmentRecoveryInformation(
  [in]            HANDLE EnlistmentHandle,
  [in]            ULONG  BufferSize,
  [out]           PVOID  Buffer,
  [out, optional] PULONG BufferUsed
);

Parameters

[in] EnlistmentHandle

A handle to the enlistment.

[in] BufferSize

The size of the Buffer parameter, in bytes.

[out] Buffer

A pointer to a buffer that receives the enlistment recovery information.

[out, optional] BufferUsed

A pointer to a variable that receives the actual number of bytes returned in the Buffer parameter.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is 0 (zero). To get extended error information, call the GetLastError function.

The following list identifies the possible error codes:

Remarks

This call cannot be used with volatile transaction managers.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	ktmw32.h
Library	Ktmw32.lib
DLL	Ktmw32.dll