os/kernelhwsrv/userlibandfileserver/fileserver/inc/common.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 // Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // f32\inc\common.h
    15 // 
    16 //
    17 
    18 /**
    19  @file
    20  @publishedPartner
    21  @released
    22 */
    23 
    24 #if !defined(__COMMON_H__)
    25 #define __COMMON_H__
    26 #if !defined(__F32FILE_H__)
    27 #include <f32file.h>
    28 #endif
    29 #include <d32locd.h>
    30 #include "u32std.h"
    31 
    32 //
    33 // Common constants used by both EFSRV and the filesystems
    34 //
    35 
    36 
    37 
    38 /**
    39 A bit mask representing a volume and file attribute combination.
    40 
    41 It represents a set of attributes that must not be set, unset or used
    42 in calls to RFile::Set() and CMountCB::MatchEntryAtt().
    43 
    44 @see CMountCB::MatchEntryAtt()
    45 @see RFile::Set()
    46 */
    47 const TUint KEntryAttIllegal=(KEntryAttVolume|KEntryAttDir);
    48 
    49 
    50 
    51 /**
    52 A file attribute that marks the file as having been modified. This is an indication
    53 that the file is modified but the modifications are not yet committed.
    54 
    55 @see RFs::SetEntry()
    56 */
    57 const TUint KEntryAttModified=0x20000000;
    58 
    59 
    60 
    61 /**
    62 Defines a criteria that states that an entry must be a file.
    63 
    64 This can be used in calls to CMountCB::MatchEntryAtt().
    65 
    66 @see CMountCB::MatchEntryAtt()
    67 */
    68 const TUint KEntryAttMustBeFile=0x80000000;
    69 
    70 
    71 
    72 /**
    73 Indicates that data is to be read from the current read position when
    74 passed to any of the Read() overloaded functions of RFile.
    75 
    76 This is maintained for BC. File server and file server client library, internally, 
    77 use KCurrentPosition64 for indicating a read / write request from current file position. 
    78 
    79 @see RFile::Read()
    80 @see KCurrentPosition64
    81 */
    82 const TInt KCurrentPosition=KMinTInt;
    83 
    84 
    85 /**
    86 Indicates that data is to be read from the current read position when
    87 passed to any of the Read() overloaded functions of RFile.
    88 
    89 @prototype
    90 
    91 @see RFile::Read()
    92 */
    93 const TInt64 KCurrentPosition64=(TInt64)KMaxTUint64;
    94 
    95 
    96 
    97 #endif