DioGetPatternEventStatus


Function

The state of the event of the failsafe function is acquired.

Format

Ret = DioGetPatternEventStatus ( Id , Status )

Parameters

Id [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved from DioInit.

Status [ VB.NET: Short ] [ C, C++: short * ] [ C#: out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
The state value of the event operation is returned.

Value

[Dec]

Description

0

The event has not been generated.

1

The event was generated.

Return Value

Ret [ VB.NET: Integer ] [ C, C++: long ] [ C#: int ] [ Python: ctypes.c_long ]

Definition

Value

[Dec]

Description

DIO_ERR_SUCCESS

0

Normal completed.

DIO_ERR_SYS_RECOVERED_FROM_STANDBY

7

Execute DioResetDevice function because the device has recovered from standby mode.

DIO_ERR_DLL_INVALID_ID

10001

Invalid ID specified.

The others (See also: Details of Error Code)

Initial Value

None

Remarks

The state of the event operation of the failsafe function is acquired.

Example

Get state of the event of the failsafe function.

VB.NET

Dim Ret As Integer
Dim Status As Short
Ret = DioGetPatternEventStatus ( Id , Status )
 

C, C++

long Ret;
short Status;
Ret = DioGetPatternEventStatus ( Id , &Status );
 

C#

int Ret;
short Status;
Ret = dio.GetPatternEventStatus ( Id , out Status );
 

Python

Ret = ctypes.c_long()
Status = ctypes.c_short()
Ret.value = cdio.DioGetPatternEventStatus ( Id , ctypes.byref(Status) )
 

See Also

DioResetPatternEvent