Class TFindSemaphore

class TFindSemaphore : public TFindHandleBase;

Description

Finds all global semaphores whose full names match a specified pattern.

The match pattern can be set into the TFindSemaphore object at construction; it can also be changed at any time after construction by using the TFindHandleBase::Find(const TDesC &) member function of the TFindHandleBase base class.

After construction, the TFindSemaphore::Next(TFullName &) member function can be used repeatedly to find successive global semaphores whose full names match the current pattern.

A successful call to TFindSemaphore::Next(TFullName &) means that a matching global semaphore has been found. To open a handle on this semaphore, call the RSemaphore::Open(const TFindSemaphore &,TOwnerType) function and pass a reference to this TFindSemaphore.

Pattern matching is part of descriptor behaviour.

Derivation

• TFindHandle - No description.

• TFindHandleBase - Base class for searching for global kernel objects.

• TFindSemaphore - Finds all global semaphores whose full names match a specified pattern.

Members

Defined in TFindSemaphore:

• Next(TFullName &)Finds the next global semaphore whose full name matches the match pattern.
• TFindSemaphore()Constructs the object with a default match pattern.
• TFindSemaphore(const TDesC &)Constructs this object with the specified match pattern.

Inherited from TFindHandleBase:

• Find(const TDesC &)Sets a new match pattern.
• TFindHandleBase(const TDesC &)Constructor with match pattern.

See also:

• TFindHandleBase::Find(const TDesC &)Sets a new match pattern.
• TFindSemaphore::Next(TFullName &)Finds the next global semaphore whose full name matches the match pattern.
• RSemaphore::Open(const TFindSemaphore &,TOwnerType)Opens a handle to the global semaphore found using a TFindSemaphore object.
• TDesC16::Match(const TDesC16 &)constSearches this descriptor's data for a match with the match pattern supplied in t...
• TDesC8::Match(const TDesC8 &)constSearches this descriptor's data for a match with the match pattern supplied in t...

inline TFindSemaphore();

Description

Constructs the object with a default match pattern.

The default match pattern, as implemented by the base class, is the single character "*".

A new match pattern can be set after construction by calling the TFindHandleBase::Find(const TDesC &) member function of the TFindHandleBase base class.

See also:

• TFindHandleBase::Find(const TDesC &)Sets a new match pattern.

inline TFindSemaphore(const TDesC &aMatch);

Description

Constructs this object with the specified match pattern.

A new match pattern can be set after construction by calling TFindHandleBase::Find(const TDesC &).

Note that after construction, the object contains a copy of the supplied match pattern; the source descriptor can, therefore, be safely discarded.

Parameters

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

See also:

• TFindHandleBase::Find(const TDesC &)Sets a new match pattern.

IMPORT_C TInt Next(TFullName &aResult);

Description

Finds the next global semaphore whose full name matches the match pattern.

If a global semaphore with a matching name is found, the function copies its full name into the descriptor aResult. It also saves the find-handle associated with the global semaphore into the TFindHandleBase part of this TFindSemaphore object.

Parameters

TBuf &aResult A reference to a TBuf descriptor with a defined maximum length. If a matching global semaphore is found, its full name is set into this descriptor. If no matching global semaphore is found, the descriptor length is set to zero.

Return value

TInt KErrNone if a matching global semaphore is found; KErrNotFound otherwise.