SetEnlistmentRecoveryInformation function (ktmw32.h)

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

Syntax

BOOL SetEnlistmentRecoveryInformation(
  HANDLE EnlistmentHandle,
  ULONG  BufferSize,
  PVOID  Buffer
);

Parameters

EnlistmentHandle

A handle to the enlistment.

BufferSize

The size of Buffer, in bytes.

Buffer

The recovery information.

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.

The information that is provided by the user may not be durably stored in the log at the completion of this operation, but it will be durably stored by the end of the next commit operation for this enlistment.

Requirements

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

See also

GetEnlistmentRecoveryInformation

Kernel Transaction Manager Functions