Ant DeviceRequest Data PageT Method
Requests the data page.
Definition
Namespace: SmallEarthTech.AntPlus
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 6.0.4+3bc433b476ad11fc6896cfd0bd783d60504dc315
Status of the request.
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 6.0.4+3bc433b476ad11fc6896cfd0bd783d60504dc315
C#
public Task<MessagingReturnCode> RequestDataPage<T>(
T page,
byte descriptor1 = 255,
byte descriptor2 = 255,
byte transmissionResponse = 4,
CommandType commandType = CommandType.DataPage,
ushort slaveSerialNumber = 65535
)
where T : Enum
VB
Public Function RequestDataPage(Of T As Enum) (
page As T,
Optional descriptor1 As Byte = 255,
Optional descriptor2 As Byte = 255,
Optional transmissionResponse As Byte = 4,
Optional commandType As CommandType = CommandType.DataPage,
Optional slaveSerialNumber As UShort = 65535
) As Task(Of MessagingReturnCode)C++
public:
generic<typename T>
where T : Enum
Task<MessagingReturnCode>^ RequestDataPage(
T page,
unsigned char descriptor1 = 255,
unsigned char descriptor2 = 255,
unsigned char transmissionResponse = 4,
CommandType commandType = CommandType::DataPage,
unsigned short slaveSerialNumber = 65535
)F#
member RequestDataPage :
page : 'T *
?descriptor1 : byte *
?descriptor2 : byte *
?transmissionResponse : byte *
?commandType : CommandType *
?slaveSerialNumber : uint16
(* Defaults:
let _descriptor1 = defaultArg descriptor1 255
let _descriptor2 = defaultArg descriptor2 255
let _transmissionResponse = defaultArg transmissionResponse 4
let _commandType = defaultArg commandType CommandType.DataPage
let _slaveSerialNumber = defaultArg slaveSerialNumber 65535
*)
-> Task<MessagingReturnCode> when 'T : EnumParameters
- page T
- The requested page.
- descriptor1 Byte (Optional)
- The descriptor1. The default is 0xFF.
- descriptor2 Byte (Optional)
- The descriptor2. The default is 0xFF.
- transmissionResponse Byte (Optional)
- The transmission response. The default is to send 4 messages.
- commandType CommandType (Optional)
- Type of the command. The default is DataPage.
- slaveSerialNumber UInt16 (Optional)
- The slave serial number. The default is 0xFFFF.
Type Parameters
- T
- The data page enumeration of the derived ANT device class.
Return Value
TaskMessagingReturnCodeStatus of the request.
Exceptions
| ArgumentException | Invalid data page requested. |