Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
TFindMutex Class Reference

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

#include <e32std.h>

Inheritance diagram for TFindMutex:
TFindHandleBase TFindHandle

Public Member Functions

 TFindMutex ()
 Constructs this object with a default match pattern.
 
 TFindMutex (const TDesC &aMatch)
 Constructs this object with the specified match pattern.
 
IMPORT_C TInt Next (TFullName &aResult)
 Finds the next global mutex whose full name matches the match pattern.
 
- Public Member Functions inherited from TFindHandleBase
IMPORT_C TFindHandleBase ()
 Default constructor.
 
IMPORT_C TFindHandleBase (const TDesC &aMatch)
 Constructor with match pattern.
 
IMPORT_C void Find (const TDesC &aMatch)
 Sets a new match pattern.
 
- Public Member Functions inherited from TFindHandle
 TFindHandle ()
 
TInt Handle () const
 Gets the find-handle number associated with the Kernel object.
 

Additional Inherited Members

- Protected Member Functions inherited from TFindHandleBase
TInt NextObject (TFullName &aResult, TInt aObjectType)
 Implementation for TFindXxxxxxx::Next(TFullName &aResult) methods.
 
- Protected Member Functions inherited from TFindHandle
void Reset ()
 Resets the find handle to its initial state.
 

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
API status
Published to all clients. Released API.

Definition at line 3030 of file e32std.h.

Constructor & Destructor Documentation

◆ TFindMutex() [1/2]

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.

TFindHandleBase::Find

(generated from Symbian Developer Library)

◆ TFindMutex() [2/2]

TFindMutex::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.

TFindHandleBase::Find

Parameters
aMatchThe match pattern.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Next()

IMPORT_C TInt TFindMutex::Next ( 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.

(generated from Symbian Developer Library)


The documentation for this class was generated from the following files: