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

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

#include <e32std.h>

Inheritance diagram for TFindSemaphore:
TFindHandleBase TFindHandle

Public Member Functions

 TFindSemaphore ()
 Constructs the object with a default match pattern.
 
 TFindSemaphore (const TDesC &aMatch)
 Constructs this object with the specified match pattern.
 
IMPORT_C TInt Next (TFullName &aResult)
 Finds the next global semaphore 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 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
API status
Published to all clients. Released API.

Definition at line 2992 of file e32std.h.

Constructor & Destructor Documentation

◆ TFindSemaphore() [1/2]

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.

TFindHandleBase::Find

(generated from Symbian Developer Library)

◆ TFindSemaphore() [2/2]

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

TFindHandleBase::Find

Parameters
aMatchA reference to the descriptor containing the match pattern.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Next()

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

(generated from Symbian Developer Library)


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