api reference

Wireless Communication Library.NET EditionWCLBLUETOOTHAPI....................................................................................................10 WCLTRANSPORT..........................................................................................................10 WCLAPI...........................................................................................................................10Methods........................................................................................................................................................................10 Load..........................................................................................................................................................................10 Unload......................................................................................................................................................................10 IsBluetoothAPIExists...............................................................................................................................................11 IsTransportExists......................................................................................................................................................11 Properties.....................................................................................................................................................................11 Active.......................................................................................................................................................................11 Version.....................................................................................................................................................................11 Events...........................................................................................................................................................................11 AfterLoad.................................................................................................................................................................11 AfterUnload..............................................................................................................................................................12 OnChanged...............................................................................................................................................................12

WCLBLUETOOTHRADIO...............................................................................................12Methods........................................................................................................................................................................12 GetAddress...............................................................................................................................................................12 GetConnectable........................................................................................................................................................12 GetDiscoverable.......................................................................................................................................................12 GetName..................................................................................................................................................................12 SetConnectable.........................................................................................................................................................13 SetDiscoverable........................................................................................................................................................13 SetName...................................................................................................................................................................13 Assign.......................................................................................................................................................................13 Properties.....................................................................................................................................................................13 API...........................................................................................................................................................................13

WCLBLUETOOTHRADIOS............................................................................................13Methods........................................................................................................................................................................14 Add...........................................................................................................................................................................14 Clear.........................................................................................................................................................................14 Delete.......................................................................................................................................................................14 Assign.......................................................................................................................................................................14 Properties.....................................................................................................................................................................14 Count........................................................................................................................................................................14 Items.........................................................................................................................................................................14

WCLBLUETOOTHSERVICE..........................................................................................15

Methods........................................................................................................................................................................15 Assign.......................................................................................................................................................................15 Properties.....................................................................................................................................................................15 Channel....................................................................................................................................................................15 Comment..................................................................................................................................................................15 Handle......................................................................................................................................................................15 Name........................................................................................................................................................................15 UUID........................................................................................................................................................................16

WCLBLUETOOTHSERVICES........................................................................................16Methods........................................................................................................................................................................16 Add...........................................................................................................................................................................16 Clear.........................................................................................................................................................................16 Delete.......................................................................................................................................................................16 Assign.......................................................................................................................................................................16 Properties.....................................................................................................................................................................17 Count........................................................................................................................................................................17 Items.........................................................................................................................................................................17

WCLBLUETOOTHDEVICE.............................................................................................17Methods........................................................................................................................................................................17 GetClassOfDevice....................................................................................................................................................17 GetName..................................................................................................................................................................17 GetPaired..................................................................................................................................................................17 EnumServices...........................................................................................................................................................18 Pair...........................................................................................................................................................................18 Unpair.......................................................................................................................................................................18 Assign.......................................................................................................................................................................18 DecodeCOD.............................................................................................................................................................18 Properties.....................................................................................................................................................................18 Address.....................................................................................................................................................................18

WCLBLUETOOTHDEVICES..........................................................................................19Methods........................................................................................................................................................................19 Add...........................................................................................................................................................................19 Clear.........................................................................................................................................................................19 Delete.......................................................................................................................................................................19 Assign.......................................................................................................................................................................19 Properties.....................................................................................................................................................................19 Count........................................................................................................................................................................19 Items.........................................................................................................................................................................20

WCLBLUETOOTHDISCOVERY.....................................................................................20Methods........................................................................................................................................................................20 Discovery.................................................................................................................................................................20 EnumRadios.............................................................................................................................................................20 Terminate.................................................................................................................................................................20 Properties.....................................................................................................................................................................20 Active.......................................................................................................................................................................20

Events...........................................................................................................................................................................21 OnDiscoveryComplete.............................................................................................................................................21 OnDiscoveryStarted.................................................................................................................................................21

WCLERRORS.................................................................................................................21 WCLIRDADEVICE..........................................................................................................25Properties.....................................................................................................................................................................25 Name........................................................................................................................................................................25 Address.....................................................................................................................................................................25

WCLIRDADEVICES........................................................................................................25Methods........................................................................................................................................................................25 Add...........................................................................................................................................................................25 Clear.........................................................................................................................................................................25 Delete.......................................................................................................................................................................26 Properties.....................................................................................................................................................................26 Count........................................................................................................................................................................26 Items.........................................................................................................................................................................26

WCLIRDADISCOVERY...................................................................................................26Methods........................................................................................................................................................................26 Discovery.................................................................................................................................................................26 Terminate.................................................................................................................................................................26 Properties.....................................................................................................................................................................27 Active.......................................................................................................................................................................27 Events...........................................................................................................................................................................27 OnComplete.............................................................................................................................................................27 OnStarted..................................................................................................................................................................27

WCLSERIALDEVICE......................................................................................................27Properties.....................................................................................................................................................................27 FriendlyName...........................................................................................................................................................27 Modem.....................................................................................................................................................................28 Port...........................................................................................................................................................................28

WCLSERIALDEVICES....................................................................................................28Methods........................................................................................................................................................................28 Add...........................................................................................................................................................................28 Clear.........................................................................................................................................................................28 Delete.......................................................................................................................................................................28 Properties.....................................................................................................................................................................29 Count........................................................................................................................................................................29 Items.........................................................................................................................................................................29

