MSsmCustomCommand Class Reference

class MSsmCustomCommand

Abstract interface to a custom command. All custom command objects should derive from this interface.

Public Member Functions
voidClose()
voidExecute(const TDesC8 &, TRequestStatus &)
voidExecuteCancel()
TInt Initialize(CSsmCustomCommandEnv *)
voidRelease()

Member Functions Documentation

Close()

voidClose()[pure virtual]

Closes resources initialized in a previous call to Initialize.

Execute(const TDesC8 &, TRequestStatus &)

voidExecute(const TDesC8 &aParams,
TRequestStatus &aRequest
)[pure virtual]

Executes this custom command.

Parameters

const TDesC8 & aParamsThe extra information data for this instance of the custom command. If this custom command was created from a resource file struct, this will be the resource pointed to by dll_info.
TRequestStatus & aRequestRequest object completed with KErrNone when the command has successfully finished execution, otherwise one of the system wide error codes.

ExecuteCancel()

voidExecuteCancel()[pure virtual]

Cancels current execution of this custom command.

Initialize(CSsmCustomCommandEnv *)

TInt Initialize(CSsmCustomCommandEnv *aCmdEnv)[pure virtual]

Initializes this custom command.

Parameters

CSsmCustomCommandEnv * aCmdEnvA environment for use by the custom command. This pointer will be valid until Release is called on this custom command.

Release()

voidRelease()[pure virtual]

Releases memory associated with the Custom Command (deletes the MSsmCustomCommand object)