PartyManager::SetProfilingCallbacksForMethodEntryExit

Optionally configures the profiling event callbacks the Party library will make when entering or exiting instrumented methods.

Syntax

PartyError SetProfilingCallbacksForMethodEntryExit(  
    PartyProfilingMethodEntranceCallback profilingMethodEntranceCallback,  
    PartyProfilingMethodExitCallback profilingMethodExitCallback  
)  

Parameters

profilingMethodEntranceCallback   PartyProfilingMethodEntranceCallback
optional

The callback to be made when the Party library enters an internal method which is instrumented for profiling.

profilingMethodExitCallback   PartyProfilingMethodExitCallback
optional

The callback to be made when the Party library is about to exit an internal method which is instrumented for profiling.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

This method allows the title to install custom profiling callback functions in order to record and visualize Party library performance metrics in external profiling tools.

This method can only be called when the Party library is uninitialized. Calling while Party is initialized will fail and return an error.

Setting an optional callback equal to nullptr will cause the Party library to not make any profiling callbacks for that event type.

In order to minimize the impact of profiling on title performance, callbacks for these events should be kept as lightweight as possible, as they are expected to fire hundreds or thousands of times per second.

This method is only supported on the Windows, Xbox One XDK, and Microsoft Game Core versions of the library. Calls on other platforms will fail.

Requirements

Header: Party.h

See also

PartyManager
PartyProfilingMethodEntranceCallback
PartyProfilingMethodExitCallback
PartyManager::GetProfilingCallbacksForMethodEntryExit