A handle to a change notifier. More...
#include <e32std.h>
Public Member Functions | |
| IMPORT_C TInt | Create () |
| Creates a change notifier, and opens this handle to that change notifier. | |
| IMPORT_C TInt | Logon (TRequestStatus &aStatus) const |
| Issues a request for notification when changes occur in the environment. | |
| IMPORT_C TInt | LogonCancel () const |
| Cancels an outstanding change notification request. | |
 Public Member Functions inherited from RHandleBase | |
| RHandleBase () | |
| Default constructor. | |
| TInt | Handle () const |
| Retrieves the handle-number of the object associated with this handle. | |
| void | SetHandle (TInt aHandle) |
| Sets the handle-number of this handle to the specified value. | |
| TInt | SetReturnedHandle (TInt aHandleOrError) |
| Sets the handle-number of this handle to the specified value. | |
| IMPORT_C void | Close () |
| Closes the handle. | |
| IMPORT_C TName | Name () const |
| Gets the name of the handle. | |
| IMPORT_C TFullName | FullName () const |
| Gets the full name of the handle. | |
| IMPORT_C void | FullName (TDes &aName) const |
| Gets the full name of the handle. | |
| IMPORT_C void | SetHandleNC (TInt aHandle) |
| Sets the handle-number of this handle to the specified value, and marks it as not closable. | |
| IMPORT_C TInt | Duplicate (const RThread &aSrc, TOwnerType aType=EOwnerProcess) |
| Creates a valid handle to the kernel object for which the specified thread already has a handle. | |
| IMPORT_C void | HandleInfo (THandleInfo *anInfo) |
| Gets information about the handle. | |
| IMPORT_C TUint | Attributes () const |
| IMPORT_C TInt | BTraceId () const |
| Returns a unique object identifier for use with BTrace. | |
| IMPORT_C void | NotifyDestruction (TRequestStatus &aStatus) |
| Internal technology API. | |
Additional Inherited Members | |
| Public Types inherited from RHandleBase | |
| enum | TAttributes { EReadAccess =0x1 , EWriteAccess =0x2 , EDirectReadAccess =0x4 , EDirectWriteAccess =0x8 } |
| Read/Write attributes for the handle. More... | |
| Static Public Member Functions inherited from RHandleBase | |
| static void | DoExtendedClose () |
| Protected Member Functions inherited from RHandleBase | |
| RHandleBase (TInt aHandle) | |
| Copy constructor. | |
| IMPORT_C TInt | Open (const TFindHandleBase &aHandle, TOwnerType aType) |
| Opens a handle to a kernel side object found using a find-handle object. | |
| TInt | OpenByName (const TDesC &aName, TOwnerType aOwnerType, TInt aObjectType) |
| Implementation for RXxxxx::Open/OpenGlocbal(const TDesC &aName,,TOwnerType aType) functions. | |
| Static Protected Member Functions inherited from RHandleBase | |
| static TInt | SetReturnedHandle (TInt aHandleOrError, RHandleBase &aHandle) |
| Protected Attributes inherited from RHandleBase | |
| TInt | iHandle |
Detailed Description
A handle to a change notifier.
The change notifier itself is a kernel object.
- API status
- Published to all clients. Released API.
Member Function Documentation
◆ Create()
| IMPORT_C TInt RChangeNotifier::Create | ( | ) |
Creates a change notifier, and opens this handle to that change notifier.
Ownership of this change notifier is vested in the current process.
(generated from Symbian Developer Library)
◆ Logon()
| IMPORT_C TInt RChangeNotifier::Logon | ( | TRequestStatus & | aStatus | ) | const |
Issues a request for notification when changes occur in the environment.
A switch in locale, or crossing over past midnight, are examples of changes that are reported.
When a change in the environment occurs, the request completes and the TRquestStatus object will contain one or more of the bit values defined by the TChanges enum.
Alternatively, if an outstanding request is cancelled by a call to this handle's LogonCancel() member function, then the request completes with a KErrCancel.
Note that if this is the first notification request after creation of the change notifier, then this request completes immediately.
TChanges RChangeNotifier::Logon()
- Parameters
-
aStatus A reference to the request status object.
(generated from Symbian Developer Library)
◆ LogonCancel()
| IMPORT_C TInt RChangeNotifier::LogonCancel | ( | ) | const |
Cancels an outstanding change notification request.
(generated from Symbian Developer Library)
The documentation for this class was generated from the following files:
