Class CBTRegistryResponse

class CBTRegistryResponse : public CActive;

Description

Retrieves a set of results from the Registry.

This is a helper class that retrieves a set of results as a view from the registry.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CBTRegistryResponse - Retrieves a set of results from the Registry

Members

Defined in CBTRegistryResponse:
DoCancel(), NewL(), Results(), RunError(), RunL(), Start(), ~CBTRegistryResponse()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

static IMPORT_C CBTRegistryResponse *NewL(RBTRegistry &aView);

Description

Parameters

RBTRegistry &aView

Return value

CBTRegistryResponse *

IMPORT_C ~CBTRegistryResponse();

Description

Destructor

IMPORT_C void Start(TRequestStatus &aClientStatus);

Description

Parameters

TRequestStatus &aClientStatus

IMPORT_C RBTDeviceArray &Results();

Description

Return value

RBTDeviceArray & reference to the array of results

private: virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

private: virtual TInt RunError(TInt aError);

Description

Parameters

TInt aError

Return value

TInt

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().