WCLSERIALDISCOVERY..............................................................................................29Methods........................................................................................................................................................................29

EnumDevices...........................................................................................................................................................29 StartMonitoring........................................................................................................................................................29 Stop Monitoring.......................................................................................................................................................30 Properties.....................................................................................................................................................................30 Monitoring................................................................................................................................................................30 Events...........................................................................................................................................................................30 OnStarted..................................................................................................................................................................30 OnStopped................................................................................................................................................................30 OnFound...................................................................................................................................................................30 OnLost......................................................................................................................................................................30

WCLBUFFERS................................................................................................................31Properties.....................................................................................................................................................................31 ReadBuffer...............................................................................................................................................................31 WriteBuffer..............................................................................................................................................................31

WCLCLIENTBLUETOOTHPARAMS.............................................................................31Properties.....................................................................................................................................................................31 Authentication..........................................................................................................................................................31 Channel....................................................................................................................................................................32 Encryption................................................................................................................................................................32 Address.....................................................................................................................................................................32 Radio........................................................................................................................................................................32 Service......................................................................................................................................................................32

WCLCLIENTIRDAPARAMS...........................................................................................33Properties.....................................................................................................................................................................33 NineWire..................................................................................................................................................................33 Service......................................................................................................................................................................33 Address.....................................................................................................................................................................33

WCLBAUDRATE.............................................................................................................33 WCLBYTESIZE...............................................................................................................34 WCLPARITY....................................................................................................................34 WCLSTOPBITS...............................................................................................................34 WCLCLIENTSERIALPARAMS.......................................................................................34Properties.....................................................................................................................................................................35 BaudRate..................................................................................................................................................................35 BaudRateValue........................................................................................................................................................35 ByteSize...................................................................................................................................................................35 Parity........................................................................................................................................................................35 Port...........................................................................................................................................................................35 StopBits....................................................................................................................................................................36

WCLCLIENTSTATE........................................................................................................36

WCLCLIENTTRANSPORT.............................................................................................36 WCLCLIENT....................................................................................................................36Methods........................................................................................................................................................................36 Write.........................................................................................................................................................................36 Connect....................................................................................................................................................................37 Disconnect................................................................................................................................................................37 Properties.....................................................................................................................................................................37 State..........................................................................................................................................................................37 BluetoothParams......................................................................................................................................................37 Buffers......................................................................................................................................................................37 ConnectTimeout.......................................................................................................................................................37 IrDAParams..............................................................................................................................................................38 SerialParams.............................................................................................................................................................38 Transport..................................................................................................................................................................38 Events...........................................................................................................................................................................38 OnData.....................................................................................................................................................................38 OnConnect................................................................................................................................................................38 OnDisconnect...........................................................................................................................................................39

WCLCLIENTOBEXPARAMS..........................................................................................39Properties.....................................................................................................................................................................39 PacketSize................................................................................................................................................................39 Timeout....................................................................................................................................................................39 Target.......................................................................................................................................................................39 TargetAsString.........................................................................................................................................................40 Who..........................................................................................................................................................................40 WhoAsString............................................................................................................................................................40

WCLFILESYSTEMOBJECTTYPE..................................................................................40 WCLFILESYSTEMOBJECTPERMISSION.....................................................................40 WCLFILESYSTEMOBJECT...........................................................................................41Methods........................................................................................................................................................................41 CheckPermission......................................................................................................................................................41 AddPermission.........................................................................................................................................................41 RemovePermission...................................................................................................................................................41 Properties.....................................................................................................................................................................41 CreateDateTime.......................................................................................................................................................41 ModifyDateTime......................................................................................................................................................42 Name........................................................................................................................................................................42 ObjectType...............................................................................................................................................................42 Size...........................................................................................................................................................................42

WCLFILESYSTEMOBJECTS.........................................................................................42Methods........................................................................................................................................................................42 Add...........................................................................................................................................................................42 Clear.........................................................................................................................................................................43 Delete.......................................................................................................................................................................43

Properties.....................................................................................................................................................................43 Count........................................................................................................................................................................43 Items.........................................................................................................................................................................43

WCLOBEXSTATE...........................................................................................................43 WCLOBEXOPERATION.................................................................................................43 WCLOPPCLIENT............................................................................................................44Methods........................................................................................................................................................................44 Put............................................................................................................................................................................44 Terminate.................................................................................................................................................................44 CloseOBEXSession..................................................................................................................................................44 OpenOBEXSession..................................................................................................................................................44 Disconnect................................................................................................................................................................45 Connect....................................................................................................................................................................45 Get............................................................................................................................................................................45 Properties.....................................................................................................................................................................45 OBEXParams...........................................................................................................................................................45 OBEXState...............................................................................................................................................................45 OBEXOperation.......................................................................................................................................................45 Transport..................................................................................................................................................................46 SerialParams.............................................................................................................................................................46 IrDAParams..............................................................................................................................................................46 ConnectTimeout.......................................................................................................................................................46 Buffers......................................................................................................................................................................46 BluetoothParams......................................................................................................................................................46 State..........................................................................................................................................................................47 Events...........................................................................................................................................................................47 OnConnect................................................................................................................................................................47 OnDisconnect...........................................................................................................................................................47 OnOBEXProgress....................................................................................................................................................47 OnOBEXPutComplete.............................................................................................................................................48 OnOBEXDisconnect................................................................................................................................................48 OnOBEXConnect.....................................................................................................................................................48 OnOBEXGetComplete.............................................................................................................................................48

