DioGetPwmPulsePhase

Function

Retrieves the PWM pulse phase for the specified channel.

Format

Ret = DioGetPwmPulsePhase( Id , ChNo , ChNum , PulsePhase )

Parameters

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

ChNo [ VB.NET: Short ] [ C, C++: short * ] [ C#: out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
Specify the start address of the array that stores the channel numbers to get setting.

ChNum [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the number of channels specified in ChNo.

PulsePhase [ VB.NET: Short ] [ C, C++: short * ] [ C#: out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
Specify the start address of the array that stores the PWM pulse phase settings.

Definition

Value

[Dec]

Description

DIO_PWM_PULSE_PHASE_SHIFT_0_DEGREES

0

0 degrees

DIO_PWM_PULSE_PHASE_SHIFT_90_DEGREES

90

90 degrees

DIO_PWM_PULSE_PHASE_SHIFT_180_DEGREES

180

180 degrees

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.

DIO_ERR_DLL_CALL_DRIVER

10002

Not call the driver (Failure on DEVICE I/O CONTROL).

DIO_ERR_DLL_BUFF_ADDRESS

10100

Invalid data buffer address.

DIO_ERR_SYS_NOT_SUPPORTED

20001

This board couldn't use this function.

DIO_ERR_SYS_CH_NO

20105

Channel No. is outside the setting range.

DIO_ERR_SYS_CH_NUM

20106

Channel number is outside the setting range.

DIO_ERR_SYS_DEVICE_ERR_DRIVER_IC_ERR

21200

Driver IC error occurred.

DIO_ERR_SYS_DEVICE_ERR_PCOM_FAILURE

21201

PCOM power failure occurred.

The others (See also: Details of Error Code)

Initial Value

0 degrees

Remarks

Retrieves the PWM pulse phase for the specified channel.

Example

Retrieves the PWM pulse phase for channels 0 and 1.

VB.NET

Dim Ret As Integer
Dim ChNo(1) As Short
Dim PulsePhase(1) As Short

ChNo(0) = 0
ChNo(1) = 1
Ret = DioGetPwmPulsePhase( Id , ChNo , 2 , PulsePhase )
 

C, C++

long Ret;
short ChNo[2];
short PulsePhase[2];

ChNo[0] = 0;
ChNo[1] = 1;
Ret = DioGetPwmPulsePhase( Id , &ChNo[0] , 2 , &PulsePhase[0] );
 

C#

int Ret;
short[] ChNo = new short[2];
short[] PulsePhase = new short[2];

ChNo[0] = 0;
ChNo[1] = 1;
Ret = dio.GetPwmPulsePhase( Id , out ChNo , 2 , out PulsePhase );
 

Python

Ret = ctypes.c_long()
ChNoType = ctypes.c_short * 2
ChNo = ChNoType()
PulsePhaseType = ctypes.c_short * 2
PulsePhase = PulsePhaseType()

ChNo[0] = 0
ChNo[1] = 1
Ret.value = cdio.DioGetPwmPulsePhase( Id , ChNo , 2 , PulsePhase )
 

See Also

DioSetPwmPulsePhase