RtlUnwindEx function

Initiates an unwind of procedure call frames.

Syntax


void WINAPI RtlUnwindEx(
  _In_opt_  FRAME_POINTERS TargetFrame,
  _In_opt_  PVOID TargetIp,
  _In_opt_  PEXCEPTION_RECORD ExceptionRecord,
  _In_      PVOID ReturnValue,
  _In_      PCONTEXT OriginalContext,
  _In_opt_  PUNWIND_HISTORY_TABLE HistoryTable
);

Parameters

TargetFrame [in, optional]

A pointer to the call frame that is the target of the unwind. If this parameter is NULL, the function performs an exit unwind.

TargetIp [in, optional]

The continuation address of the unwind. This parameter is ignored if TargetFrame is NULL.

ExceptionRecord [in, optional]

A pointer to an EXCEPTION_RECORD structure.

ReturnValue [in]

A value to be placed in the integer function return register before continuing execution.

OriginalContext [in]

A pointer to a CONTEXT structure that stores context during the unwind operation.

HistoryTable [in, optional]

A pointer to the unwind history table. This structure is processor specific. For definitions of this structure, see Winternl.h.

Return value

This function does not return a value.

Remarks

The FRAME_POINTERS structure is defined as follows:


typedef struct _FRAME_POINTERS {
    ULONGLONG MemoryStackFp;
    ULONGLONG BackingStoreFp;
} FRAME_POINTERS, *PFRAME_POINTERS;

Windows Phone 8: This API is supported.

Windows Phone 8.1: This API is supported.

Requirements

Product

Windows XP Professional x64 Edition or 64-bit editions of Windows Server 2003

Header

WinNT.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CONTEXT
EXCEPTION_RECORD

 

 

Community Additions

ADD
Show:
© 2014 Microsoft