MSsmSwpPolicy Class Reference
The protocol for System Wide Property policy DLLs. These are not ECOM DLLs because they need to work before the ECOM server is started. These DLLs can only be loaded from the ROM file system (from Z:).
Member Functions Documentation
CommandList()
Used to retrieve the command list once the PrepareCommandList has completed. Ownership of the returned command list is transferred to the caller.
HandleCleReturnValue(const TSsmSwp &, TInt, TInt, TRequestStatus &)
Handle the return value from the CLE. This gives the policy a chance to do some Error handling, in case execution of the command list should fail in any way.
Parameters
| const TSsmSwp & aSwp | Contains information about the request that has been executed |
| TInt aError | Contains the error-code that resulted from the Command-list execution |
| TInt aSeverity | Contains the severity of the failed command in case the Command-list execution ended with an error |
| TRequestStatus & aStatus | to complete when aError has been dealt with |
HandleCleReturnValueCancel()
| void | HandleCleReturnValueCancel | ( | ) | [pure virtual] |
Used to inform the DLL to Cancel the pending asynchronous HandleCleReturnValue operation.
Initialize(TRequestStatus &)
This function is guaranteed to be called before this Swp Policy is used. It is intended for e.g. opening resource files, initialize hardware or talk to a domestic OS.
//minimal implemementation of this function would be
TRequestStatus* status = &aStatus;
User::RequestComplete(status, KErrNone);
Parameters
| TRequestStatus & aStatus | to complete when the initialization operation has finished |
InitializeCancel()
| void | InitializeCancel | ( | ) | [pure virtual] |
Used to inform the DLL to Cancel the pending asynchronous Initialize operation.
MSsmSwpPolicy_Reserved_1()
| void | MSsmSwpPolicy_Reserved_1 | ( | ) | [private, inline, virtual] |
MSsmSwpPolicy_Reserved_2()
| void | MSsmSwpPolicy_Reserved_2 | ( | ) | [private, inline, virtual] |
MSsmSwpPolicy_Reserved_3()
| void | MSsmSwpPolicy_Reserved_3 | ( | ) | [private, inline, virtual] |
PrepareCommandList(const TSsmSwp &, TRequestStatus &)
Used to create the command list associated with a Swp change.
Parameters
| const TSsmSwp & aSwp | Contains the key that identifies the command list to create. Also contains the new value to be set to the Swp in question. |
| TRequestStatus & aStatus | Used to signify command list is prepared |
PrepareCommandListCancel()
| void | PrepareCommandListCancel | ( | ) | [pure virtual] |
Used to inform the DLL to Cancel the pending asynchronous PrepareCommandList operation.
Release()
| void | Release | ( | ) | [pure virtual] |
It is expected that Release will usually just call "delete this" on the object, but this will depend on the implementation of each policy.
TransitionAllowed(const TSsmSwp &, const RMessagePtr2 &)
Used to determine if an incoming request should be accepted or rejected.
Parameters
| const TSsmSwp & aSwp | Contains information about the new request. |
| const RMessagePtr2 & aMessage | Contains information about the requesting client process. DLLs should not call RMessagePtr2::Complete. |
Member Enumerations Documentation
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.