WCLFTPCLIENT.............................................................................................................49Methods........................................................................................................................................................................49 Put............................................................................................................................................................................49 Terminate.................................................................................................................................................................49 CloseOBEXSession..................................................................................................................................................49 OpenOBEXSession..................................................................................................................................................49 Disconnect................................................................................................................................................................49 Connect....................................................................................................................................................................49 Get............................................................................................................................................................................50 Delete.......................................................................................................................................................................50 Dir............................................................................................................................................................................50 MakeDir...................................................................................................................................................................50 SetPath......................................................................................................................................................................50 Properties.....................................................................................................................................................................50 OBEXParams...........................................................................................................................................................50 OBEXState...............................................................................................................................................................51 OBEXOperation.......................................................................................................................................................51

Transport..................................................................................................................................................................51 SerialParams.............................................................................................................................................................51 IrDAParams..............................................................................................................................................................51 ConnectTimeout.......................................................................................................................................................52 Buffers......................................................................................................................................................................52 BluetoothParams......................................................................................................................................................52 State..........................................................................................................................................................................52 Events...........................................................................................................................................................................52 OnConnect................................................................................................................................................................52 OnDisconnect...........................................................................................................................................................53 OnOBEXProgress....................................................................................................................................................53 OnOBEXPutComplete.............................................................................................................................................53 OnOBEXDisconnect................................................................................................................................................53 OnOBEXConnect.....................................................................................................................................................53 OnOBEXGetComplete.............................................................................................................................................54 OnOBEXDeleteComplete........................................................................................................................................54 OnOBEXDirComplete.............................................................................................................................................54 OnOBEXMakeDirComplete....................................................................................................................................55 OnOBEXSetPathComplete......................................................................................................................................55

WCLAUTHENTICATOR..................................................................................................55Methods........................................................................................................................................................................55 Open.........................................................................................................................................................................55 Close.........................................................................................................................................................................55 Properties.....................................................................................................................................................................56 Active.......................................................................................................................................................................56 Radio........................................................................................................................................................................56 Events...........................................................................................................................................................................56 OnPINRequest..........................................................................................................................................................56

WCLPROXIMITYSENDER..............................................................................................56Methods........................................................................................................................................................................57 Start..........................................................................................................................................................................57 Stop..........................................................................................................................................................................57 Properties.....................................................................................................................................................................57 Timeout....................................................................................................................................................................57 SleepInterval............................................................................................................................................................57 SendDelay................................................................................................................................................................57 Secure.......................................................................................................................................................................58 MaxConnections......................................................................................................................................................58 DiscoveryTimeout....................................................................................................................................................58 SendRadio................................................................................................................................................................58 DiscoveryRadio........................................................................................................................................................58 Active.......................................................................................................................................................................58 Events...........................................................................................................................................................................59 OnStopSleep.............................................................................................................................................................59 OnStopped................................................................................................................................................................59 OnStopDelay............................................................................................................................................................59 OnStartSleep............................................................................................................................................................59 OnStarted..................................................................................................................................................................59 OnStartDeay.............................................................................................................................................................59 OnSendStart.............................................................................................................................................................60 OnSendComplete.....................................................................................................................................................60 OnProgress...............................................................................................................................................................60

OnGetFiles...............................................................................................................................................................60 OnFileSendStarted...................................................................................................................................................61 OnFileSendComplete...............................................................................................................................................61 OnDiscoveryStarted.................................................................................................................................................61 OnDiscoveryComplete.............................................................................................................................................61 OnDevicesFound......................................................................................................................................................62 OnAcceptDevice......................................................................................................................................................62

WCLSERVERTRANSPORT...........................................................................................62 WCLSERVERSTATE......................................................................................................62 WCLSERVERBLUETOOTHPARAMS............................................................................63Properties.....................................................................................................................................................................63 Authentication..........................................................................................................................................................63 Channel....................................................................................................................................................................63 Encryption................................................................................................................................................................63 Radio........................................................................................................................................................................63 Service......................................................................................................................................................................63 Name........................................................................................................................................................................64

WCLSERVERIRDAPARAMS.........................................................................................64Properties.....................................................................................................................................................................64 NineWire..................................................................................................................................................................64 Service......................................................................................................................................................................64

WCLSERVER..................................................................................................................64Methods........................................................................................................................................................................64 Close.........................................................................................................................................................................65 Listen........................................................................................................................................................................65 Write.........................................................................................................................................................................65 Properties.....................................................................................................................................................................65 Address.....................................................................................................................................................................65 DeviceName.............................................................................................................................................................65 State..........................................................................................................................................................................65 BluetoothParams......................................................................................................................................................66 IrDAParams..............................................................................................................................................................66 Transport..................................................................................................................................................................66 Buffers......................................................................................................................................................................66 Events...........................................................................................................................................................................66 OnClosed..................................................................................................................................................................66 OnConnected............................................................................................................................................................67 OnDisconnected.......................................................................................................................................................67 OnListen...................................................................................................................................................................67 OnData.....................................................................................................................................................................67

WCLOPPSERVER..........................................................................................................67Methods........................................................................................................................................................................67 Close.........................................................................................................................................................................68 Listen........................................................................................................................................................................68 Terminate.................................................................................................................................................................68

Properties.....................................................................................................................................................................68 Address.....................................................................................................................................................................68 DeviceName.............................................................................................................................................................68 State..........................................................................................................................................................................68 BluetoothParams......................................................................................................................................................69 IrDAParams..............................................................................................................................................................69 Transport..................................................................................................................................................................69 Buffers......................................................................................................................................................................69 ObjectName..............................................................................................................................................................69 Events...........................................................................................................................................................................69 OnClosed..................................................................................................................................................................70 OnConnected............................................................................................................................................................70 OnDisconnected.......................................................................................................................................................70 OnListen...................................................................................................................................................................70 OnOBEXProgress....................................................................................................................................................70 OnOBEXObjectReceived........................................................................................................................................70

WCLCLASSOFDEVICE..................................................................................................71Miscellaneous...............................................................................................................................................................71 Computers...................................................................................................................................................................71 Phones..........................................................................................................................................................................71 Audio............................................................................................................................................................................71 Peripheral....................................................................................................................................................................72 Imaging........................................................................................................................................................................72 Wearable......................................................................................................................................................................72 Toy................................................................................................................................................................................72 LAN..............................................................................................................................................................................73 Others...........................................................................................................................................................................73

wclBluetoothAPIwclBluetoothAPI enumeration represents supported Bluetooth APIs. baBlueSoleil baMicrosoft baToshiba baWidComm BlueSoleil Bluetooth drivers Microsoft Bluetooth drivers Toshiba Bluetooth drivers WidComm Bluetooth drivers

wclTransportwclTransport enumeration represents supported transports. trActiveSync trBluetooth trIrDA trSerial trUSB trWiFi Microsoft ActiveSync Bluetooth (see wclBluetoothAPIX) IrDA Serial ports USB WiFi

wclAPIwclAPI class is the main class of the library. wclAPI manages low-level transports and drivers. Application uses WCL must have at least one instance of the wclAPI class.

MethodsLoadInt32 Load() This method loads low-level transports and APIs. Application must call this method before using any other methods or classes of the library. If the method completes with success it returns WCL_E_SUCCESS. Otherwise it returns one of the error codes (see wclErrors for more details).

UnloadInt32 Unload() This method unloads low-level transports and APIs. Application must call this method after finished using the library.

If the method completes with success it returns WCL_E_SUCCESS. Otherwise it returns one of the error codes (see wclError for more details).

IsBluetoothAPIExistsBoolean IsBluetoothAPIExists(wclBluetoothAPI API) The method returns true if the specified Bluetooth API was detected and available for use. Otherwise it returns false.

IsTransportExistsBoolean IsTransportExists(wclTransport Transport) The method returns true if specified transport is available.

PropertiesActiveBoolean Active Read-Only The Active property is true if API is loaded, otherwise it is false.

VersionString Version Read-Only The property returns current librarys version.

EventsAfterLoadvoid AfterLoad(object sender, EventArgs e) The event fires after low-level drivers and APIs were loaded and ready.

AfterUnloadvoid AfterUnload(object sender, EventArgs e) The event fires after low-level drivers and APIs were unloaded.

OnChangedvoid OnChanged(object sender, EventArgs e) The event fires when configuration of low-level drivers and/or APIs was changed.

wclBluetoothRadioThe wclBluetoothRadio class represents local Bluetooth radio module (dongle).

MethodsGetAddressInt32 GetAddress(ref String Address) The method reads address of the local dongle and stores it into the Address parameter. If the method completes with success it returns WCL_E_SUCCESS. Otherwise it returns one of the error codes and Address parameter is undefined.

GetConnectableInt32 GetConnectable(ref Boolean Connectable) The method reads connectable state of the dongle and stores it into the Connectable parameter. If the method completes with success it returns WCL_E_SUCCESS.

GetDiscoverableInt32 GetDiscoverable(ref Boolean Discoverable) The method reads discoverable state of the dongle and stores it into the Discoverable parameter. If the method completes with success it returns WCL_E_SUCCESS.

GetNameInt32 GetName(ref String Name)

The method reads name of the local dongle and stores it into the Name parameter. If the method completes with success it returns WCL_E_SUCCESS.

SetConnectableInt32 SetConnectable(Boolean Connectable) The method sets a connectable state of the dongle. If the method completes with success it returns WCL_E_SUCCESS.

SetDiscoverableInt32 SetDiscoverable(Boolean Discoverable) The method sets discoverable mode of the dongle. If the method completes with success it returns WCL_E_SUCCESS.

SetNameInt32 SetName(String Name) The method sets the name of the dongle. If the method completes with success it returns WCL_E_SUCCESS.

Assignvoid Assign(wclBluetoothRadio Radio) The method copies one instance of the wclBluetoothRadio object into current one.

PropertiesAPIwclBluetoothAPI API Read-Write The property manages the drivers (Bluetooth API) used by the dongle.

wclBluetoothRadiosThe wclBluetoothRadios class represents list of local Bluetooth dongles.

MethodsAddvoid Add(wclBluetoothRadio Radio) The method adds Radio object to the list.

Clearvoid Clear() The method clears the list.

Deletevoid Delete(UInt32 Index) The method deletes the radio with given Index from the list.

Assignvoid Assign(wclBluetoothRadios Radios) The method copies one instance of the wclBluetoothRadios object into current one.

PropertiesCountUInt32 Count Read-Only The property returns the number of radios in the list.

ItemswclBluetoothRadio default[UInt32 Index] Read-Only The property returns Radio object by its Index.

wclBluetoothServiceThe class represents Bluetooth service.

MethodsAssignvoid Assign(wclBluetoothService Service) The method copies one instance of the wclBluetoothService into current one.

PropertiesChannelunsigned Byte Channel Read-Only The property contains the services RFCOMM channel number. Not all services have RFCOMM channel number.

CommentString Comment Read-Only The property contains the services comments. Usually it is empty.

HandleUInt32 Handle Read-Only The property contains services service record handle.

NameString Name

Read-Only The property contains the services name.

UUIDGuid UUID Read-Only The property contains the services UUID.

wclBluetoothServicesThe class represents a list of Bluetooth services.

MethodsAddvoid Add(wclBluetoothService Service) The method adds a service object to the list.


Deletevoid Delete(UInt32 Index) The method deletes a service object with given Index from the list.

Assignvoid Assign(wclBluetoothServices Services) The method copies one instance of the wclBluetoothServices class into the current one.

PropertiesCountUInt32 Count Read-Only The property returns items count in the list.

ItemswclBluetoothService default[UInt32 Index] Read-Only The property returns a wclBluetoothService object from the list by its Index.

wclBluetoothDeviceThe class represents a remote Bluetooth device.

MethodsGetClassOfDeviceInt32 GetClassOfDevice(wclBluetoothRadio Radio, ref UInt32 COD) The method reads Class Of remote Device (COD). The operation will perform on the specified Radio. If the method completes with success it returns WCL_E_SUCCESS.

GetNameInt32 GetName(wclBluetoothRadio Radio, ref String Name) The method reads the name of the remote device with using specified Radio. If the method completes with success it returns WCL_E_SUCCESS.

GetPairedInt32 GetPaired(wclBluetoothRadio Radio, ref Boolean Paired) The method checks if the remote Bluetooth device is paired with local Bluetooth Radio.

EnumServicesInt32 EnumServices(wclBluetoothRadio Radio, wclBluetoothServices Services, Guid UUID) The method enumerates services on the remote device with using specified Radio. The Services parameter must be a valid wclBluetoothServices object. The method fills it with services list. If the UUID parameter is null the method enumerates all services. If the UUID parameter is a services UUID the method enumerates (checks) only specified service. The method can be used for checking availability of the remote device by querying its services.

PairInt32 Pair(wclBluetoothRadio Radio, String PIN) The method pairs local Bluetooth Radio with the remote device using specified PIN.

UnpairInt32 Unpair(wclBluetoothRadio Radio) The method unpairs the local Bluetooth Radio and the remote device.

Assignvoid Assign(wclBluetoothDevice Device) The method copies one instance of the wclBluetoothDevice object into the current one.

DecodeCODwclClassOfDevice DecodeCOD(UInt32 COD) The method decodes COD to readable format.

PropertiesAddressString Address Read-Write

The property contains an address of the remote device.

wclBluetoothDevicesThe class represents a list of remote Bluetooth devices.

MethodsAddvoid Add(wclBluetoothDevice Device) The method adds a wclBluetoothDevice object to the list.


Deletevoid Delete(UInt32 Index) The method deletes a wclBluetoothDevice object from the list by its Index.

Assignvoid Assign(wclBluetoothDevices Devices) The method copies one instance of the wclBluetoothDevices class into the current one.


ItemswclBluetoothDevice default[UInt32 Index] Read-Only The property returns a wclBluetoothDevice object from the list by its Index.

wclBluetoothDiscoveryThe class allows your application to enumerate (discover) remote Bluetooth devices.

MethodsDiscoveryInt32 Discovery(wclBluetoothRadio Radio, unsigned Byte Timeout) The method starts discovering for remote Bluetooth devices on the given local Bluetooth radio module. The Timeout parameter indicates how long discovering should execute.

EnumRadiosInt32 EnumRadios(wclBluetoothRadios Radios) The method enumerates installed dongles and fills the Radios parameter. The Radios parameter must be valid wclBluetoothRadios object.

TerminateInt32 Terminate() The method terminates discovering procedure.

PropertiesActiveBoolean Active Read-Only The property returns true if discovering is active.

EventsOnDiscoveryCompletepublic class wclBluetoothDiscoveryCompleteEventArgs : public EventArgs { public wclBluetoothRadio Radio; public wclBluetoothDevices Devices; } void OnDiscoveryComplete(object sender, wclBluetoothDiscoveryCompleteEventArgs e) The event fires when discovering for remote devices is completed. The Radio parameter is the wclBluetoothRadio object indicates a dongle on which discovering was performed. If the discovering was complete with success the Devices parameter is a valid wclBluetoothDevices object contains a list of founded devices. If the discovering wad done with error the Devices parameter is null.

OnDiscoveryStartedpublic class wclBluetoothDiscoveryStartedEventArgs : public EventArgs { public wclBluetoothRadio Radio; } void OnDiscoveryStarted(object sender, wclBluetoothDiscoveryStartedEventArgs e) The event fires when discovering for remote devices is started. The Radio parameter represents a dongle on which the discovering is executing.

wclErrorsThe class contains all possible error codes: Constant WCL_E_SUCCESS WCL_E_OUT_OF_RESOURCE WCL_E_INTERNAL WCL_E_NOT_IMPLEMENTED WCL_E_FEATURE_NOT_SUPPORTED WCL_E_INVALID_ARGUMENT Value 0 1 2 3 4 5 Description Operation complete success Out of system resources Low-level driver internal error Feature is not implemented yet Feature is not supported Invalid argument

WCL_E_API_LOADED WCL_E_API_EXIST WCL_E_API_NOT_LOADED WCL_E_TRANSPORT_NOT_AVAILABLE WCL_E_BLUETOOTH_API_NOT_AVAILABLE

10 11 12 13 14

Transports and APIs is already loaded Other instance of the wclAPIX already exists and is loaded Transports and APIs is not loaded Specified transport is not available Specified Bluetooth API is not available Discovery operation was not started when the application called Terminate method Discovery operation is active Device already paired Authentication failed Operation was cancelled by remote device or remote devices user Access denied by remote device There is no active connection to the remote device Connection is active Connection already exists Time out Specified service was not found on target device or is not supported Unable to connect to remote device. Unknown internal error in low-level driver Remote device rejected the connection request Connection was closed by remote device during OBEX operation (device is out

WCL_E_DISCOVERY_NOT_STARTED WCL_E_DISCOVERY_ACTIVE WCL_E_ALREADY_PAIRED WCL_E_AUTHENTICATION_FAILED WCL_E_CANCELLED_BY_USER WCL_E_ACCESS_DENIED

20 21 30 31 32 33

WCL_E_NOT_CONNECTED WCL_E_CONNECTION_ACTIVE WCL_E_CONNECTION_EXISTS WCL_E_TIMEOUT WCL_E_SERVICE_NOT_FOUND

40 41 42 43 44

WCL_E_UNABLE_CONNECT WCL_E_CONNECTION_REJECTED WCL_E_CONNECTION_TERMINATED

45 46 47

of range or turned off) WCL_E_OBEX_ACTIVE WCL_E_OBEX_OPERATION_IN_PROGRESS WCL_E_OBEX_NOT_ACTIVE WCL_E_OBEX_NO_CONTENT WCL_E_OBEX_OPERATION_NOT_ACTIVE WCL_E_OBEX_RESET_CONTENT WCL_E_OBEX_NON_AUTHORITATIVE WCL_E_OBEX_PARTIAL_CONTENT WCL_E_OBEX_MULTIPLE_CHOISES WCL_E_OBEX_MOVED_PERMANENTLY WCL_E_OBEX_MOVED_TEMPORARY WCL_E_OBEX_SEE_OTHER WCL_E_OBEX_NOT_MODIFIED WCL_E_OBEX_USE_PROXY WCL_E_OBEX_BAD_REQUEST WCL_E_OBEX_UNAUTHORIZED WCL_E_OBEX_PAYMENT_REQUIRED WCL_E_OBEX_FORBIDDEN WCL_E_OBEX_NOT_FOUND WCL_E_OBEX_METHOD_NOT_ALLOWED WCL_E_OBEX_NOT_ACCEPTABLE WCL_E_OBEX_PROXY_AUTHENTICATION_REQUIRED WCL_E_OBEX_REQUEST_TIME_OUT WCL_E_OBEX_CONFLICT WCL_E_OBEX_GONE WCL_E_OBEX_LENGTH_REQUIRED WCL_E_OBEX_PRECONDITION_FAILED WCL_E_OBEX_REQUIESTED_ENTITY_TOO_LARGE WCL_E_OBEX_REQUEST_URL_TOO_LARGE WCL_E_OBEX_UNSUPPORTED_MEDIA_TYPE WCL_E_OBEX_INTERNAL_SERVER_ERROR WCL_E_OBEX_NOT_IMPLEMENTED WCL_E_OBEX_BAD_GATEWAY WCL_E_OBEX_SERVICES_UNAVAILABLE WCL_E_OBEX_GATEWAY_TIME_OUT WCL_E_OBEX_HTTP_VERSION_NOT_SUPPORTED WCL_E_OBEX_DATABASE_FULL WCL_E_OBEX_DATABASE_LOCKED WCL_E_OBEX_UNKNOWN 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 199 There is no active OBEX operation OBEX session already established OBEX operation is in progress, unable to start other OBEX operation OBEX session was not established

WCL_E_AUTHENTICATOR_ACTIVE WCL_E_AUTH_UNABLE_REGISTER_CALLBACK WCL_E_USB_MONITOR_ACTIVE WCL_E_PROXIMITY_SENDER_ACTIVE

200 201 300 400

wclAuthenticatorX component is already opened for specified API Unable setup PIN request handler USB Monitor is already active Proximity Sender is running Other instance of the wclProximitySenderX component is already running on the same radio Send Radio was not specified Discovery Radio was not specified The specified file is not available or Proximity Sender cannt read the file General error while executing AT command Unknown response on AT command Other AT command is executing WiFi Manager is already active (Opened) WiFi Manager is not active (Opened) Other instance of the wclWiFiManager is already active WiFi Manager was not found Operation was completed with success but no data was returned Unable to set callback function for WiFi notifications

WCL_E_PROXIMITY_SENDER_RUNNING

401

WCL_E_PROXIMITY_INVALID_SEND_RADIO WCL_E_PROXIMITY_INVALID_DISCOVERY_RADIO WCL_E_PROXIMITY_FILE_UNAVAILABLE

402 403 404

WCL_E_GSM_ERROR_EXECUTE_AT_COMMAND WCL_E_GSM_UNKNOWN_AT_RESULT WCL_E_GSM_OPERATION_IN_PROGRESS

500 501 502

WCL_E_WIFI_MANAGER_ACTIVE WCL_E_WIFI_MANAGER_NOT_ACTIVE WCL_E_WIFI_MANAGER_EXISTS WCL_E_WIFI_MANAGER_NOT_FOUND WCL_E_WIFI_NO_DATA

600 601 602 603 604

WCL_E_WIFI_UNABLE_SET_CALLBACK

605

WCL_E_MONITORING_ACTIVE

700

Monitoring for serial devices is already started

wclIrDADeviceThe class represents an IrDA device.

PropertiesNameString Name Read-Only The property contains the name of an IrDA device.

AddressString Address Read-Only The property contains the address of an IrDA device.

wclIrDADevicesThe class represents a list of IrDA devices.

MethodsAddvoid Add(wclIrDADevice Device) The method adds Device to the list.

Clearvoid Clear()

The method clears the list.

Deletevoid Delete(UInt32 Index) The method deletes a device from the list by its Index.


ItemswclIrDADevice default[UInt32 Index] Read-Only The property returns wclIrDADevice object from the list by its Index.

wclIrDADiscoveryThe class allows your application to discover IrDA devices.

MethodsDiscoveryInt32 Discovery() The method starts discovering for IrDA devices.

TerminateInt32 Terminate()

The method terminates discovering for IrDA devices.

PropertiesActiveBoolean Active Read-Only The property returns true if discovering is executing.

EventsOnCompletepublic class wclIrDACompleteEventArgs : public EventArgs { public wclIrDADevices Devices; } void OnComplete(object sender, wclIrDACompleteEventArgs e) The event fires when discovering is completed. The Devices parameter is a valid wclIrDADevices list with founded devices. If the method completes with error then Devices parameter is null.

OnStartedvoid OnStarted(object sender, EventArgs e) The event fires when discovering was started.

wclSerialDeviceThe class represents serial port.

PropertiesFriendlyName

String FriendlyName Read-Only The property returns a serial port friendly name (as it shown in Device Manager)

ModemBoolean Modem Read-Only The property returns true if this serial port is associated with modem.

PortUInt32 Port Read-Only The property returns a serial port number.

wclSerialDevicesThe class represents a list of serial ports.

MethodsAddvoid Add(wclSerialDevice Device) The method adds a device to the list.


Deletevoid Delete(UInt32 Index)

The method deletes a device from the list by its Index.

PropertiesCountUInt32 Count Read-Only The property returns devices count in the list.

ItemswclSerialDevice default[UInt32 Index] Read-Only The property returns a device from the list by its index.

wclSerialDiscoveryThe class enumerates serial ports on PC.

MethodsEnumDevicesInt32 EnumDevices(wclSerialDevices Devices) The method enumerates serial ports and fills the Devices list with wclSerialDevice objects. The Devices parameter must be a valid wclSerialDevices object. If the method completes with success it returns WCL_E_SUCCESS.

StartMonitoringInt32 StartMonitoring() The method starts monitoring for serial devices.

Stop Monitoringvoid StopMonitoring() The method stops monitoring for serial devices.

PropertiesMonitoringBoolen Monitoring Read-Only Returns True if monitoring is active.

EventsOnStartedvoid OnStarted(object sender, EventHandler e) The event fires when monitoring is started.

OnStoppedvoid OnStopped(object sender, EventHandler e) The event fires when monitoring is stopped.

OnFoundpublic class wclSerialDeviceEventArgs public EventArgs { public: wclSerialDevice Device; }; void OnFound(object sender, wclSerialDeviceEventArgs e) The event fires when new serial device is found.

OnLost

public class wclSerialDeviceEventArgs public EventArgs { public: wclSerialDevice Device; }; void OnLost(object sender, wclSerialDeviceEventArgs e) The event fires when old serial device is lost.

wclBuffersThe class represents read and write buffers used for communication. Application must never create object of this class and must never dispose objects of this class returned by reading properties of other classes.

PropertiesReadBufferUInt32 ReadBuffer Read-Write The property manages a size of a read buffer size.

WriteBufferUInt32 WriteBuffer Read-Write The property manages a size of a write buffer.

wclClientBluetoothParamsThis class manages parameters for a Bluetooth client connection. Application must never create this class directly.

PropertiesAuthentication

Boolean Authentication Read-Write This property sets authentication mode for the connection. If Authentication is true then connection will require pairing.

ChannelByte Channel Read-Write The property manages the RFCOMM channel number. If it is 0 then component will detect channel automatically by using services UUID. If a target device has more than 1 service with the same UUID you must provide correct channel number to avoid conflict.

EncryptionBoolean Encryption Read-Write The property manages connection data encryption.

AddressString Address Read-Write The property contains a remote devices address to connect to.

RadiowclBluetoothRadio Radio Read-Write The property contains Radio object used for establish a connection to a target device. Application must provide correct Radio.

Service

Guid Service Read-Write The services UUID in String representation. A client will connect to specified service.

