Symbian3/PDK/Source/GUID-1D25050A-4CC2-5017-BBE8-7AC380BAC027.dita
changeset 5 f345bda72bc4
child 14 578be2adaf3e
equal deleted inserted replaced
4:4816d766a08a 5:f345bda72bc4
       
     1 <?xml version="1.0" encoding="utf-8"?>
       
     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
       
     3 <!-- This component and the accompanying materials are made available under the terms of the License 
       
     4 "Eclipse Public License v1.0" which accompanies this distribution, 
       
     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
       
     6 <!-- Initial Contributors:
       
     7     Nokia Corporation - initial contribution.
       
     8 Contributors: 
       
     9 -->
       
    10 <!DOCTYPE concept
       
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
       
    12 <concept id="GUID-1D25050A-4CC2-5017-BBE8-7AC380BAC027" xml:lang="en"><title>Category:
       
    13 FSCLIENT Panic</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <p>Panics with this category are raised on clients requesting services provided
       
    15 by the file server. Typically, they are caused by passing bad or contradictory
       
    16 values to class constructors or member functions. </p>
       
    17 <p>The thread causing the panic is terminated. </p>
       
    18 <p>To avoid confusion, we need to emphasise that the panic category is the
       
    19 14 character string <i>FSCLIENT panic</i>, and that the word panic is part
       
    20 of the panic category. </p>
       
    21 <table id="GUID-247E0C7D-0DBB-5873-8C05-A25A5EFFE6C7">
       
    22 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
       
    23 <tbody>
       
    24 <row>
       
    25 <entry><p> <codeph>0</codeph>  </p> </entry>
       
    26 <entry><p>This panic is raised by: </p> <ul>
       
    27 <li id="GUID-ED8D9E1E-8FAA-543B-9729-FDAC7BE30E2F"><p>the <codeph>TDriveUnit(TInt
       
    28 aDrive)</codeph> variant of the <xref href="GUID-9BDD476C-04E1-3271-AFD9-8F86D818CE46.dita"><apiname>TDriveUnit</apiname></xref> constructor, </p> </li>
       
    29 <li id="GUID-EACAAFC7-D828-5054-9B71-737E3968AC40"><p>the <codeph>(TInt aDrive)</codeph> variant
       
    30 of the <xref href="GUID-9BDD476C-04E1-3271-AFD9-8F86D818CE46.dita"><apiname>TDriveUnit</apiname></xref> assignment operator </p> </li>
       
    31 </ul> <p>when the specified drive number is greater than or equal to <codeph>KMaxDrives</codeph>,
       
    32 i.e. 26. </p> </entry>
       
    33 </row>
       
    34 <row>
       
    35 <entry><p> <codeph>1</codeph>  </p> </entry>
       
    36 <entry><p>This panic is raised by: </p> <ul>
       
    37 <li id="GUID-77317522-EAF0-59D3-9EF6-FDDF9891B5D4"><p>the <codeph>TDriveUnit(const
       
    38 TDesC&amp; aDriveText)</codeph> variant of the <xref href="GUID-9BDD476C-04E1-3271-AFD9-8F86D818CE46.dita"><apiname>TDriveUnit</apiname></xref> constructor, </p> </li>
       
    39 <li id="GUID-91779A42-CBD7-5533-A74E-5335B64B1123"><p>the <codeph>(const TDesC&amp;
       
    40 aDriveText)</codeph> variant of the <xref href="GUID-9BDD476C-04E1-3271-AFD9-8F86D818CE46.dita"><apiname>TDriveUnit</apiname></xref> assignment
       
    41 operator </p> </li>
       
    42 </ul> <p>when the specified drive letter is invalid, i.e. does not correspond
       
    43 to a drive number. </p> </entry>
       
    44 </row>
       
    45 <row>
       
    46 <entry><p> <codeph>2</codeph>  </p> </entry>
       
    47 <entry><p>This panic is raised when searching for the next file using <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-5CF0E979-3A6F-3CC6-9D1A-56FE50B7A0AC"><apiname>TFindFile::Find()</apiname></xref> or <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-095CE56D-FFCB-3756-A2D2-71036360A4A7"><apiname>TFindFile::FindWild()</apiname></xref> before the initial call specifying the search method. </p> <p>Calls to <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-5CF0E979-3A6F-3CC6-9D1A-56FE50B7A0AC"><apiname>TFindFile::Find()</apiname></xref> cannot
       
    48 be made until an initial call has been made to either of: </p> <ul>
       
    49 <li id="GUID-6628C775-90D5-5DFE-8676-1F6B884B976A"><p> <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-8C931E8E-7C5F-3EA5-9B87-8073E21CDDA6"><apiname>TFindFile::FindByDir()</apiname></xref>  </p> </li>
       
    50 <li id="GUID-FBA409DA-C9D0-5F09-A2EE-F8ADD902969D"><p> <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-6FF65FD0-86E6-3785-BEE8-23DB483DE130"><apiname>TFindFile::FindByPath()</apiname></xref>  </p> </li>
       
    51 </ul> <p>Calls to <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-095CE56D-FFCB-3756-A2D2-71036360A4A7"><apiname>TFindFile::FindWild()</apiname></xref> cannot be made
       
    52 until an initial call has been made to either of: </p> <ul>
       
    53 <li id="GUID-107C27C2-2DB0-5590-A896-D942CFE5497B"><p> <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-15BA9901-0159-33F0-B2F0-EEBD72EA2E17"><apiname>TFindFile::FindWildByDir()</apiname></xref>  </p> </li>
       
    54 <li id="GUID-AC2B1F94-EB71-525B-8680-CFAF01C87853"><p> <xref href="GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA.dita#GUID-98CC1E75-D2DE-3700-928C-7D530237ECBA/GUID-EFCA111B-808A-3AF8-903F-2E4CA5F7375B"><apiname>TFindFile::FindWildByPath()</apiname></xref>  </p> </li>
       
    55 </ul> </entry>
       
    56 </row>
       
    57 <row>
       
    58 <entry><p> <codeph>3</codeph>  </p> </entry>
       
    59 <entry><p> <i>Not used.</i>  </p> </entry>
       
    60 </row>
       
    61 <row>
       
    62 <entry><p> <codeph>4</codeph>  </p> </entry>
       
    63 <entry><p> <i>Not used.</i>  </p> </entry>
       
    64 </row>
       
    65 <row>
       
    66 <entry><p> <codeph>5</codeph>  </p> </entry>
       
    67 <entry><p>This panic is raised by a call to <xref href="GUID-95310602-EA12-3AEE-BDBD-F750FC17CAC4.dita#GUID-95310602-EA12-3AEE-BDBD-F750FC17CAC4/GUID-EBEDA043-5E46-3082-B473-62885DAC591C"><apiname>TFileText::Seek()</apiname></xref> when
       
    68 the seek mode passed to the function is neither <xref href="GUID-CA98DC2A-4B7D-336D-A251-C29120DDD444.dita#GUID-CA98DC2A-4B7D-336D-A251-C29120DDD444/GUID-002917A4-A1E6-3FBB-B133-A0734AB5C4DA"><apiname>TSeek::ESeekStart()</apiname></xref> nor <xref href="GUID-CA98DC2A-4B7D-336D-A251-C29120DDD444.dita#GUID-CA98DC2A-4B7D-336D-A251-C29120DDD444/GUID-5B88CF12-C882-33C8-833B-B4B9978431E7"><apiname>TSeek::ESeekEnd()</apiname></xref>. </p> </entry>
       
    69 </row>
       
    70 <row>
       
    71 <entry><p> <codeph>6</codeph>  </p> </entry>
       
    72 <entry><p> <i>Not used.</i>  </p> </entry>
       
    73 </row>
       
    74 <row>
       
    75 <entry><p> <codeph>7</codeph>  </p> </entry>
       
    76 <entry><p> <i>Not used.</i>  </p> </entry>
       
    77 </row>
       
    78 <row>
       
    79 <entry><p> <codeph>8</codeph>  </p> </entry>
       
    80 <entry><p> <i>Not used.</i>  </p> </entry>
       
    81 </row>
       
    82 <row>
       
    83 <entry><p> <codeph>9</codeph>  </p> </entry>
       
    84 <entry><p> <i>Not used.</i>  </p> </entry>
       
    85 </row>
       
    86 <row>
       
    87 <entry><p> <codeph>10</codeph>  </p> </entry>
       
    88 <entry><p>This panic is raised by the <xref href="GUID-82CEC14F-1479-3922-846A-9FCDB6465EF7.dita"><apiname>CFileMan</apiname></xref> implementation
       
    89 when the operation to be run is undefined. </p> </entry>
       
    90 </row>
       
    91 <row>
       
    92 <entry><p> <codeph>11</codeph>  </p> </entry>
       
    93 <entry><p>This panic is raised by <xref href="GUID-C1C0C7F9-2665-3475-B70F-61C41291BB4D.dita#GUID-C1C0C7F9-2665-3475-B70F-61C41291BB4D/GUID-9EC41897-DE6E-31EB-A092-4EFD608D6E0D"><apiname>CFileBase::CurrentEntry()</apiname></xref> if
       
    94 there is no current entry. </p> </entry>
       
    95 </row>
       
    96 <row>
       
    97 <entry><p> <codeph>12</codeph>  </p> </entry>
       
    98 <entry><p>The value returned by the file management observer functions: </p> <ul>
       
    99 <li id="GUID-8CC343EF-A37D-51FA-B7FB-F3FDAA8AC16F"><p> <xref href="GUID-E608485F-B3E3-3310-A80E-169D8B9D2234.dita#GUID-E608485F-B3E3-3310-A80E-169D8B9D2234/GUID-54D77B42-2AD9-3F82-89A7-3E651FAC2670"><apiname>MFileManObserver::NotifyFileManStarted()</apiname></xref>  </p> </li>
       
   100 <li id="GUID-A6D0E7B3-8776-50F0-8FA4-454B5235CF65"><p> <xref href="GUID-E608485F-B3E3-3310-A80E-169D8B9D2234.dita#GUID-E608485F-B3E3-3310-A80E-169D8B9D2234/GUID-A73812AF-0877-3322-90C9-8A8F43708C8E"><apiname>MFileManObserver::NotifyFileManEnded()</apiname></xref>  </p> </li>
       
   101 <li id="GUID-64372697-7364-558D-B216-35D721DBB655"><p> <xref href="GUID-E608485F-B3E3-3310-A80E-169D8B9D2234.dita#GUID-E608485F-B3E3-3310-A80E-169D8B9D2234/GUID-8D17D294-DE4A-3382-A832-9D318F522DE6"><apiname>MFileManObserver::NotifyFileManOperation()</apiname></xref> </p> </li>
       
   102 </ul> <p>is not a valid <xref href="GUID-E608485F-B3E3-3310-A80E-169D8B9D2234.dita#GUID-E608485F-B3E3-3310-A80E-169D8B9D2234/GUID-3147D2FB-F840-3780-8697-5053CA7EEF6D"><apiname>MFileManObserver::TControl()</apiname></xref> enum
       
   103 value. </p> </entry>
       
   104 </row>
       
   105 <row>
       
   106 <entry><p> <codeph>13</codeph>  </p> </entry>
       
   107 <entry><p> <i>Not used.</i>  </p> </entry>
       
   108 </row>
       
   109 <row>
       
   110 <entry><p> <codeph>14</codeph>  </p> </entry>
       
   111 <entry><p> <i>Not used.</i>  </p> </entry>
       
   112 </row>
       
   113 <row>
       
   114 <entry><p> <codeph>15</codeph>  </p> </entry>
       
   115 <entry><p> <i>This panic is raised in debug builds only.</i>  </p> <p>This
       
   116 panic is raised in a call to <xref href="GUID-C657AF2D-1183-3CD2-ACAF-3B0B00FC91BB.dita#GUID-C657AF2D-1183-3CD2-ACAF-3B0B00FC91BB/GUID-904B65E6-61DE-3A5D-A5E1-E7577D0FD2BB"><apiname>CDirScan::SetScanDataL()</apiname></xref> when
       
   117 the path does not contain at least one '\' character. </p> </entry>
       
   118 </row>
       
   119 <row>
       
   120 <entry><p> <codeph>16</codeph>  </p> </entry>
       
   121 <entry><p> <i>Not used.</i>  </p> </entry>
       
   122 </row>
       
   123 <row>
       
   124 <entry><p> <codeph>17</codeph>  </p> </entry>
       
   125 <entry><p>This panic is raised by <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-4B12909C-0BC6-3FFE-8825-FA98312F74C2"><apiname>RFile::Lock()</apiname></xref> when the
       
   126 number of bytes defining the region to be locked is either zero or negative. </p> </entry>
       
   127 </row>
       
   128 <row>
       
   129 <entry><p> <codeph>18</codeph>  </p> </entry>
       
   130 <entry><p>This panic is raised by <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-9083CCAD-F9ED-36FB-9C80-79D2F1B46B77"><apiname>RFile::UnLock()</apiname></xref> when
       
   131 the number of bytes defining the region to be unlocked is either zero or negative. </p> </entry>
       
   132 </row>
       
   133 <row>
       
   134 <entry><p> <codeph>19</codeph>  </p> </entry>
       
   135 <entry><p>All variants of the <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-94CCC141-8E26-3FA3-A222-D9A658AEA8A9"><apiname>RFile::Read()</apiname></xref> and <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-325997F1-3252-358E-B278-44D3A5418FAC"><apiname>RFile::Write()</apiname></xref> functions
       
   136 take an argument denoting an offset value, in bytes, from the start of a file;
       
   137 the panic is raised by these functions when the offset value is negative. </p> </entry>
       
   138 </row>
       
   139 <row>
       
   140 <entry><p> <codeph>20</codeph>  </p> </entry>
       
   141 <entry><p>This panic is raised by <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-8592B60E-70E7-37D6-AFD2-4D2A1A87C886"><apiname>RFile::SetSize()</apiname></xref> when
       
   142 the argument denoting the size of the new file is negative. </p> </entry>
       
   143 </row>
       
   144 <row>
       
   145 <entry><p> <codeph>21</codeph>  </p> </entry>
       
   146 <entry><p>This panic is raised by <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-5CF35AAD-5D0E-356D-8E07-2948C191226E"><apiname>RFile::SetAtt()</apiname></xref> and <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-07929B06-ADEF-3BDF-97E8-9ACD7E105EFA"><apiname>RFile::Set()</apiname></xref> when
       
   147 the same attribute bit is set in both the bitmask that indicates the file
       
   148 attributes to be set and the bitmask that indicates the attributes to be cleared. </p> </entry>
       
   149 </row>
       
   150 <row>
       
   151 <entry><p> <codeph>22</codeph>  </p> </entry>
       
   152 <entry><p>The panic is raised by the <codeph>[]</codeph> operator of <xref href="GUID-0355B083-6DD8-30F0-BEDF-B6BE745E2AB6.dita"><apiname>TEntryArray</apiname></xref>,
       
   153 when the index value passed to the operator is greater than or equal to the
       
   154 number of elements in the array. </p> </entry>
       
   155 </row>
       
   156 <row>
       
   157 <entry><p> <codeph>23</codeph>  </p> </entry>
       
   158 <entry><p>This panic is raised by <xref href="GUID-15AEDE72-80FF-3689-A771-E00F1CF3EB88.dita#GUID-15AEDE72-80FF-3689-A771-E00F1CF3EB88/GUID-58902A06-4882-3BDD-AB36-82F9002C958E"><apiname>CDir::Sort()</apiname></xref> when the
       
   159 method of sorting, as defined by the single function argument, is none of
       
   160 the entries: </p> <ul>
       
   161 <li id="GUID-B154F18B-0F13-59FA-A03C-C1965BB18EC5"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-FB1EE9D2-4AE7-3B56-9E62-5047680FB645"><apiname>TEntryKey::ESortNone()</apiname></xref>  </p> </li>
       
   162 <li id="GUID-0E3B05EC-FD57-5573-B91F-F9B28AF601D4"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-566D8D24-4413-3A4B-9DDE-724803331462"><apiname>TEntryKey::ESortByDate()</apiname></xref>  </p> </li>
       
   163 <li id="GUID-BB51F6FB-55FD-596C-953C-E7B68E7C1B40"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-4A4AB0DC-F743-3F5F-B53D-289955F333B9"><apiname>TEntryKey::ESortBySize()</apiname></xref>  </p> </li>
       
   164 <li id="GUID-25B1E042-5C5E-59E1-AF3D-D694FE91496A"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-3427F521-49DE-30B3-BFE1-C5D193475EC9"><apiname>TEntryKey::ESortByExt()</apiname></xref>  </p> </li>
       
   165 <li id="GUID-79D81DEF-1098-58DA-ADB9-FCC6B9790BC6"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-141E1837-D913-39BE-9257-6CCEB40CE194"><apiname>TEntryKey::ESortByUid()</apiname></xref>  </p> </li>
       
   166 <li id="GUID-A3D55FFF-A2D6-5644-8880-27A05A2F09E8"><p> <xref href="GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E.dita#GUID-3110DC70-6DE1-3F80-82C0-74CD37782F2E/GUID-0626B5FC-7CCC-3870-8594-30A1F5D20FD4"><apiname>TEntryKey::ESortByName()</apiname></xref>  </p> </li>
       
   167 </ul> </entry>
       
   168 </row>
       
   169 <row>
       
   170 <entry><p> <codeph>24</codeph>  </p> </entry>
       
   171 <entry><p>This panic is raised by the <xref href="GUID-A6268E58-68EC-3041-93FD-5368CD230947.dita"><apiname>TParsePtr</apiname></xref> constructor
       
   172 that takes a reference to a filename, when the name cannot be parsed. </p> </entry>
       
   173 </row>
       
   174 <row>
       
   175 <entry><p> <codeph>25</codeph>  </p> </entry>
       
   176 <entry><p>This panic is raised by the <xref href="GUID-C65BCDAB-0476-3EAC-9BFC-37243AE43FE9.dita"><apiname>TParsePtrC</apiname></xref> constructor
       
   177 that takes a const reference to a filename, when the name cannot be parsed. </p> </entry>
       
   178 </row>
       
   179 <row>
       
   180 <entry><p> <codeph>26</codeph>  </p> </entry>
       
   181 <entry><p>This panic is raised by <xref href="GUID-E263C747-946F-35AA-9F1D-41833BD350FC.dita#GUID-E263C747-946F-35AA-9F1D-41833BD350FC/GUID-765B2E18-8062-3FF4-8E82-BBD54DC28EC9"><apiname>RFs::ReadFileSection()</apiname></xref> when
       
   182 the specified number of bytes to be read from the file is greater than the
       
   183 maximum length of the target descriptor. </p> </entry>
       
   184 </row>
       
   185 <row>
       
   186 <entry><p> <codeph>27</codeph>  </p> </entry>
       
   187 <entry><p> <i>This panic is raised in debug builds only.</i>  </p> <p>This
       
   188 panic is raised by the <xref href="GUID-BE0804F6-4375-3C8A-8C83-968F510466E0.dita#GUID-BE0804F6-4375-3C8A-8C83-968F510466E0/GUID-DBEDBF4B-C944-3F9F-9F94-E5408745FD84"><apiname>RFile::Write(const                 TDesC8&amp;,TInt)</apiname></xref> variant
       
   189 when the specified length is greater than the length of the source descriptor. </p> </entry>
       
   190 </row>
       
   191 </tbody>
       
   192 </tgroup>
       
   193 </table></conbody></concept>