userlibandfileserver/fileserver/inc/f32notification.h
changeset 300 1d28c8722707
parent 189 a5496987b1da
equal deleted inserted replaced
293:0659d0e1a03c 300:1d28c8722707
   113 	 */
   113 	 */
   114 	IMPORT_C TInt FileSize(TInt64& aSize) const; 
   114 	IMPORT_C TInt FileSize(TInt64& aSize) const; 
   115 
   115 
   116 	/*
   116 	/*
   117 	 * @returns The Drive Number associated with the Path.
   117 	 * @returns The Drive Number associated with the Path.
       
   118 	 */
   118 	IMPORT_C TInt DriveNumber(TInt& aDriveNumber) const;
   119 	IMPORT_C TInt DriveNumber(TInt& aDriveNumber) const;
   119 	 */
   120 
   120 	
       
   121 	/*
   121 	/*
   122 	 * @returns the UID of the process that caused this change.
   122 	 * @returns the UID of the process that caused this change.
       
   123 	 *          NB, the UID of the process causing the change is not always available
       
   124 	 *			such as when memory cards are physically removed.
       
   125 	 */
   123 	IMPORT_C TInt UID(TUid& aUID) const;
   126 	IMPORT_C TInt UID(TUid& aUID) const;
   124 	 */
   127 	 
   125 private:
   128 private:
   126 	//Declared private to prevent construction
   129 	//Declared private to prevent construction
   127 	TFsNotification();
   130 	TFsNotification();
   128 	~TFsNotification();
   131 	~TFsNotification();
   129 	//To prevent copying.  No implementation is provided.
   132 	//To prevent copying.  No implementation is provided.
   180 		 * Factory function. Creates a new CFsNotify and returns a pointer to it.
   183 		 * Factory function. Creates a new CFsNotify and returns a pointer to it.
   181 		 *
   184 		 *
   182 		 * CFsNotify stores notifications in a buffer. 
   185 		 * CFsNotify stores notifications in a buffer. 
   183 		 * Clients of CFsNotify must specify how large this buffer should be.
   186 		 * Clients of CFsNotify must specify how large this buffer should be.
   184 		 * 
   187 		 * 
   185 		 * As a guideline: Notification objects in the buffer typically have a 8byte header,
   188 		 * As a guideline: Notification objects in the buffer typically have a 12-byte header,
   186 		 * followed by a word aligned string containing the fullname of the file that has changed.
   189 		 * followed by a word aligned string containing the fullname of the file that has changed.
   187 		 * In the case of a rename notification both the original and the new fullnames are stored.
   190 		 * In the case of a rename notification both the original and the new fullnames are stored.
   188 		 *
   191 		 *
   189 		 * However, clients must not assume to know the exact size of notifications when determining the size of their buffer,
   192 		 * However, clients must not assume to know the exact size of notifications when determining the size of their buffer,
   190 		 * as it is not possible to know how often a client will be able to read the notifications from the buffer.
   193 		 * as it is not possible to know how often a client will be able to read the notifications from the buffer.