Class TFindMutex

class TFindMutex : public TFindHandleBase;

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

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

A successful call to TFindMutex::Next(TFullName &) 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.

Derivation

• TFindHandle - No description.

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

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

Members

Defined in TFindMutex:

• Next(TFullName &)Finds the next global mutex whose full name matches the match pattern.
• TFindMutex()Constructs this object with a default match pattern.
• TFindMutex(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.
• TFindMutex::Next(TFullName &)Finds the next global mutex whose full name matches the match pattern.
• RMutex::Open(const TFindMutex &,TOwnerType)Opens a handle to the global mutex found using a TFindMutex 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 TFindMutex();

Description

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

See also:

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

inline TFindMutex(const TDesC &aMatch);

Description

Constructs this object with the specified match pattern.

A new match pattern can be set after construction by calling the TFindHandleBase::Find(const TDesC &) 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.

Parameters

const TDesC16 &aMatch 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 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

TBuf &aResult A 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

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