1 <h1>FSCLIENT panic</h1>

     2 <p>

     3 Panics with this category are raised on clients requesting services provided by the

     4 file server. Typically, they are caused by passing bad or contradictory values

     5 to class constructors or member functions. 

     6 </p>

     7 <p>

     8 The thread causing the panic is terminated.

     9 </p>

    10 <p>

    11 To avoid confusion, we need to emphasise that the panic category is the

    12 14 character string <em>FSCLIENT panic</em>, and that the word panic is

    13 part of the panic category.

    14 </p>

    15 <code>0</code>

    16 <p>

    17 This panic is raised by: 

    18 </p>

    19 <p>

    20 the <code>TDriveUnit(TInt aDrive)</code> variant of the

    21 <a href="../reference-cpp/F32_EKA2/TDriveUnitClass.html#%3a%3aTDriveUnit" title="class TDriveUnit"><code class="ApiItem">TDriveUnit</code></a> constructor, 

    22 </p>

    23 <p>

    24 the <code>(TInt aDrive)</code> variant of the

    25 <a href="../reference-cpp/F32_EKA2/TDriveUnitClass.html#%3a%3aTDriveUnit" title="class TDriveUnit"><code class="ApiItem">TDriveUnit</code></a> assignment operator 

    26 </p>

    27 <p>

    28 when the specified drive number is greater than or equal to

    29 <code>KMaxDrives</code>, i.e. 26. 

    30 </p>

    31 <code>1</code>

    32 <p>

    33 This panic is raised by: 

    34 </p>

    35 <p>

    36 the <code>TDriveUnit(const TDesC&amp; aDriveText)</code>

    37 variant of the <a href="../reference-cpp/F32_EKA2/TDriveUnitClass.html#%3a%3aTDriveUnit" title="class TDriveUnit"><code class="ApiItem">TDriveUnit</code></a> constructor, 

    38 </p>

    39 <p>

    40 the <code>(const TDesC&amp; aDriveText)</code> variant of the

    41 <a href="../reference-cpp/F32_EKA2/TDriveUnitClass.html#%3a%3aTDriveUnit" title="class TDriveUnit"><code class="ApiItem">TDriveUnit</code></a> assignment operator 

    42 </p>

    43 <p>

    44 when the specified drive letter is invalid, i.e. does not

    45 correspond to a drive number. 

    46 </p>

    47 <code>2</code>

    48 <p>

    49 This panic is raised when searching for the next file using

    50 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFind%28%29" title="function TFindFile::Find()"><code class="ApiItem">TFindFile::Find()</code></a> or

    51 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindWild%28%29" title="function TFindFile::FindWild()"><code class="ApiItem">TFindFile::FindWild()</code></a> before the initial call specifying

    52 the search method. 

    53 </p>

    54 <p>

    55 Calls to <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFind%28%29" title="function TFindFile::Find()"><code class="ApiItem">TFindFile::Find()</code></a> cannot be made

    56 until an initial call has been made to either of: 

    57 </p>

    58 <p>

    59 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindByDir%28%29" title="function TFindFile::FindByDir()"><code class="ApiItem">TFindFile::FindByDir()</code></a>

    60 </p>

    61 <p>

    62 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindByPath%28%29" title="function TFindFile::FindByPath()"><code class="ApiItem">TFindFile::FindByPath()</code></a>

    63 </p>

    64 <p>

    65 Calls to <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindWild%28%29" title="function TFindFile::FindWild()"><code class="ApiItem">TFindFile::FindWild()</code></a> cannot be made

    66 until an initial call has been made to either of: 

    67 </p>

    68 <p>

    69 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindWildByDir%28%29" title="function TFindFile::FindWildByDir()"><code class="ApiItem">TFindFile::FindWildByDir()</code></a>

    70 </p>

    71 <p>

    72 <a href="../reference-cpp/F32_EKA2/TFindFileClass.html#%3a%3aTFindFile%3a%3aFindWildByPath%28%29" title="function TFindFile::FindWildByPath()"><code class="ApiItem">TFindFile::FindWildByPath()</code></a>

    73 </p>

    74 <code>3</code>

    75 <p>

    76 <em>Not used.</em>

    77 </p>

    78 <code>4</code>

    79 <p>

    80 <em>Not used.</em>

    81 </p>

    82 <code>5</code>

    83 <p>

    84 This panic is raised by a call to

    85 <a href="../reference-cpp/F32_EKA2/TFileTextClass.html#%3a%3aTFileText%3a%3aSeek%28%29" title="function TFileText::Seek()"><code class="ApiItem">TFileText::Seek()</code></a> when the seek mode passed to the

    86 function is neither <a href="../reference-cpp/F32_EKA2/TSeekEnum.html#%3a%3aTSeek" title="enum TSeek"><code class="ApiItem">TSeek</code></a><code>::ESeekStart</code> nor

    87 <a href="../reference-cpp/F32_EKA2/TSeekEnum.html#%3a%3aTSeek" title="enum TSeek"><code class="ApiItem">TSeek</code></a><code>::ESeekEnd</code>. 

    88 </p>

    89 <code>6</code>

    90 <p>

    91 <em>Not used.</em>

    92 </p>

    93 <code>7</code>

    94 </p>

    95 <p>

    96 <em>Not used.</em>

    97 </p>

    98 <code>8</code>

    99 <p>

   100 <em>Not used.</em>

   101 </p>

   102 <code>9</code>

   103 <p>

   104 <em>Not used.</em>

   105 </p>

   106 <code>10</code>

   107 <p>

   108 This panic is raised by the <a href="../reference-cpp/F32_EKA2/CFileManClass.html#%3a%3aCFileMan" title="class CFileMan"><code class="ApiItem">CFileMan</code></a>

   109 implementation when the operation to be run is undefined. 

   110 </p>

   111 <code>11</code>

   112 <p>

   113 This panic is raised by

   114 <a href="../reference-cpp/F32_EKA2/CFileBaseClass.html#%3a%3aCFileBase%3a%3aCurrentEntry%28%29" title="function CFileBase::CurrentEntry()"><code class="ApiItem">CFileBase::CurrentEntry()</code></a> if there is no current entry. 

   115 </p>

   116 <code>12</code>

   117 <p>

   118 The value returned by the file management observer functions: 

   119 </p>

   120 <p>

   121 <a href="../reference-cpp/F32_EKA2/MFileManObserverClass.html#%3a%3aMFileManObserver%3a%3aNotifyFileManStarted%28%29" title="function MFileManObserver::NotifyFileManStarted()"><code class="ApiItem">MFileManObserver::NotifyFileManStarted()</code></a>

   122 </p>

   123 <p>

   124 <a href="../reference-cpp/F32_EKA2/MFileManObserverClass.html#%3a%3aMFileManObserver%3a%3aNotifyFileManEnded%28%29" title="function MFileManObserver::NotifyFileManEnded()"><code class="ApiItem">MFileManObserver::NotifyFileManEnded()</code></a>

   125 </p>

   126 <p>

   127 <a href="../reference-cpp/F32_EKA2/MFileManObserverClass.html#%3a%3aMFileManObserver%3a%3aNotifyFileManOperation%28%29" title="function MFileManObserver::NotifyFileManOperation()"><code class="ApiItem">MFileManObserver::NotifyFileManOperation()</code></a>

   128 </p>

   129 <p>

   130 is not a valid <a href="../reference-cpp/F32_EKA2/MFileManObserverClass.html#%3a%3aMFileManObserver%3a%3aTControl" title="enum MFileManObserver::TControl"><code class="ApiItem">MFileManObserver::TControl</code></a> enum

   131 value. 

   132 </p>

   133 <code>13</code>

   134 <p>

   135 <em>Not used.</em>

   136 </p>

   137 <code>14</code>

   138 <p>

   139 <em>Not used.</em>

   140 </p>

   141 <code>15</code>

   142 <p>

   143 <i>This panic is raised in debug builds only.</i>

   144 </p>

   145 <p>

   146 This panic is raised in a call to

   147 <a href="../reference-cpp/F32_EKA2/CDirScanClass.html#%3a%3aCDirScan%3a%3aSetScanDataL%28%29" title="function CDirScan::SetScanDataL()"><code class="ApiItem">CDirScan::SetScanDataL()</code></a> when the path does not contain at

   148 least one '\' character. 

   149 </p>

   150 <code>16</code>

   151 <p>

   152 <em>Not used.</em>

   153 </p>

   154 <code>17</code>

   155 <p>

   156 This panic is raised by <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aLock%28%29" title="function RFile::Lock()"><code class="ApiItem">RFile::Lock()</code></a> when the

   157 number of bytes defining the region to be locked is either zero or negative. 

   158 </p>

   159 <code>18</code>

   160 <p>

   161 This panic is raised by <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aUnLock%28%29" title="function RFile::UnLock()"><code class="ApiItem">RFile::UnLock()</code></a> when

   162 the number of bytes defining the region to be unlocked is either zero or

   163 negative. 

   164 </p>

   165 <code>19</code>

   166 <p>

   167 All variants of the <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aRead%28%29" title="function RFile::Read()"><code class="ApiItem">RFile::Read()</code></a> and

   168 <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aWrite%28%29" title="function RFile::Write()"><code class="ApiItem">RFile::Write()</code></a> functions take an argument denoting an

   169 offset value, in bytes, from the start of a file; the panic is raised by these

   170 functions when the offset value is negative. 

   171 </p>

   172 <code>20</code>

   173 <p>

   174 This panic is raised by <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aSetSize%28%29" title="function RFile::SetSize()"><code class="ApiItem">RFile::SetSize()</code></a> when

   175 the argument denoting the size of the new file is negative. 

   176 </p>

   177 <code>21</code>

   178 <p>

   179 This panic is raised by <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aSetAtt%28%29" title="function RFile::SetAtt()"><code class="ApiItem">RFile::SetAtt()</code></a> and

   180 <a href="../reference-cpp/F32_EKA2/RFileClass.html#%3a%3aRFile%3a%3aSet%28%29" title="function RFile::Set()"><code class="ApiItem">RFile::Set()</code></a> when the same attribute bit is set in both

   181 the bitmask that indicates the file attributes to be set and the bitmask that

   182 indicates the attributes to be cleared. 

   183 </p>

   184 <code>22</code>

   185 <p>

   186 The panic is raised by the <code>[]</code> operator of

   187 <a href="../reference-cpp/F32_EKA2/TEntryArrayClass.html#%3a%3aTEntryArray" title="class TEntryArray"><code class="ApiItem">TEntryArray</code></a>, when the index value passed to the operator

   188 is greater than or equal to the number of elements in the array. 

   189 </p>

   190 <code>23</code>

   191 <p>

   192 This panic is raised by <a href="../reference-cpp/F32_EKA2/CDirClass.html#%3a%3aCDir%3a%3aSort%28%29" title="function CDir::Sort()"><code class="ApiItem">CDir::Sort()</code></a> when the

   193 method of sorting, as defined by the single function argument, is none of the

   194 entries: 

   195 </p>

   196 <p>

   197 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortNone</code>

   198 </p>

   199 <p>

   200 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortByDate</code>

   201 </p>

   202 <p>

   203 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortBySize</code>

   204 </p>

   205 <p>

   206 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortByExt</code>

   207 </p>

   208 <p>

   209 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortByUid</code>

   210 </p>

   211 <p>

   212 <a href="../reference-cpp/F32_EKA2/TEntryKeyEnum.html#%3a%3aTEntryKey" title="enum TEntryKey"><code class="ApiItem">TEntryKey</code></a><code>::ESortByName</code>

   213 </p>

   214 <code>24</code>

   215 <p>

   216 This panic is raised by the <a href="../reference-cpp/F32_EKA2/TParsePtrClass.html#%3a%3aTParsePtr" title="class TParsePtr"><code class="ApiItem">TParsePtr</code></a>

   217 constructor that takes a reference to a filename, when the name cannot be

   218 parsed. 

   219 </p>

   220 <code>25</code>

   221 <p>

   222 This panic is raised by the <a href="../reference-cpp/F32_EKA2/TParsePtrCClass.html#%3a%3aTParsePtrC" title="class TParsePtrC"><code class="ApiItem">TParsePtrC</code></a>

   223 constructor that takes a const reference to a filename, when the name cannot be

   224 parsed. 

   225 </p>

   226 <code>26</code>

   227 <p>

   228 This panic is raised by <a href="../reference-cpp/F32_EKA2/RFsClass.html#%3a%3aRFs%3a%3aReadFileSection%28%29" title="function RFs::ReadFileSection()"><code class="ApiItem">RFs::ReadFileSection()</code></a>

   229 when the specified number of bytes to be read from the file is greater than the

   230 maximum length of the target descriptor. 

   231 </p>

   232 <code>27</code>

   233 <p>

   234 <i>This panic is raised in debug builds only.</i>

   235 </p>

   236 <p>

   237 This panic is raised by the <code class="ApiItem">RFile::Write(const

   238 TDesC8&amp;,TInt)</code> variant when the specified length is greater than

   239 the length of the source descriptor. 

   240 </p>

   241