FX3ConnectionPulseWait Method |
This function waits for a pin to reach a specified level
Namespace:
FX3Api
Assembly:
FX3Api (in FX3Api.dll) Version: 2.9.4.0 (2.9.4)
Syntaxpublic double PulseWait(
IPinObject pin,
uint polarity,
uint delayInMs,
uint timeoutInMs
)
Public Function PulseWait (
pin As IPinObject,
polarity As UInteger,
delayInMs As UInteger,
timeoutInMs As UInteger
) As Double
public:
virtual double PulseWait(
IPinObject^ pin,
unsigned int polarity,
unsigned int delayInMs,
unsigned int timeoutInMs
) sealed
abstract PulseWait :
pin : IPinObject *
polarity : uint32 *
delayInMs : uint32 *
timeoutInMs : uint32 -> float
override PulseWait :
pin : IPinObject *
polarity : uint32 *
delayInMs : uint32 *
timeoutInMs : uint32 -> float
Parameters
- pin
- Type: IPinObject
The pin to poll - polarity
- Type: SystemUInt32
The level to wait for. 1 - high, 0 - low - delayInMs
- Type: SystemUInt32
The delay from the start of the function call to when the pin polling starts - timeoutInMs
- Type: SystemUInt32
The timeout from when the pin polling starts to when the function returns, if the desired level is never reached
Return Value
Type:
DoubleThe total time waited (including delay) in ms
Implements
IPinFcns.PulseWait(IPinObject, UInt32, UInt32, UInt32)
See Also