IObex::StartDeviceEnum

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method starts the enumeration of the available devices. This method will only begin if the OBEX object has been advised of the local device.

Syntax

HRESULT StartDeviceEnum();

Parameters

None.

Return Value

This method returns one of the following values.

Return value Description

S_OK

The request was completed successfully.

E_FAIL

The request failed.

OBEX_E_NOT_INITIALIZED

Not initialized.

Remarks

After an OBEX object has been advised of the local device, StartDeviceEnum will notify that device when the OBEX object finds a new device. The information related to this new device will be sent to the local device in the form of a property bag (a list of the device's properties). After the local device has retrieved this property bag from another device, the IObex::BindToDevice method must be used to connect to that device and transfer data.

To stop the enumeration process at any time, use the IObex::StopDeviceEnummethod. After the enumeration process is stopped, call IObex::EnumDevices to retrieve a list of the enumerated devices.

Requirements

Header obex.h, obex.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later

See Also

Reference

IObex:IUnknown
OBEX Interfaces