RDirPlugin Class Reference

class RDirPlugin : private RDir

Inherits from

Constructor & Destructor Documentation

RDirPlugin(TFsPluginRequest &, TBool)

IMPORT_C RDirPlugin ( TFsPluginRequest & aRequest,
TBool aDirectToDrive = EFalse
)

Parameters

TFsPluginRequest & aRequest
TBool aDirectToDrive = EFalse

RDirPlugin()

RDirPlugin ( ) [private]

RDirPlugin(const RDirPlugin &)

RDirPlugin ( const RDirPlugin & ) [private]

Parameters

const RDirPlugin &

~RDirPlugin()

IMPORT_C ~RDirPlugin ( )

Member Functions Documentation

Close()

IMPORT_C void Close ( )

Closes the directory.

Any open files are closed when the file server session is closed.

Close() is guaranteed to return, and provides no indication whether it completed successfully or not.

CloseSubSession(TInt)

void CloseSubSession ( TInt aFunction ) [protected]

Parameters

TInt aFunction

CreateSubSession(const RSessionBase &, TInt, const TIpcArgs &)

TInt CreateSubSession ( const RSessionBase & aSession,
TInt aFunction,
const TIpcArgs & aArgs
) [protected]

Creates a new sub-session within an existing session.

Parameters

const RSessionBase & aSession The session to which this sub-session will belong.
TInt aFunction The opcode specifying the requested service; the server should interpret this as a request to create a sub-session.
const TIpcArgs & aArgs The message arguments.

Open(const TDesC &, const TUidType &)

IMPORT_C TInt Open ( const TDesC & aMatchName,
const TUidType & aUidType
)

Parameters

const TDesC & aMatchName
const TUidType & aUidType

Open(const TDesC &, TUint)

IMPORT_C TInt Open ( const TDesC & aMatchName,
TUint anAttMask
)

Parameters

const TDesC & aMatchName
TUint anAttMask

Read(TEntryArray &)

IMPORT_C TInt Read ( TEntryArray & aArray )

Plugin authors should pass in a TRawEntryArray if their intent is to modify the data.

Parameters

TEntryArray & aArray

Read(TEntry &)

IMPORT_C TInt Read ( TEntry & aEntry )

Parameters

TEntry & aEntry

SendReceive(TInt, const TIpcArgs &)

TInt SendReceive ( TInt aFunction,
const TIpcArgs & aArgs
) const [protected]

Sends a message to the server and waits synchronously for a reply.

An opcode specifies the service required. A set of message arguments is passed that can be used to specify client addresses, which the server can use to read from and write to the client address space.

Note that this function will only fail if the server itself fails or environmental errors occur in the server. All requests made using this function are guaranteed to reach the server. This means that all synchronous client requests (typically those that return void) should be routed through this synchronous variant of SendReceive() .

Parameters

TInt aFunction The opcode specifying the requested service.
const TIpcArgs & aArgs The message arguments.

SetHandle(TInt)

void SetHandle ( TInt aHandle ) [private]

Parameters

TInt aHandle

SetSubSessionHandle(TInt)

void SetSubSessionHandle ( TInt aHandle ) [private]

Parameters

TInt aHandle

operator=(const RDirPlugin &)

RDirPlugin & operator= ( const RDirPlugin & ) [private]

Parameters

const RDirPlugin &

Member Data Documentation

TPluginSessionHelper iSessionHelper

TPluginSessionHelper iSessionHelper [private]