Edit

FunctionLeave Function

  • Article

Notifies the profiler that a function is about to return to the caller.

Note

The FunctionLeave function is deprecated in .NET Framework 2.0. It will continue to work, but will incur a performance penalty. Use the FunctionLeave2 function instead.

Syntax

void __stdcall FunctionLeave (  
    [in] FunctionID funcID  
);

Parameters

funcID [in] The identifier of the function that is returning.

Remarks

The FunctionLeave function is a callback; you must implement it. The implementation must use the __declspec(naked) storage-class attribute.

The execution engine does not save any registers before calling this function.

  • On entry, you must save all registers that you use, including those in the floating-point unit (FPU).

  • On exit, you must restore the stack by popping off all the parameters that were pushed by its caller.

The implementation of FunctionLeave should not block because it will delay garbage collection. The implementation should not attempt a garbage collection because the stack may not be in a garbage collection-friendly state. If a garbage collection is attempted, the runtime will block until FunctionLeave returns.

Also, the FunctionLeave function must not call into managed code or in any way cause a managed memory allocation.

Requirements

Platforms: See System Requirements.

Header: CorProf.idl

Library: CorGuids.lib

.NET Framework Versions: 1.1, 1.0

See also