opennetcf.bluetooth.xml

OpenCF Bluetooth OpenNETCF.Bluetooth.Widco

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OpenNETCF.Bluetooth</name>
    </assembly>
    <members>
        <member name="T:OpenNETCF.Bluetooth.DeviceType">
            <summary>
            Types of Bluetooth devices
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.Unknown">
            <summary>
            Unknown type
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.SPP">
            <summary>
            Serial Port Protocol
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.DUN">
            <summary>
            Dial-up Networking
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.LAN">
            <summary>
            Local Area Network
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.PANC">
            <summary>
            Personal Area Network Client
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.DeviceType.PANH">
            <summary>
            Personal Area Network Host
            </summary>
        </member>
        <member name="T:OpenNETCF.Bluetooth.BTConnectError">
            <summary>
            Error codes returned from BTConnect
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.NoError">
            <summary>
            No error
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.SyntaxError">
            <summary>
            Syntax error in call
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.StackNotFound">
            <summary>
            Stack not found
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.DeviceNotFound">
            <summary>
            Device not found
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.ServiceNotAvailable">
            <summary>
            Requested service not available
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.MultipleSPPsAvailable">
            <summary>
            Multiple SPP devices found
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.ConnectionError">
            <summary>
            General connection error
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.ConnectionTimeout">
            <summary>
            Timeout
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.BTConnectError.RadioTurnedOff">
            <summary>
            Radio was turned off during action
            </summary>
        </member>
        <member name="T:OpenNETCF.Bluetooth.Widcomm.BTDeviceDelegate">
            <summary>
            Delegate for device status changes
            </summary>
            <param name="device">affected device</param>
        </member>
        <member name="T:OpenNETCF.Bluetooth.Widcomm.BTErrorDelegate">
            <summary>
            Delegate for Bluetoot errors
            </summary>
            <param name="error">Error</param>
        </member>
        <member name="T:OpenNETCF.Bluetooth.Widcomm.Device">
            <summary>
            Describes a detected Bluetooth device
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.Widcomm.Device.Name">
            <summary>
            The device's friendly name
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.Widcomm.Device.Address">
            <summary>
            The device address
            </summary>
        </member>
        <member name="F:OpenNETCF.Bluetooth.Widcomm.Device.DeviceType">
            <summary>
            The device type
            </summary>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.Device.Connect(System.Int32)">
            <summary>
            Creates a connection with the device
            </summary>
            <param name="timeout">Timout in milliseconds</param>
            <returns>Connection status on call termination</returns>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.Device.Disconnect(System.Int32)">
            <summary>
            Disconnects the device
            </summary>
            <param name="timeout">Timeout in milliseconds</param>
            <returns>Connection status on call termination</returns>
        </member>
        <member name="T:OpenNETCF.Bluetooth.Widcomm.DeviceCollection">
            <summary>
            This class provides a simple managed wrapper for the High-Point Software BTConnect product.
            To use it, it requires that the BTConnect libraries be installed on the target.
            <remarks>This is only for devices with the Widcomm/Broadcom Bluetooth stack</remarks>
            </summary>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.#ctor(System.String)">
            <summary>
            Creates a DeviceCollection instance
            </summary>
            <param name="path">Path to the BTConnect.exe binary</param>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.#ctor">
            <summary>
            Creates a BTConnect instance
            <remarks>This constructor assumes that BTConnect.exe resides in the application folder</remarks>
            </summary>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.Add(OpenNETCF.Bluetooth.Widcomm.Device)">
            <summary>
            Adds a device to the collection only if it's new
            </summary>
            <param name="device"></param>
            <returns></returns>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.Contains(OpenNETCF.Bluetooth.Widcomm.Device)">
            <summary>
            Determines if the DeviceCollection already contains a device with the supplied device's Address
            <remarks>Only the device address is searched</remarks>
            </summary>
            <param name="device">Device to search for in the collection</param>
            <returns></returns>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.Refresh(System.Boolean)">
            <summary>
            Refreshes the current list of NearbyDevices.
            </summary>
            <param name="synchronous">If true, this is a blocking call and the NearbyDevices list is current when it returns</param>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.BeginWatching">
            <summary>
            Begins continuous monitoring for nearby bluetooth devices
            </summary>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.EndWatching">
            <summary>
             Stops monitoring for nearby devices
            </summary>
        </member>
        <member name="M:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.Finalize">
            <summary>
            DeviceCollection finalizer
            </summary>
        </member>
        <member name="E:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.DeviceDetected">
            <summary>
            Raised when a device is detected
            </summary>
        </member>
        <member name="E:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.OnError">
            <summary>
            Raised when an error occurs
            </summary>
        </member>
        <member name="E:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.DeviceLost">
            <summary>
            Raised when a previously detected device is no longer in range
            </summary>
        </member>
        <member name="P:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.Item(System.Int32)">
            <summary>
            Indexer for the DeviceCollection
            </summary>
            <param name="index">Index of Device to affect</param>
            <returns>Device at specified index</returns>
        </member>
        <member name="P:OpenNETCF.Bluetooth.Widcomm.DeviceCollection.SearchTimeout">
            <summary>
            Gets or sets the number of seconds to search for nearby devices.  The default is 10 seconds
            </summary>
        </member>
    </members>
</doc>