/core/sdk-objc/Documentation/GMUserFileSystem/Categories/NSObject_GMUserFileSystemOperations_/CompositePage.html

http://macfuse.googlecode.com/ · HTML · 923 lines · 902 code · 21 blank · 0 comment · 0 complexity · 50f1a34483b2dc215164479e3a9a8b41 MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>NSObject(GMUserFileSystemOperations) </title>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    6. 

  6. <meta name="generator" content="HeaderDoc">
    7. 

  7. <style type="text/css"><!--.keyword {background:#ffffff; color:#761550;}.template {background:#ffffff; color:#761550;}.number {background: #ffffff; color:#0000ff;}.function {background:#ffffff; color:#000000;}.string {background: #ffffff; color:#891315;}.preprocessor {background:#ffffff; color:#236e25}.comment {background:#ffffff; color:#236e25}.char {background: #ffffff; color:#0000ff;}.var {background:#ffffff; color:#000000;}.type {background:#ffffff; color:#761550;}.param {background:#ffffff; color:#000000;}a:link {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:active {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}h4 {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: tiny; font-weight: bold;}body {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: 10pt;}--></style>
    8. 

  8. </head>
    9. 

  9. <body bgcolor="#ffffff">
    10. 

  10. <a name="top"></a><a name="//apple_ref/doc/class/NSObject(GMUserFileSystemOperations)" title="NSObject(GMUserFileSystemOperations) "></a><hr>
    11. 

  11. <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    12. 

  12. <h1><a name="NSObject(GMUserFileSystemOperations)">NSObject(GMUserFileSystemOperations) </a></h1>
    13. 

  13. </td></tr></table>
    14. 

  14. <hr>
    15. 

  15. <p><b>Extends&nbsp;Class:</b> <!-- a logicalPath="//apple_ref/occ/cl/NSObject" -->NSObject<!-- /a --><br><b>Declared In:</b> <a href="../../index.html" target="_top">GMUserFileSystem</a><br></p>
    16. 

  16. <h5 class="tight">
    17. 

  17. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    18. 

  18. </h5>
    19. 

  19. <p><!-- begin discussion --> The core set of file system operations the delegate must implement.
    20. 

  20. Unless otherwise noted, they typically should behave like the NSFileManager 
    21. 

  21. equivalent. However, the error codes that they return should correspond to
    22. 

  22. the BSD-equivalent call and be in the NSPOSIXErrorDomain.<br><br>
    23. 

  23. For a read-only filesystem, you can typically pick-and-choose which methods
    24. 

  24. to implement.  For example, a minimal read-only filesystem might implement:</p>
    25. 

  25. <ul>
    26. 

  26. - (NSArray *)contentsOfDirectoryAtPath:(NSString *)path 
    27. 

  27. error:(NSError **)error;<br>
    28. 

  28. - (NSDictionary *)attributesOfItemAtPath:(NSString *)path
    29. 

  29. userData:(id)userData
    30. 

  30. error:(NSError **)error;<br>
    31. 

  31. - (NSData *)contentsAtPath:(NSString *)path;</ul>
    32. 

  32. <p>
    33. 

  33. For a writeable filesystem, the Finder can be quite picky unless the majority
    34. 

  34. of these methods are implemented. However, you can safely skip hard-links, 
    35. 

  35. symbolic links, and extended attributes.
    36. 

  36.  <!-- end discussion --></p>
    37. 

  37. <p></p>
    38. 

  38. <hr>
    39. 

  39. <br><h2>Methods</h2>
    40. 

  40. <a name="HeaderDoc_methods"></a><dl>
    41. 

  41. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsOfDirectoryAtPath:error:" target="_top">-contentsOfDirectoryAtPath:error: </a></tt></dt>
    42. 

  42. <dd>Returns directory contents at the specified path.
    43. 

  43. </dd>
    44. 

  44. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfItemAtPath:userData:error:" target="_top">-attributesOfItemAtPath:userData:error: </a></tt></dt>
    45. 

  45. <dd>Returns attributes at the specified path.
    46. 

  46. </dd>
    47. 

  47. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfFileSystemForPath:error:" target="_top">-attributesOfFileSystemForPath:error: </a></tt></dt>
    48. 

  48. <dd>Returns file system attributes.
    49. 

  49. </dd>
    50. 

  50. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/setAttributes:ofItemAtPath:userData:error:" target="_top">-setAttributes:ofItemAtPath:userData:error: </a></tt></dt>
    51. 

  51. <dd>Set attributes at the specified path.
    52. 

  52. </dd>
    53. 

  53. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsAtPath:" target="_top">-contentsAtPath: </a></tt></dt>
    54. 

  54. <dd>Returns directory contents at the specified path.
    55. 

  55. </dd>
    56. 

  56. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/openFileAtPath:mode:userData:error:" target="_top">-openFileAtPath:mode:userData:error: </a></tt></dt>
    57. 

  57. <dd>Opens the file at the given path for read/write.
    58. 

  58. </dd>
    59. 

  59. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/releaseFileAtPath:userData:" target="_top">-releaseFileAtPath:userData: </a></tt></dt>
    60. 

  60. <dd>Called when an opened file is closed.
    61. 

  61. </dd>
    62. 

  62. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/readFileAtPath:userData:buffer:size:offset:error:" target="_top">-readFileAtPath:userData:buffer:size:offset:error: </a></tt></dt>
    63. 

  63. <dd>Reads data from the open file at the specified path.
    64. 

  64. </dd>
    65. 

  65. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/writeFileAtPath:userData:buffer:size:offset:error:" target="_top">-writeFileAtPath:userData:buffer:size:offset:error: </a></tt></dt>
    66. 

  66. <dd>Writes data to the open file at the specified path.
    67. 

  67. </dd>
    68. 

  68. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/exchangeDataOfItemAtPath:withItemAtPath:error:" target="_top">-exchangeDataOfItemAtPath:withItemAtPath:error: </a></tt></dt>
    69. 

  69. <dd>Atomically exchanges data between files.
    70. 

  70. </dd>
    71. 

  71. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/createDirectoryAtPath:attributes:error:" target="_top">-createDirectoryAtPath:attributes:error: </a></tt></dt>
    72. 

  72. <dd>Creates a directory at the specified path.
    73. 

  73. </dd>
    74. 

  74. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/createFileAtPath:attributes:userData:error:" target="_top">-createFileAtPath:attributes:userData:error: </a></tt></dt>
    75. 

  75. <dd>Creates and opens a file at the specified path.
    76. 

  76. </dd>
    77. 

  77. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/moveItemAtPath:toPath:error:" target="_top">-moveItemAtPath:toPath:error: </a></tt></dt>
    78. 

  78. <dd>Moves or renames an item.
    79. 

  79. </dd>
    80. 

  80. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/removeDirectoryAtPath:error:" target="_top">-removeDirectoryAtPath:error: </a></tt></dt>
    81. 

  81. <dd>Remove the directory at the given path.
    82. 

  82. </dd>
    83. 

  83. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/removeItemAtPath:error:" target="_top">-removeItemAtPath:error: </a></tt></dt>
    84. 

  84. <dd>Removes the item at the given path.
    85. 

  85. </dd>
    86. 

  86. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/linkItemAtPath:toPath:error:" target="_top">-linkItemAtPath:toPath:error:</a></tt></dt>
    87. 

  87. <dd>Creates a hard link.
    88. 

  88. </dd>
    89. 

  89. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/createSymbolicLinkAtPath:withDestinationPath:error:" target="_top">-createSymbolicLinkAtPath:withDestinationPath:error:</a></tt></dt>
    90. 

  90. <dd>Creates a symbolic link.
    91. 

  91. </dd>
    92. 

  92. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/destinationOfSymbolicLinkAtPath:error:" target="_top">-destinationOfSymbolicLinkAtPath:error:</a></tt></dt>
    93. 

  93. <dd>Reads the destination of a symbolic link.
    94. 

  94. </dd>
    95. 

  95. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/extendedAttributesOfItemAtPath:error:" target="_top">-extendedAttributesOfItemAtPath:error: </a></tt></dt>
    96. 

  96. <dd>Returns the names of the extended attributes at the specified path.
    97. 

  97. </dd>
    98. 

  98. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/valueOfExtendedAttribute:ofItemAtPath:position:error:" target="_top">-valueOfExtendedAttribute:ofItemAtPath:position:error:</a></tt></dt>
    99. 

  99. <dd>Returns the contents of the extended attribute at the specified path.
    100. 

  100. </dd>
    101. 

  101. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/setExtendedAttribute:ofItemAtPath:value:position:options:error:" target="_top">-setExtendedAttribute:ofItemAtPath:value:position:options:error:</a></tt></dt>
    102. 

  102. <dd>Writes the contents of the extended attribute at the specified path.
    103. 

  103. </dd>
    104. 

  104. <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/removeExtendedAttribute:ofItemAtPath:error:" target="_top">-removeExtendedAttribute:ofItemAtPath:error:</a></tt></dt>
    105. 

  105. <dd>Removes the extended attribute at the specified path.
    106. 

  106. </dd>
    107. 

  107. </dl>
    108. 

  108. <hr>
    109. 

  109. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsOfDirectoryAtPath:error:;  name=NSObject(GMUserFileSystemOperations)::contentsOfDirectoryAtPath:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsOfDirectoryAtPath:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    110. 

  110. <h3><a name="contentsOfDirectoryAtPath:error:">contentsOfDirectoryAtPath:error: </a></h3>
    111. 

  111. </td></tr></table>
    112. 

  112. <hr>
    113. 

  113. <p><!-- begin abstract -->Returns directory contents at the specified path.
    114. 

  114. <!-- end abstract --></p>
    115. 

  115. <p></p>
    116. 

  116. <b>See Also:</b><blockquote><dl>
    117. 

  117. <dt>
    118. 

  118. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->readdir(3)<!-- /a -->
    119. 

  119. </dt>
    120. 

  120. <dd></dd>
    121. 

  121. </dl></blockquote>
    122. 

  122. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSArray //apple_ref/occ/tdef/NSArray //apple_ref/occ/tag/NSArray //apple_ref/occ/econst/NSArray //apple_ref/occ/struct/NSArray //apple_ref/occ/clconst/NSArray //apple_ref/occ/intf/NSArray" --><span class="type">NSArray</span><!-- /a --> <span class="type">*</span>)<!-- a logicalPath="//apple_ref/occ/instm/contentsOfDirectoryAtPath //apple_ref/occ/clm/contentsOfDirectoryAtPath //apple_ref/occ/intfcm/contentsOfDirectoryAtPath //apple_ref/occ/intfm/contentsOfDirectoryAtPath //apple_ref/occ/func/contentsOfDirectoryAtPath //apple_ref/occ/ftmplt/contentsOfDirectoryAtPath //apple_ref/occ/defn/contentsOfDirectoryAtPath //apple_ref/occ/macro/contentsOfDirectoryAtPath" --><span class="function">contentsOfDirectoryAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> 
    123. 

  123.         <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>;</pre>
    124. 

  124. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    125. 

  125. <dl>
    126. 

  126. <dt><code>path </code></dt>
    127. 

  127. <dd>The path to a directory.</dd>
    128. 

  128. <dt><code>error </code></dt>
    129. 

  129. <dd>Should be filled with a POSIX error in case of failure.</dd>
    130. 

  130. </dl>
    131. 

  131. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    132. 

  132. <p><!-- begin return value -->An array of NSString or nil on error.
    133. 

  133.  
    134. 

  134. <!-- end return value --></p>
    135. 

  135. <h5 class="tight">
    136. 

  136. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    137. 

  137. </h5>
    138. 

  138. <p><!-- begin discussion -->Returns an array of NSString containing the names of files and
    139. 

  139. sub-directories in the specified directory.
    140. 

  140. <!-- end discussion --></p>
    141. 

  141. <p></p>
    142. 

  142. <hr>
    143. 

  143. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfItemAtPath:userData:error:;  name=NSObject(GMUserFileSystemOperations)::attributesOfItemAtPath:userData:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfItemAtPath:userData:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    144. 

  144. <h3><a name="attributesOfItemAtPath:userData:error:">attributesOfItemAtPath:userData:error: </a></h3>
    145. 

  145. </td></tr></table>
    146. 

  146. <hr>
    147. 

  147. <p><!-- begin abstract -->Returns attributes at the specified path.
    148. 

  148. <!-- end abstract --></p>
    149. 

  149. <p></p>
    150. 

  150. <b>See Also:</b><blockquote><dl>
    151. 

  151. <dt>
    152. 

  152. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->stat(2), fstat(2)<!-- /a -->
    153. 

  153. </dt>
    154. 

  154. <dd></dd>
    155. 

  155. </dl></blockquote>
    156. 

  156. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSDictionary //apple_ref/occ/tdef/NSDictionary //apple_ref/occ/tag/NSDictionary //apple_ref/occ/econst/NSDictionary //apple_ref/occ/struct/NSDictionary //apple_ref/occ/clconst/NSDictionary //apple_ref/occ/intf/NSDictionary" --><span class="type">NSDictionary</span><!-- /a --> <span class="type">*</span>)<!-- a logicalPath="//apple_ref/occ/instm/attributesOfItemAtPath //apple_ref/occ/clm/attributesOfItemAtPath //apple_ref/occ/intfcm/attributesOfItemAtPath //apple_ref/occ/intfm/attributesOfItemAtPath //apple_ref/occ/func/attributesOfItemAtPath //apple_ref/occ/ftmplt/attributesOfItemAtPath //apple_ref/occ/defn/attributesOfItemAtPath //apple_ref/occ/macro/attributesOfItemAtPath" --><span class="function">attributesOfItemAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="param">userData</span> <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>; </pre>
    157. 

  157. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    158. 

  158. <dl>
    159. 

  159. <dt><code>path </code></dt>
    160. 

  160. <dd>The path to the item.</dd>
    161. 

  161. <dt><code>userData </code></dt>
    162. 

  162. <dd>The userData corresponding to this open file or nil.</dd>
    163. 

  163. <dt><code>error </code></dt>
    164. 

  164. <dd>Should be filled with a POSIX error in case of failure.</dd>
    165. 

  165. </dl>
    166. 

  166. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    167. 

  167. <p><!-- begin return value -->A dictionary of attributes or nil on error.
    168. 

  168.  
    169. 

  169. <!-- end return value --></p>
    170. 

  170. <h5 class="tight">
    171. 

  171. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    172. 

  172. </h5>
    173. 

  173. <p><!-- begin discussion -->Returns a dictionary of attributes at the given path. It is required to 
    174. 

  174. return at least the NSFileType attribute. You may omit the NSFileSize
    175. 

  175. attribute if contentsAtPath: is implemented, although this is less efficient.
    176. 

  176. The following keys are currently supported (unknown keys are ignored):</p>
    177. 

  177. <ul>
    178. 

  178. <li>NSFileType [Required]
    179. 

  179. </li>
    180. 

  180. <li>NSFileSize [Recommended]
    181. 

  181. </li>
    182. 

  182. <li>NSFileModificationDate
    183. 

  183. </li>
    184. 

  184. <li>NSFileReferenceCount
    185. 

  185. </li>
    186. 

  186. <li>NSFilePosixPermissions
    187. 

  187. </li>
    188. 

  188. <li>NSFileOwnerAccountID
    189. 

  189. </li>
    190. 

  190. <li>NSFileGroupOwnerAccountID
    191. 

  191. </li>
    192. 

  192. <li>NSFileSystemFileNumber (64-bit on 10.5+)
    193. 

  193. </li>
    194. 

  194. <li>NSFileCreationDate (if supports extended dates)
    195. 

  195. </li>
    196. 

  196. <li>kGMUserFileSystemFileBackupDateKey (if supports extended dates)
    197. 

  197. </li>
    198. 

  198. <li>kGMUserFileSystemFileChangeDateKey
    199. 

  199. </li>
    200. 

  200. <li>kGMUserFileSystemFileAccessDateKey
    201. 

  201. </li>
    202. 

  202. <li>kGMUserFileSystemFileFlagsKey</li>
    203. 

  203. </ul>
    204. 

  204. <br><p>
    205. 

  205. If this is the fstat variant and userData was supplied in openFileAtPath: or 
    206. 

  206. createFileAtPath: then it will be passed back in this call.<br><!-- end discussion --></p>
    207. 

  207. <p></p>
    208. 

  208. <hr>
    209. 

  209. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfFileSystemForPath:error:;  name=NSObject(GMUserFileSystemOperations)::attributesOfFileSystemForPath:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/attributesOfFileSystemForPath:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    210. 

  210. <h3><a name="attributesOfFileSystemForPath:error:">attributesOfFileSystemForPath:error: </a></h3>
    211. 

  211. </td></tr></table>
    212. 

  212. <hr>
    213. 

  213. <p><!-- begin abstract -->Returns file system attributes.
    214. 

  214. <!-- end abstract --></p>
    215. 

  215. <p></p>
    216. 

  216. <b>See Also:</b><blockquote><dl>
    217. 

  217. <dt>
    218. 

  218. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->statvfs(3)<!-- /a -->
    219. 

  219. </dt>
    220. 

  220. <dd></dd>
    221. 

  221. </dl></blockquote>
    222. 

  222. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSDictionary //apple_ref/occ/tdef/NSDictionary //apple_ref/occ/tag/NSDictionary //apple_ref/occ/econst/NSDictionary //apple_ref/occ/struct/NSDictionary //apple_ref/occ/clconst/NSDictionary //apple_ref/occ/intf/NSDictionary" --><span class="type">NSDictionary</span><!-- /a --> <span class="type">*</span>)<!-- a logicalPath="//apple_ref/occ/instm/attributesOfFileSystemForPath //apple_ref/occ/clm/attributesOfFileSystemForPath //apple_ref/occ/intfcm/attributesOfFileSystemForPath //apple_ref/occ/intfm/attributesOfFileSystemForPath //apple_ref/occ/func/attributesOfFileSystemForPath //apple_ref/occ/ftmplt/attributesOfFileSystemForPath //apple_ref/occ/defn/attributesOfFileSystemForPath //apple_ref/occ/macro/attributesOfFileSystemForPath" --><span class="function">attributesOfFileSystemForPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>; </pre>
    223. 

  223. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    224. 

  224. <dl>
    225. 

  225. <dt><code>path </code></dt>
    226. 

  226. <dd>A path on the file system (it is safe to ignore this).</dd>
    227. 

  227. <dt><code>error </code></dt>
    228. 

  228. <dd>Should be filled with a POSIX error in case of failure.</dd>
    229. 

  229. </dl>
    230. 

  230. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    231. 

  231. <p><!-- begin return value -->A dictionary of attributes for the file system.
    232. 

  232.  
    233. 

  233. <!-- end return value --></p>
    234. 

  234. <h5 class="tight">
    235. 

  235. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    236. 

  236. </h5>
    237. 

  237. <p><!-- begin discussion -->Returns a dictionary of attributes for the file system.
    238. 

  238. The following keys are currently supported (unknown keys are ignored):</p>
    239. 

  239. <ul>
    240. 

  240. <li>NSFileSystemSize
    241. 

  241. </li>
    242. 

  242. <li>NSFileSystemFreeSize
    243. 

  243. </li>
    244. 

  244. <li>NSFileSystemNodes
    245. 

  245. </li>
    246. 

  246. <li>NSFileSystemFreeNodes
    247. 

  247. </li>
    248. 

  248. <li>kGMUserFileSystemVolumeSupportsExtendedDatesKey</li>
    249. 

  249. </ul>
    250. 

  250. <br><!-- end discussion --><p></p>
    251. 

  251. <hr>
    252. 

  252. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/setAttributes:ofItemAtPath:userData:error:;  name=NSObject(GMUserFileSystemOperations)::setAttributes:ofItemAtPath:userData:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/setAttributes:ofItemAtPath:userData:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    253. 

  253. <h3><a name="setAttributes:ofItemAtPath:userData:error:">setAttributes:ofItemAtPath:userData:error: </a></h3>
    254. 

  254. </td></tr></table>
    255. 

  255. <hr>
    256. 

  256. <p><!-- begin abstract -->Set attributes at the specified path.
    257. 

  257. <!-- end abstract --></p>
    258. 

  258. <p></p>
    259. 

  259. <b>See Also:</b><blockquote><dl>
    260. 

  260. <dt>
    261. 

  261. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->truncate(2), chown(2), chmod(2), utimes(2), chflags(2),<!-- /a -->
    262. 

  262. </dt>
    263. 

  263. <dd></dd>
    264. 

  264. <dt>
    265. 

  265. <!-- a logicalPath="//apple_ref/occ/cl/ftruncate(2), //apple_ref/occ/tdef/ftruncate(2), //apple_ref/occ/tag/ftruncate(2), //apple_ref/occ/econst/ftruncate(2), //apple_ref/occ/struct/ftruncate(2), //apple_ref/occ/data/ftruncate(2), //apple_ref/occ/clconst/ftruncate(2), //apple_ref/occ/intf/ftruncate(2), //apple_ref/occ/instm/ftruncate(2), //apple_ref/occ/clm/ftruncate(2), //apple_ref/occ/intfcm/ftruncate(2), //apple_ref/occ/intfm/ftruncate(2), //apple_ref/occ/func/ftruncate(2), //apple_ref/occ/ftmplt/ftruncate(2), //apple_ref/occ/defn/ftruncate(2), //apple_ref/occ/macro/ftruncate(2), //apple_ref/doc/com/intfm/ftruncate(2)," -->fchown(2), fchmod(2), futimes(2), fchflags(2)<!-- /a -->
    266. 

  266. </dt>
    267. 

  267. <dd></dd>
    268. 

  268. </dl></blockquote>
    269. 

  269. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/setAttributes //apple_ref/occ/clm/setAttributes //apple_ref/occ/intfcm/setAttributes //apple_ref/occ/intfm/setAttributes //apple_ref/occ/func/setAttributes //apple_ref/occ/ftmplt/setAttributes //apple_ref/occ/defn/setAttributes //apple_ref/occ/macro/setAttributes" --><span class="function">setAttributes</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSDictionary //apple_ref/occ/tdef/NSDictionary //apple_ref/occ/tag/NSDictionary //apple_ref/occ/econst/NSDictionary //apple_ref/occ/struct/NSDictionary //apple_ref/occ/clconst/NSDictionary //apple_ref/occ/intf/NSDictionary" --><span class="type">NSDictionary</span><!-- /a --> <span class="type">*</span>)<span class="param">attributes</span> <!-- a logicalPath="//apple_ref/occ/instm/ofItemAtPath //apple_ref/occ/clm/ofItemAtPath //apple_ref/occ/intfcm/ofItemAtPath //apple_ref/occ/intfm/ofItemAtPath //apple_ref/occ/func/ofItemAtPath //apple_ref/occ/ftmplt/ofItemAtPath //apple_ref/occ/defn/ofItemAtPath //apple_ref/occ/macro/ofItemAtPath" --><span class="function">ofItemAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="param">userData</span> <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>; </pre>
    270. 

  270. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    271. 

  271. <dl>
    272. 

  272. <dt><code>attributes </code></dt>
    273. 

  273. <dd>The attributes to set.</dd>
    274. 

  274. <dt><code>path </code></dt>
    275. 

  275. <dd>The path to the item.</dd>
    276. 

  276. <dt><code>userData </code></dt>
    277. 

  277. <dd>The userData corresponding to this open file or nil.</dd>
    278. 

  278. <dt><code>error </code></dt>
    279. 

  279. <dd>Should be filled with a POSIX error in case of failure.</dd>
    280. 

  280. </dl>
    281. 

  281. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    282. 

  282. <p><!-- begin return value -->YES if the attributes are successfully set.
    283. 

  283.  
    284. 

  284. <!-- end return value --></p>
    285. 

  285. <h5 class="tight">
    286. 

  286. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    287. 

  287. </h5>
    288. 

  288. <p><!-- begin discussion -->Sets the attributes for the item at the specified path. The following keys
    289. 

  289. may be present (you must ignore unknown keys):</p>
    290. 

  290. <ul>
    291. 

  291. <li>NSFileSize
    292. 

  292. </li>
    293. 

  293. <li>NSFileOwnerAccountID
    294. 

  294. </li>
    295. 

  295. <li>NSFileGroupOwnerAccountID
    296. 

  296. </li>
    297. 

  297. <li>NSFilePosixPermissions
    298. 

  298. </li>
    299. 

  299. <li>NSFileModificationDate
    300. 

  300. </li>
    301. 

  301. <li>NSFileCreationDate (if supports extended dates)
    302. 

  302. </li>
    303. 

  303. <li>kGMUserFileSystemFileBackupDateKey (if supports extended dates)
    304. 

  304. </li>
    305. 

  305. <li>kGMUserFileSystemFileChangeDateKey
    306. 

  306. </li>
    307. 

  307. <li>kGMUserFileSystemFileAccessDateKey
    308. 

  308. </li>
    309. 

  309. <li>kGMUserFileSystemFileFlagsKey</li>
    310. 

  310. </ul>
    311. 

  311. <br><p>
    312. 

  312. If this is the f-variant and userData was supplied in openFileAtPath: or 
    313. 

  313. createFileAtPath: then it will be passed back in this call.<br><!-- end discussion --></p>
    314. 

  314. <p></p>
    315. 

  315. <hr>
    316. 

  316. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsAtPath:;  name=NSObject(GMUserFileSystemOperations)::contentsAtPath: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/contentsAtPath:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    317. 

  317. <h3><a name="contentsAtPath:">contentsAtPath: </a></h3>
    318. 

  318. </td></tr></table>
    319. 

  319. <hr>
    320. 

  320. <p><!-- begin abstract -->Returns directory contents at the specified path.
    321. 

  321. <!-- end abstract --></p>
    322. 

  322. <p></p>
    323. 

  323. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSData //apple_ref/occ/tdef/NSData //apple_ref/occ/tag/NSData //apple_ref/occ/econst/NSData //apple_ref/occ/struct/NSData //apple_ref/occ/clconst/NSData //apple_ref/occ/intf/NSData" --><span class="type">NSData</span><!-- /a --> <span class="type">*</span>)<!-- a logicalPath="//apple_ref/occ/instm/contentsAtPath //apple_ref/occ/clm/contentsAtPath //apple_ref/occ/intfcm/contentsAtPath //apple_ref/occ/intfm/contentsAtPath //apple_ref/occ/func/contentsAtPath //apple_ref/occ/ftmplt/contentsAtPath //apple_ref/occ/defn/contentsAtPath //apple_ref/occ/macro/contentsAtPath" --><span class="function">contentsAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="var">path</span>; </pre>
    324. 

  324. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    325. 

  325. <dl>
    326. 

  326. <dt><code>path </code></dt>
    327. 

  327. <dd>The path to the file.</dd>
    328. 

  328. </dl>
    329. 

  329. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    330. 

  330. <p><!-- begin return value -->The contents of the file or nil if a file does not exist at path.
    331. 

  331.  
    332. 

  332. <!-- end return value --></p>
    333. 

  333. <h5 class="tight">
    334. 

  334. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    335. 

  335. </h5>
    336. 

  336. <p><!-- begin discussion -->Returns the full contents at the given path. Implementation of
    337. 

  337. this delegate method is recommended only by very simple file systems that are 
    338. 

  338. not concerned with performance. If contentsAtPath is implemented then you can 
    339. 

  339. skip open/release/read.
    340. 

  340. <!-- end discussion --></p>
    341. 

  341. <p></p>
    342. 

  342. <hr>
    343. 

  343. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/openFileAtPath:mode:userData:error:;  name=NSObject(GMUserFileSystemOperations)::openFileAtPath:mode:userData:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/openFileAtPath:mode:userData:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    344. 

  344. <h3><a name="openFileAtPath:mode:userData:error:">openFileAtPath:mode:userData:error: </a></h3>
    345. 

  345. </td></tr></table>
    346. 

  346. <hr>
    347. 

  347. <p><!-- begin abstract -->Opens the file at the given path for read/write.
    348. 

  348. <!-- end abstract --></p>
    349. 

  349. <p></p>
    350. 

  350. <b>See Also:</b><blockquote><dl>
    351. 

  351. <dt>
    352. 

  352. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->open(2)<!-- /a -->
    353. 

  353. </dt>
    354. 

  354. <dd></dd>
    355. 

  355. </dl></blockquote>
    356. 

  356. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/openFileAtPath //apple_ref/occ/clm/openFileAtPath //apple_ref/occ/intfcm/openFileAtPath //apple_ref/occ/intfm/openFileAtPath //apple_ref/occ/func/openFileAtPath //apple_ref/occ/ftmplt/openFileAtPath //apple_ref/occ/defn/openFileAtPath //apple_ref/occ/macro/openFileAtPath" --><span class="function">openFileAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/mode //apple_ref/occ/clm/mode //apple_ref/occ/intfcm/mode //apple_ref/occ/intfm/mode //apple_ref/occ/func/mode //apple_ref/occ/ftmplt/mode //apple_ref/occ/defn/mode //apple_ref/occ/macro/mode" --><span class="function">mode</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/int //apple_ref/occ/tdef/int //apple_ref/occ/tag/int //apple_ref/occ/econst/int //apple_ref/occ/struct/int //apple_ref/occ/clconst/int //apple_ref/occ/intf/int" --><span class="type">int</span><!-- /a -->)<span class="param">mode</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a --> <span class="type">*</span>)<span class="param">userData</span> <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>; </pre>
    357. 

  357. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    358. 

  358. <dl>
    359. 

  359. <dt><code>path </code></dt>
    360. 

  360. <dd>The path to the file.</dd>
    361. 

  361. <dt><code>mode </code></dt>
    362. 

  362. <dd>The open mode for the file (e.g. O_RDWR, etc.)</dd>
    363. 

  363. <dt><code>userData </code></dt>
    364. 

  364. <dd>Out parameter that can be filled in with arbitrary user data.
    365. 

  365. The given userData will be retained and passed back in to delegate
    366. 

  366. methods that are acting on this open file.</dd>
    367. 

  367. <dt><code>error </code></dt>
    368. 

  368. <dd>Should be filled with a POSIX error in case of failure.</dd>
    369. 

  369. </dl>
    370. 

  370. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    371. 

  371. <p><!-- begin return value -->YES if the file was opened successfully.
    372. 

  372.  
    373. 

  373. <!-- end return value --></p>
    374. 

  374. <h5 class="tight">
    375. 

  375. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    376. 

  376. </h5>
    377. 

  377. <p><!-- begin discussion -->This will only be called for existing files. If the file needs
    378. 

  378. to be created then createFileAtPath: will be called instead.
    379. 

  379. <!-- end discussion --></p>
    380. 

  380. <p></p>
    381. 

  381. <hr>
    382. 

  382. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/releaseFileAtPath:userData:;  name=NSObject(GMUserFileSystemOperations)::releaseFileAtPath:userData: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/releaseFileAtPath:userData:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    383. 

  383. <h3><a name="releaseFileAtPath:userData:">releaseFileAtPath:userData: </a></h3>
    384. 

  384. </td></tr></table>
    385. 

  385. <hr>
    386. 

  386. <p><!-- begin abstract -->Called when an opened file is closed.
    387. 

  387. <!-- end abstract --></p>
    388. 

  388. <p></p>
    389. 

  389. <b>See Also:</b><blockquote><dl>
    390. 

  390. <dt>
    391. 

  391. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->close(2)<!-- /a -->
    392. 

  392. </dt>
    393. 

  393. <dd></dd>
    394. 

  394. </dl></blockquote>
    395. 

  395. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/releaseFileAtPath //apple_ref/occ/clm/releaseFileAtPath //apple_ref/occ/intfcm/releaseFileAtPath //apple_ref/occ/intfm/releaseFileAtPath //apple_ref/occ/func/releaseFileAtPath //apple_ref/occ/ftmplt/releaseFileAtPath //apple_ref/occ/defn/releaseFileAtPath //apple_ref/occ/macro/releaseFileAtPath" --><span class="function">releaseFileAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="var">userData</span>; </pre>
    396. 

  396. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    397. 

  397. <dl>
    398. 

  398. <dt><code>path </code></dt>
    399. 

  399. <dd>The path to the file.</dd>
    400. 

  400. <dt><code>userData </code></dt>
    401. 

  401. <dd>The userData corresponding to this open file or nil.</dd>
    402. 

  402. </dl>
    403. 

  403. <h5 class="tight">
    404. 

  404. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    405. 

  405. </h5>
    406. 

  406. <p><!-- begin discussion -->If userData was provided in the corresponding openFileAtPath: call
    407. 

  407. then it will be passed in userData and released after this call completes.
    408. 

  408. <!-- end discussion --></p>
    409. 

  409. <p></p>
    410. 

  410. <hr>
    411. 

  411. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/readFileAtPath:userData:buffer:size:offset:error:;  name=NSObject(GMUserFileSystemOperations)::readFileAtPath:userData:buffer:size:offset:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/readFileAtPath:userData:buffer:size:offset:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    412. 

  412. <h3><a name="readFileAtPath:userData:buffer:size:offset:error:">readFileAtPath:userData:buffer:size:offset:error: </a></h3>
    413. 

  413. </td></tr></table>
    414. 

  414. <hr>
    415. 

  415. <p><!-- begin abstract -->Reads data from the open file at the specified path.
    416. 

  416. <!-- end abstract --></p>
    417. 

  417. <p></p>
    418. 

  418. <b>See Also:</b><blockquote><dl>
    419. 

  419. <dt>
    420. 

  420. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->pread(2)<!-- /a -->
    421. 

  421. </dt>
    422. 

  422. <dd></dd>
    423. 

  423. </dl></blockquote>
    424. 

  424. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/int //apple_ref/occ/tdef/int //apple_ref/occ/tag/int //apple_ref/occ/econst/int //apple_ref/occ/struct/int //apple_ref/occ/clconst/int //apple_ref/occ/intf/int" --><span class="type">int</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/readFileAtPath //apple_ref/occ/clm/readFileAtPath //apple_ref/occ/intfcm/readFileAtPath //apple_ref/occ/intfm/readFileAtPath //apple_ref/occ/func/readFileAtPath //apple_ref/occ/ftmplt/readFileAtPath //apple_ref/occ/defn/readFileAtPath //apple_ref/occ/macro/readFileAtPath" --><span class="function">readFileAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="param">userData</span> <!-- a logicalPath="//apple_ref/occ/instm/buffer //apple_ref/occ/clm/buffer //apple_ref/occ/intfcm/buffer //apple_ref/occ/intfm/buffer //apple_ref/occ/func/buffer //apple_ref/occ/ftmplt/buffer //apple_ref/occ/defn/buffer //apple_ref/occ/macro/buffer" --><span class="function">buffer</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/char //apple_ref/occ/tdef/char //apple_ref/occ/tag/char //apple_ref/occ/econst/char //apple_ref/occ/struct/char //apple_ref/occ/clconst/char //apple_ref/occ/intf/char" --><span class="type">char</span><!-- /a --> <span class="type">*</span>)<span class="param">buffer</span> <!-- a logicalPath="//apple_ref/occ/instm/size //apple_ref/occ/clm/size //apple_ref/occ/intfcm/size //apple_ref/occ/intfm/size //apple_ref/occ/func/size //apple_ref/occ/ftmplt/size //apple_ref/occ/defn/size //apple_ref/occ/macro/size" --><span class="function">size</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/size_t //apple_ref/occ/tdef/size_t //apple_ref/occ/tag/size_t //apple_ref/occ/econst/size_t //apple_ref/occ/struct/size_t //apple_ref/occ/clconst/size_t //apple_ref/occ/intf/size_t" --><span class="type">size_t</span><!-- /a -->)<span class="param">size</span> <!-- a logicalPath="//apple_ref/occ/instm/offset //apple_ref/occ/clm/offset //apple_ref/occ/intfcm/offset //apple_ref/occ/intfm/offset //apple_ref/occ/func/offset //apple_ref/occ/ftmplt/offset //apple_ref/occ/defn/offset //apple_ref/occ/macro/offset" --><span class="function">offset</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/off_t //apple_ref/occ/tdef/off_t //apple_ref/occ/tag/off_t //apple_ref/occ/econst/off_t //apple_ref/occ/struct/off_t //apple_ref/occ/clconst/off_t //apple_ref/occ/intf/off_t" --><span class="type">off_t</span><!-- /a -->)<span class="param">offset</span> <!-- a logicalPath="//apple_ref/occ/instm/error //apple_ref/occ/clm/error //apple_ref/occ/intfcm/error //apple_ref/occ/intfm/error //apple_ref/occ/func/error //apple_ref/occ/ftmplt/error //apple_ref/occ/defn/error //apple_ref/occ/macro/error" --><span class="function">error</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSError //apple_ref/occ/tdef/NSError //apple_ref/occ/tag/NSError //apple_ref/occ/econst/NSError //apple_ref/occ/struct/NSError //apple_ref/occ/clconst/NSError //apple_ref/occ/intf/NSError" --><span class="type">NSError</span><!-- /a --> <span class="type">*</span><span class="type">*</span>)<span class="var">error</span>; </pre>
    425. 

  425. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
    426. 

  426. <dl>
    427. 

  427. <dt><code>path </code></dt>
    428. 

  428. <dd>The path to the file.</dd>
    429. 

  429. <dt><code>userData </code></dt>
    430. 

  430. <dd>The userData corresponding to this open file or nil.</dd>
    431. 

  431. <dt><code>buffer </code></dt>
    432. 

  432. <dd>Byte buffer to read data from the file into.</dd>
    433. 

  433. <dt><code>size </code></dt>
    434. 

  434. <dd>The size of the provided buffer.</dd>
    435. 

  435. <dt><code>offset </code></dt>
    436. 

  436. <dd>The offset in the file from which to read data.</dd>
    437. 

  437. <dt><code>error </code></dt>
    438. 

  438. <dd>Should be filled with a POSIX error in case of failure.</dd>
    439. 

  439. </dl>
    440. 

  440. <h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
    441. 

  441. <p><!-- begin return value -->The number of bytes read or -1 on error.
    442. 

  442.  
    443. 

  443. <!-- end return value --></p>
    444. 

  444. <h5 class="tight">
    445. 

  445. <font face="Lucida Grande,Helvetica,Arial">Discussion</font>
    446. 

  446. </h5>
    447. 

  447. <p><!-- begin discussion -->Reads data from the file starting at offset into the provided
    448. 

  448. buffer and returns the number of bytes read. If userData was provided in the 
    449. 

  449. corresponding openFileAtPath: or createFileAtPath: call then it will be
    450. 

  450. passed in.
    451. 

  451. <!-- end discussion --></p>
    452. 

  452. <p></p>
    453. 

  453. <hr>
    454. 

  454. <!-- headerDoc=instm;  uid=//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/writeFileAtPath:userData:buffer:size:offset:error:;  name=NSObject(GMUserFileSystemOperations)::writeFileAtPath:userData:buffer:size:offset:error: --><a name="//apple_ref/doc/compositePage/occ/instm/NSObject(GMUserFileSystemOperations)/writeFileAtPath:userData:buffer:size:offset:error:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
    455. 

  455. <h3><a name="writeFileAtPath:userData:buffer:size:offset:error:">writeFileAtPath:userData:buffer:size:offset:error: </a></h3>
    456. 

  456. </td></tr></table>
    457. 

  457. <hr>
    458. 

  458. <p><!-- begin abstract -->Writes data to the open file at the specified path.
    459. 

  459. <!-- end abstract --></p>
    460. 

  460. <p></p>
    461. 

  461. <b>See Also:</b><blockquote><dl>
    462. 

  462. <dt>
    463. 

  463. <!-- a logicalPath="//apple_ref/occ/cl/man //apple_ref/occ/tdef/man //apple_ref/occ/tag/man //apple_ref/occ/econst/man //apple_ref/occ/struct/man //apple_ref/occ/data/man //apple_ref/occ/clconst/man //apple_ref/occ/intf/man //apple_ref/occ/instm/man //apple_ref/occ/clm/man //apple_ref/occ/intfcm/man //apple_ref/occ/intfm/man //apple_ref/occ/func/man //apple_ref/occ/ftmplt/man //apple_ref/occ/defn/man //apple_ref/occ/macro/man //apple_ref/doc/com/intfm/man" -->pwrite(2)<!-- /a -->
    464. 

  464. </dt>
    465. 

  465. <dd></dd>
    466. 

  466. </dl></blockquote>
    467. 

  467. <pre>- (<!-- a logicalPath="//apple_ref/occ/cl/int //apple_ref/occ/tdef/int //apple_ref/occ/tag/int //apple_ref/occ/econst/int //apple_ref/occ/struct/int //apple_ref/occ/clconst/int //apple_ref/occ/intf/int" --><span class="type">int</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/writeFileAtPath //apple_ref/occ/clm/writeFileAtPath //apple_ref/occ/intfcm/writeFileAtPath //apple_ref/occ/intfm/writeFileAtPath //apple_ref/occ/func/writeFileAtPath //apple_ref/occ/ftmplt/writeFileAtPath //apple_ref/occ/defn/writeFileAtPath //apple_ref/occ/macro/writeFileAtPath" --><span class="function">writeFileAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">path</span> <!-- a logicalPath="//apple_ref/occ/instm/userData //apple_ref/occ/clm/userData //apple_ref/occ/intfcm/userData //apple_ref/occ/intfm/userData //apple_ref/occ/func/userData //apple_ref/occ/ftmplt/userData //apple_ref/occ/defn/userData //apple_ref/occ/macro/userData" --><span class="function">userData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="param">userData</span> <!-- a logicalPath="//apple_ref/occ/instm/buffer //apple_ref/occ/clm/buffer //apple_ref/occ/intfcm/buffer //apple_ref/occ/intfm/buffer //apple_ref/occ/func/buffer //apple_ref/occ/ftmplt/buffer //apple_ref/occ/defn/buffer //apple_ref/occ/macro/buffer" --><span class="function">buffer</span><!-- /a -->:(<span class="keyword">const</span> <!-- a logicalPath="//apple_ref/occ/cl/char //apple_ref/occ/tdef/char //apple_ref/occ/tag/char //apple_ref/occ/econst/char //apple_ref/occ/struct/char //apple_ref/occ/clconst/char //apple_ref/occ/intf/char" --><span class="type">char</span><!-- /a --> <span class="type">*</span>)<span class="param">buffer<…
    468.