Export (0) Print
Expand All

SetEnlistmentRecoveryInformation function

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 WINAPI SetEnlistmentRecoveryInformation(
  _In_  HANDLE EnlistmentHandle,
  _In_  ULONG BufferSize,
  _In_  PVOID Buffer
);

Parameters

EnlistmentHandle [in]

A handle to the enlistment.

BufferSize [in]

The size of Buffer, in bytes.

Buffer [in]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INSUFFICIENT_RESOURCES
ERROR_TRANSACTION_ALREADY_ABORTED

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

Header

Ktmw32.h

Library

Ktmw32.lib

DLL

Ktmw32.dll

See also

GetEnlistmentRecoveryInformation
Kernel Transaction Manager Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft