CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriErrorNotifier Class Reference

Gets error log for CRIWARE native libraries More...

Public Member Functions

delegate void Callback (string message)
 Error callback delegate More...
 

Static Public Member Functions

static bool IsRegistered (Callback target)
 Check for registered error callback events More...
 
static void CallEvent (string message)
 Plug-in internal functions More...
 
static void SetCallbackNative (IntPtr errorCallback)
 Register a native error callback function (using a function pointer) More...
 

Properties

static Callback OnCallbackThreadUnsafe
 Error callback event More...
 

Detailed Description

Gets error log for CRIWARE native libraries

Description:
This class obtains the error logs generated within the CRIWARE native library.

Member Function Documentation

delegate void Callback ( string  message)

Error callback delegate

Description:
A callback delegate that will be called when an error occurs in the CRIWARE native library.
The argument string contains the message in the format "Error ID: Error details".
See also
CriErrorNotifier::OnCallbackThreadUnsafe
static bool IsRegistered ( Callback  target)
inlinestatic

Check for registered error callback events

Parameters
targetMethod to be evaluated
Returns
Whether it is registered
Description:
Checks whether the specified method is registered in CriErrorNotifier.OnCallbackThreadUnsafe.
Use this to avoid duplicate registrations, and to ensure that everything has been properly released.
See also
CriErrorNotifier::Callback, CriErrorNotifier::OnCallbackThreadUnsafe
static void CallEvent ( string  message)
inlinestatic

Plug-in internal functions

This function is not designed to be called by the user.

static void SetCallbackNative ( IntPtr  errorCallback)
inlinestatic

Register a native error callback function (using a function pointer)

Parameters
errorCallbackError callback function pointer
Description:
You can set the native function pointer to be called when an error callback occurs.
Use this only when you need to register a custom native function pointer.
Note:
Specify “IntPtr.Zero” to unregister to the native of the error callback.

Once this function is called, the “event” registered in OnCallbackThreadUnsafe
will no longer be called.

Property Documentation

Callback OnCallbackThreadUnsafe
staticaddremove

Error callback event

Description:
Callback event triggered when an error occurs in the CRIWARE native library.
If it is not set, no log is output.
Note:
This event may be called from outside the main thread.
Therefore, be sure to register a thread-safe API for this event.
See also
CriErrorNotifier::IsRegistered

The documentation for this class was generated from the following file: