|
CallbackForPlayersEventsSet method |
  
|
|
CallbackForPlayersEventsSet method |
|
Remarks
Sets a callback for receiving notification of events generated by instanced players, allowing to synchronize players themselves with the container application.
For further details about callback delegates see the How to synchronize the container application with the API tutorial.
Syntax
[Visual Basic] Public Function CallbackForPlayersEventsSet ( function as CallbackForPlayersEvents ) as enumErrorCodes |
[C#] public enumErrorCodes CallbackForPlayersEventsSet ( CallbackForPlayersEvents function ); |
[C++] public: enumErrorCodes CallbackForPlayersEventsSet ( CallbackForPlayersEvents function ); |
Parameter |
Description |
|
|
function |
Callback function that will receive player related events. Remember that callback functions must be as fast as possible in order to avoid slowing down overall performances. |
when using the API from Unmanaged C++ through COM interaction, where the client application is totally unaware about .NET delegates, you should use the "Ptr" version of the method which allows passing the pointer to the callback function:
[Unmanaged C++] enumErrorCodes CallbackForPlayersEventsSetPtr ( (UINT_PTR) functionPointer ); |
Parameter |
Description |
|
|
functionPointer |
Pointer to the callback function. See the Adding the API to an unmanaged Visual C++ project tutorial for details about usage of the "Ptr" version of these methods. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
