IObex::StartDeviceEnum (Compact 2013)

3/26/2014

This method starts the enumeration of the available devices. This method will only begin if the Object Exchange (OBEX) Protocol 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 completed successfully.

E_FAIL

The request was unsuccessful.

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::StopDeviceEnum method. 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

See Also

Reference

IObex
OBEX Interfaces