Symbian^3 Application Developer Library >

TFsPluginRequest Class Reference

class TFsPluginRequest

Request wrapper for plugins

Public Member Functions
TFsPluginRequest (CFsRequest *)
IMPORT_C TParse & Dest ()
IMPORT_C TDrive * Drive ()
IMPORT_C TInt DriveNumber ()
IMPORT_C TInt FileName ( TDes &)
IMPORT_C TInt Function ()
IMPORT_C TBool IsPostOperation ()
IMPORT_C const RMessage2 & Message ()
IMPORT_C TInt Read ( TF32ArgType , TInt &)
IMPORT_C TInt Read ( TF32ArgType , TUint &)
IMPORT_C TInt Read ( TF32ArgType , TInt64 &)
IMPORT_C TInt Read ( TF32ArgType , TDes8 &, TInt )
IMPORT_C TInt Read ( TF32ArgType , TDes16 &, TInt )
IMPORT_C CFsRequest * Request ()
IMPORT_C TUint ScratchValue ()
IMPORT_C TInt64 ScratchValue64 ()
IMPORT_C TInt SetSharePos ( TInt64 &)
IMPORT_C TParse & Src ()
IMPORT_C TDrive * SubstedDrive ()
IMPORT_C TInt Write ( TF32ArgType , const TDesC8 &, TInt )
IMPORT_C TInt Write ( TF32ArgType , const TDesC16 &, TInt )
Private Member Functions
TInt ClientSubSessionHandle ( TInt &)
void NameFromShare ( CFileShare &, TDes &)
TInt ShareFromClientHandle ( CFileShare *&)
Public Member Enumerations
enum TF32ArgType {
EPosition , ELength , EData , ESize , EName , ENewName , EEntry , ETime , ESetAtt , EClearAtt , EMode , EAtt , EAttMask , EUid , EEntryArray , ENewPosition , EVolumeInfo
}
Private Attributes
CFsRequest * iFsRequest

Constructor & Destructor Documentation

TFsPluginRequest(CFsRequest *)

IMPORT_C TFsPluginRequest ( CFsRequest * aRequest )

Parameters

CFsRequest * aRequest

Member Functions Documentation

ClientSubSessionHandle(TInt &)

TInt ClientSubSessionHandle ( TInt & aHandle ) [private]

Parameters

TInt & aHandle

Dest()

IMPORT_C TParse & Dest ( ) const

Drive()

IMPORT_C TDrive * Drive ( ) const

DriveNumber()

IMPORT_C TInt DriveNumber ( ) const

Returns the drive number of the current request

FileName(TDes &)

IMPORT_C TInt FileName ( TDes & aName )

Parameters

TDes & aName

Function()

IMPORT_C TInt Function ( ) const

Get the current Function number, as defined in TFsMessage

IsPostOperation()

IMPORT_C TBool IsPostOperation ( ) const

Message()

IMPORT_C const RMessage2 & Message ( ) const

NameFromShare(CFileShare &, TDes &)

void NameFromShare ( CFileShare & aFileShare,
TDes & aName
) [private]

Parameters

CFileShare & aFileShare
TDes & aName

Read(TF32ArgType, TInt &)

IMPORT_C TInt Read ( TF32ArgType aType,
TInt & aVal
)

Utility function for returning a TInt type of TF32ArgType value from the current request. i.e. ELength.

To obtain EPosition, authors should use Read(TF32ArgType,TInt64&)

Parameters

TF32ArgType aType
TInt & aVal

Read(TF32ArgType, TUint &)

IMPORT_C TInt Read ( TF32ArgType aType,
TUint & aVal
)

Utility function for returning a TUint type of TF32ArgType value from the current request.

To obtain EPosition, authors should use Read(TF32ArgType,TInt64&)

Parameters

TF32ArgType aType
TUint & aVal

Read(TF32ArgType, TInt64 &)

IMPORT_C TInt Read ( TF32ArgType aType,
TInt64 & aVal
)

Utility function for returning a TInt64 type of TF32ArgType value from the current request. i.e. EPosition.

Parameters

TF32ArgType aType
TInt64 & aVal

Read(TF32ArgType, TDes8 &, TInt)

IMPORT_C TInt Read ( TF32ArgType aType,
TDes8 & aDes,
TInt aOffset = 0
)

Utility function for receving descriptor or packaged paramters of the current request. For non-descriptor types such a TEntry , plugin authors should pass an object of type TPckg<TEntry> in to aDes.

Parameters

TF32ArgType aType
TDes8 & aDes
TInt aOffset = 0

Read(TF32ArgType, TDes16 &, TInt)

IMPORT_C TInt Read ( TF32ArgType aType,
TDes16 & aDes,
TInt aOffset = 0
)

Utility function for receving descriptor or packaged paramters of the current request. For non-descriptor types such a TEntry , plugin authors should pass an object of type TPckg<TEntry> in to aDes.

Parameters

TF32ArgType aType
TDes16 & aDes
TInt aOffset = 0

Request()

IMPORT_C CFsRequest * Request ( ) const

ScratchValue()

IMPORT_C TUint ScratchValue ( ) const

ScratchValue64()

IMPORT_C TInt64 ScratchValue64 ( ) const

SetSharePos(TInt64 &)

IMPORT_C TInt SetSharePos ( TInt64 & aPos )

When plugin authors perform early completion of read or write requests, then SetSharePos should be called in order to update the share position to the client.

Parameters

TInt64 & aPos

ShareFromClientHandle(CFileShare *&)

TInt ShareFromClientHandle ( CFileShare *& aShare ) [private]

Parameters

CFileShare *& aShare

Src()

IMPORT_C TParse & Src ( ) const

SubstedDrive()

IMPORT_C TDrive * SubstedDrive ( ) const

Write(TF32ArgType, const TDesC8 &, TInt)

IMPORT_C TInt Write ( TF32ArgType aType,
const TDesC8 & aDes,
TInt aOffset = 0
)

Utilty function for writing data back to the request. Non-descriptor values should be packaged i.e TPckg<TUidType>

Parameters

TF32ArgType aType
const TDesC8 & aDes
TInt aOffset = 0

Write(TF32ArgType, const TDesC16 &, TInt)

IMPORT_C TInt Write ( TF32ArgType aType,
const TDesC16 & aDes,
TInt aOffset = 0
)

Utilty function for writing data back to the request. Non-descriptor values should be packaged i.e TPckg<TUidType>

Parameters

TF32ArgType aType
const TDesC16 & aDes
TInt aOffset = 0

Member Enumerations Documentation

Enum TF32ArgType

Used for getting parameters from a CFsRequest by a F32 plugin.

Enumerators

EPosition
ELength
EData
ESize
EName
ENewName
EEntry
ETime
ESetAtt
EClearAtt
EMode
EAtt
EAttMask
EUid
EEntryArray
ENewPosition
EVolumeInfo

Member Data Documentation

CFsRequest * iFsRequest

CFsRequest * iFsRequest [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.