wclClientIrDAParamsThe class contains parameters for a IrDA client connection. Application must never create this class directly.

PropertiesNineWireBoolean NineWire Read-Write The property manages NineWire mode for IrDA connection.

ServiceString Service Read-Write The property contains a IrDA services name.

AddressString Address Read-Write The property contains an address of a remote IrDA device to connect to.

wclBaudRateThis enumeration represents a serial port baud rate. br110 br300 br600 110 baud 300 baud 600 baud

br1200 br2400 br4800 br9600 br14400 br19200 br38400 br56000 br57600 br115200 br128000 br256000 brCustom

1200 baud 2400 baud 4800 baud 9600 baud 14400 baud 19200 baud 38400 baud 56000 baud 57600 baud 115200 baud 128000 baud 256000 baud Custom baud rate (see wclClientSerialParams.BaudRateValue property)

wclByteSizeThe enumeration represents a serial port Bytes size. bs4 bs5 bs6 bs7 bs8 4 bits 5 bits 6 bits 7 bits 8 bits

wclParityThe enumeration represents a serial ports parity. paNone paOdd paEven paMark paSpace None Odd Even Mark Space

wclStopBitsThe enumeration represents a serial ports stop bits. sb1 sb15 sb2 1 stop bit 1.5 stop bit 2 stop bits

wclClientSerialParams

The class manages parameters for serial client connection. Application must never create this class directly.

PropertiesBaudRatewclBaudRate BaudRate Read-Write The property manages a serial connection baud rate.

BaudRateValueUInt32 BaudRateValue Read-Write The property manages a serial client connection baud rate. The property indicates actual baud rate. If the BaudRate property set to predefined baud rate (except brCustom) then this property contains its value (for example: BaudRate = br115200, BaudRateValue = 115200). If this property contains non standard baud rate, the BaudRate property contains brCustom.

ByteSizewclByteSize ByteSize Read-Write The property manages a serial client connection Byte size.

ParitywclParity Parity Read-Write The property manages serial client connection parity.

PortUInt32 Port Read-Write

The property manages a serial port number used for connection.

StopBitswclStopBits StopBits Read-Write The property manages a serial port stop bits.

wclClientStateThe enumeration represents a client connection state. csDisconnected csConnecting csConnected csDisconnecting Client is disconnected Client is connecting to a remote device Client is connected Client is disconnecting from remote device

wclClientTransportThe enumeration represents a transport used by a client connection. ctBluetooth ctIrDA ctSerial Bluetooth client connection IrDA client connection Serial client connection

wclClientThe class implements a simple client connection.

MethodsWriteInt32 Write(Byte[] Buffer, UInt32 Size) The method writes data (array of Byte) stored in Buffer parameter to a connection. If the method completes with success it returns WCL_E_SUCCESS.

ConnectInt32 Connect() The method connects to a remote device with using specified transport.

Disconnectvoid Disconnect() The method disconnects from a remote device.

PropertiesStatewclClientState State Read-Only The property contains a clients connection state.

BluetoothParamswclClientBluetoothParams BluetoothParams Read-Only The property contains a wclClientBluetoothParams object which manages properties for Bluetooth connection.

BufferswclBuffers Buffers Read-Only The property manages a read and a write buffers used for a data communication.

ConnectTimeoutUInt32 ConnectTimeout Read-Write

The property manages a connect timeout value (in milliseconds).

IrDAParamswclClientIrDAParams IrDAParams Read-Only The property manages IrDA parameters for a connection.

SerialParamswclClientSerialParams SerialParams Read-Only The property manages serial port parameters for a client connection.

TransportwclClientTransport Transport Read-Write The property manages a transport used for connection.

EventsOnDatapublic class wclDataEventArgs : public EventArgs { public Byte[] Data; public UInt32 Size; } void OnData(object sender, wclDataEventArgs e) The event fires when data received from remote device. The Buffer parameter is a one dimension array of Byte.

OnConnectpublic class wclConnectEventArgs : public EventArgs {

public Int32 Error; } void OnConnect(object sender, wclConnectEventArgs e) The event fires when connect to a remote device is established. The Error parameter is WCL_E_SUCCESS if connection established with success or an error code if connection was not established.

OnDisconnectvoid OnDisconnect(object sender, EventArgs e) The event fires when remote device disconnects or after call of Disconnect() method.

wclClientOBEXParamsThe class represents parameters for OBEX based clients. Application must never create this class directly.

PropertiesPacketSizeUInt16 PacketSize Read-Write The property manages the OBEX packet size used on PC side.

TimeoutUInt32 Timeout Read-Write The property manages timeout for OpenOBEXSession() and Put() operations in milliseconds.

TargetString Target Read-Write

The property manages the OBEX TARGET attribute. It may be encoded in two ways: the first way to use any String to identify the TARGET. The second way is to use GUID. How the component will use this value depends on TargetAsString property.

TargetAsStringBoolean TargetAsString Read-Write If the property is True then the Target property is a simple String. If the property is False then the Target property is a String representation of GUID.

WhoString Who Read-Write The property manages OBEX WHO attribute. It usage depends on WhoAsString propertys value.

WhoAsStringBoolean WhoAsString Read-Write If the property is True then the Who property is a simple String. If the property is False then the Who property is a String representation of GUID.

wclFileSys

api reference

Documents

wireless communication