Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: e32std.h
Link against: euser.lib

Class TFindLogicalChannel

TFindLogicalChannel

Support

Supported from 5.0

Description

Searches for logical channels by pattern matching against the names of (Kernel side) logical channel objects.

The match pattern can be set into this object at construction; it can also be changed at any time after construction by using TFindHandleBase::Find().

After construction, call TFindLogicalChannel::Next() repeatedly to find successive logical channels whose names match the current pattern. A successful call to TFindLogicalChannel::Next() means that a matching logical channel has been found.

The name of a logical channel is usually set when it is created through the User side call to RBusLogicalChannel::DoCreate().

Derivation

TFindHandleBaseBase class for searching for global Kernel objects
TFindLogicalChannelSearches for logical channels by pattern matching against the names of (Kernel side) logical channel objects

Defined in TFindLogicalChannel:
Next(), TFindLogicalChannel(), TFindLogicalChannel()

Inherited from TFindHandleBase:
Find(), Handle()

See also:


Construction and destruction


TFindLogicalChannel()

TFindLogicalChannel();

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 TFindHandleBase::Find().


TFindLogicalChannel()

TFindLogicalChannel(const TDesC& aMatch);

Description

Constructs this object with a specified match pattern.

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

Parameters

const TDesC& aMatch

The match pattern.

[Top]


Find next matching logical channel


Next()

TInt Next(TFullName& aResult);

Description

Returns the full name of the next logical channel which matches the match pattern.

Parameters

TFullName& aResult

A reference to a TBuf descriptor with a defined maximum length. If a matching logical channel is found, its full name is set into this descriptor. If no matching logical channel is found, the descriptor length is set to zero.

Return value

TInt

KErrNone if a matching logical channel is found; KErrNotFound otherwise.