TFindMutex Class Reference

#include <e32std.h>

class TFindMutex : public TFindHandleBase

Inherits from

Detailed Description

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

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

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

A successful call to Next() means that a matching global mutex has been found. To open a handle on this mutex, call the Open() member function of RMutex and pass a reference to this TFindMutex object.

Pattern matching is part of descriptors behaviour.

See also: TFindHandleBase::Find TFindMutex::Next RMutex::Open TDesC16::Match TDesC8::Match

Constructor & Destructor Documentation

TFindMutex ( )

TFindMutex()[inline]

Constructs this 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

TFindMutex ( const TDesC & )

TFindMutex(const TDesC &aMatch)[inline]

Constructs this object with the specified match pattern.

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

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
aMatchThe match pattern.

Member Function Documentation

Next ( TFullName & )

IMPORT_C TIntNext(TFullName &aResult)

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

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

Parameters
aResultA reference to a descriptor with a defined maximum length. If a matching global mutex is found, its full name is set into this descriptor. If no matching global mutex is found, the descriptor length is set to zero.
Return Value
KErrNone if a matching global mutex is found; KErrNotFound otherwise.