MSsmCustomCommand Class Reference

class MSsmCustomCommand

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

Member Functions Documentation

Close()

void Close ( ) [pure virtual]

Closes resources initialized in a previous call to Initialize.

Execute(const TDesC8 &, TRequestStatus &)

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

Executes this custom command.

Parameters

const TDesC8 & aParams The 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 & aRequest Request object completed with KErrNone when the command has successfully finished execution, otherwise one of the system wide error codes.

ExecuteCancel()

void ExecuteCancel ( ) [pure virtual]

Cancels current execution of this custom command.

Initialize(CSsmCustomCommandEnv *)

TInt Initialize ( CSsmCustomCommandEnv * aCmdEnv ) [pure virtual]

Initializes this custom command.

Parameters

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

Release()

void Release ( ) [pure virtual]

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