TFindSemaphore Class Reference

#include <e32std.h>

class TFindSemaphore : public TFindHandleBase

Inherits from

Detailed 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 Find() member function of the TFindHandleBase base class.

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

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

Pattern matching is part of descriptor behaviour.

See also: TFindHandleBase::Find TFindSemaphore::Next RSemaphore::Open TDesC16::Match TDesC8::Match

Constructor & Destructor Documentation

TFindSemaphore ( )

TFindSemaphore()[inline]

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 Find() member function of the TFindHandleBase base class.

See also: TFindHandleBase::Find

TFindSemaphore ( const TDesC & )

TFindSemaphore(const TDesC &aMatch)[inline]

Constructs this object with the specified match pattern.

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

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

See also: TFindHandleBase::Find

Parameters
aMatchA reference to the descriptor containing the match pattern.

Member Function Documentation

Next ( TFullName & )

IMPORT_C TIntNext(TFullName &aResult)

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
aResultA 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
KErrNone if a matching global semaphore is found; KErrNotFound otherwise.