wclRfCommClientConnectionConnect(Int64, Guid, Byte, Boolean, Boolean, UInt32) Method |
Connects to a remote device.
Namespace: wclBluetoothAssembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)
Syntax public int Connect(
long Address,
Guid Service,
byte Channel = 0,
bool Authentication = true,
bool Encryption = false,
uint Timeout = 10000
)
Public Function Connect (
Address As Long,
Service As Guid,
Optional Channel As Byte = 0,
Optional Authentication As Boolean = true,
Optional Encryption As Boolean = false,
Optional Timeout As UInteger = 10000
) As Integer
public:
int Connect(
long long Address,
Guid Service,
unsigned char Channel = 0,
bool Authentication = true,
bool Encryption = false,
unsigned int Timeout = 10000
)
Parameters
- Address Int64
- The remote Bluetooth device address.
- Service Guid
- The Bluetooth Service UUID. If the Channel
parameter is zero, the system attempts to use Service to
resolve the remote channel corresponding to the service. The service
class is a normalized 128-bit GUID, defined by the Bluetooth
specification. Common GUIDs are defined by the Bluetooth Assigned
Numbers document. Alternatively, a unique GUID may be used for a
domain-specific application.
- Channel Byte (Optional)
- The RFCOMM channel number. If zero the
Service UUID will be used.
- Authentication Boolean (Optional)
- Specifies that authentication is required
for a connect operation to complete successfully. Setting this option
actively initiates authentication during connection establishment,
if the two Bluetooth devices were not previously
authenticated.
- Encryption Boolean (Optional)
- The option enforces encryption to establish a
connection. Encryption is only available for authenticated
connections.
- Timeout UInt32 (Optional)
- The connect timeout in milliseconds. The
default value is 10000 milliseconds.
Return Value
Int32 If the function succeed the return value is
WCL_E_SUCCESS. Otherwise the method returns one of
the WCL error codes.
Remarks The method starts a connection operation to a remote
device. If the method success that does not mean that the connection
was established. That just means that the connection operation was
started. The real connection result will be passed to the
OnConnect event handler.
NOTE: BlueSoleil does not support Authentication
and Encryption parameters per connection.
See Also