Class TFindHandleBase

TFindHandleBase

Support

Supported from 5.0

Description

Base class for searching for global Kernel objects.

This is the base class for a number of classes which are used to find specific types of global Kernel object such as semaphores, threads and mutexes; TFindSemaphore, TFindThread and TFindMutex are typical examples of such derived classes.

The class implements the common behaviour, specifically, the storage of the match pattern which is used to search for object names.

This class is not intended to be explicitly instantiated; it has public constructors but they are part of the class implementation and are described for information only.

Defined in TFindHandleBase:
Find(), Handle(), TFindHandleBase()

TFindHandleBase();

Description

Default C++ constructor.

The default constructed TFindHandleBase object has the default match pattern — the single character “*”.

TFindHandleBase(const TDesC& aMatch);

Description

C++ constructor with match pattern.

This constructor creates a TFindHandleBase object with the specified match pattern.

Parameters

const TDesC& aMatch A reference to the descriptor containing the match pattern.

void Find(const TDesC& aMatch);

Description

Sets a new match pattern.

On return from this function, this TFindHandleBase object contains a copy of the supplied match pattern; the source descriptor can, therefore, be safely discarded.

Parameters

const TDesC& aMatch A reference to the descriptor containing the new match pattern.

TInt Handle() const;

Description

Gets the find-handle number associated with the Kernel object. The find-handle number identifies the Kernel object with respect to its container.

Notes:

• Setting the find-handle number into a TFindHandleBase object is not implemented by this class; it is implemented by derived classes, typically by their Next() member functions. The class TFindSemaphore is a good example.

• Although public, this function is part of the class implementation.

Return value

TInt The find-handle number