TFindHandle Class Reference

#include <e32cmn.h>

class TFindHandle
Public Member Functions
TFindHandle()
TInt Handle()
TInt Index()
TUint64 ObjectID()
voidSet(TInt, TInt, TUint64)
TInt UniqueID()

Constructor & Destructor Documentation

TFindHandle ( )

TFindHandle()[inline]

Member Function Documentation

Handle ( )

TInt Handle()const [inline]

Gets the find-handle number associated with the Kernel object.

The find-handle number identifies the kernel object with respect to its container.

Note that setting the find-handle number into a TFindHandle object is not implemented by this class; it is implemented by derived classes, typically by their Next() member functions. The class TFindSemaphore is a good example.

Return Value
The find-handle number.

Index ( )

TInt Index()const [inline]

Gets the index into its container at which the kernel object was last seen.

Return Value
The object's index in its container.

ObjectID ( )

TUint64 ObjectID()const [inline]

Gets the unique ID of the kernel object itself.

Return Value
The ID of the object.

Set ( TInt, TInt, TUint64 )

voidSet(TIntaIndex,
TIntaUniqueId,
TUint64aObjectId
)[inline]

Sets the find handle to refer to a specific object.

aIndex The current index of the object in its container.

Parameters
aUniqueIdThe unique ID of the container object.
aObjectIdThe unique ID of the object iteself.

UniqueID ( )

TInt UniqueID()const [inline]

Gets the unique ID of the kernel container this object resides in.

Return Value
The ID of this object's container.