C-DEngine 5.105

TheCommonUtils..::..SleepOneEyeGetCancelToken Method

Creates a cancel token for C-DEngine safe sleep functions.

Namespace:  nsCDEngine.BaseClasses
Assembly:  C-DEngine (in C-DEngine.dll)

Syntax


public static Object SleepOneEyeGetCancelToken()
Public Shared Function SleepOneEyeGetCancelToken As Object
public:
static Object^ SleepOneEyeGetCancelToken()

Return Value

An object for use in various SleepOneEyexxx functions.

Remarks


The cancel token is for use in the following functions: (a) SleepOneEyeWithCancel (b) TaskDelayOneEye (c) TaskWaitTimeout. To set the returned object to a 'signaled' state, call the SleepOneEyeCancel function.