Export (0) Print
Expand All

GetEnlistmentRecoveryInformation function

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 WINAPI GetEnlistmentRecoveryInformation(
  _In_       HANDLE EnlistmentHandle,
  _In_       ULONG BufferSize,
  _Out_      PVOID Buffer,
  _Out_opt_  PULONG BufferUsed
);

Parameters

EnlistmentHandle [in]

A handle to the enlistment.

BufferSize [in]

The size of the Buffer parameter, in bytes.

Buffer [out]

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

BufferUsed [out, optional]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INSUFFICIENT_RESOURCES
ERROR_TRANSACTION_ALREADY_ABORTED

Remarks

This call cannot be used with volatile transaction managers.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Ktmw32.h

Library

Ktmw32.lib

DLL

Ktmw32.dll

See also

Kernel Transaction Manager Functions
SetEnlistmentRecoveryInformation

 

 

Community Additions

ADD
Show:
© 2014 Microsoft