macstuff.h
上传用户:andy_li
上传日期:2007-01-06
资源大小:1019k
文件大小:43k
源码类别:

压缩解压

开发平台:

MultiPlatform

  1. #ifndef _MACSTUFF_H
  2. #define _MACSTUFF_H       1
  3. /*
  4. These Functions are part of MoreFiles version 1.4.8
  5. More Files fixes many of the broken or underfunctional
  6. parts of the file system.
  7. MoreFiles
  8. A collection of File Manager and related routines
  9. by Jim Luther (Apple Macintosh Developer Technical Support Emeritus)
  10. with significant code contributions by Nitin Ganatra
  11. (Apple Macintosh Developer Technical Support Emeritus)
  12. Copyright  1992-1998 Apple Computer, Inc.
  13. Portions copyright  1995 Jim Luther
  14. All rights reserved.
  15. More Files can be found on the MetroWerks CD and Developer CD from
  16. Apple.  You can also down load the latest version from:
  17.     http://members.aol.com/JumpLong/MoreFiles_1.4.7.sit.hqx
  18. Jim Luther's Home-page:
  19.     http://members.aol.com/JumpLong/
  20. I'm including the files in the Info-Zip project directly.
  21. (see macstuff.c / macstuff.h)
  22. */
  23. #define __MACOSSEVENFIVEONEORLATER 1
  24. #define __MACOSSEVENFIVEORLATER    1
  25. #define __MACOSSEVENORLATER        1
  26. #include <Errors.h>
  27. #include <Files.h>
  28. /*
  29.  * Like the MoreFiles routines these fix problems in the standard
  30.  * Mac calls.
  31.  */
  32. int     FSpLocationFromPath (int length,const char *path, FSSpecPtr theSpec);
  33. OSErr   FSpPathFromLocation (FSSpecPtr theSpec,int *length, Handle *fullPath);
  34. #define hasDesktopMgr(volParms) (((volParms).vMAttrib & (1L << bHasDesktopMgr)) != 0)
  35. /*
  36.  * The following routines are utility functions.  They are exported
  37.  * here because they are needed and they are not officially supported,
  38.  * however.  The first set are from the MoreFiles package.
  39.  */
  40. int             FSpGetDefaultDir (FSSpecPtr theSpec);
  41. int             FSpSetDefaultDir (FSSpecPtr dirSpec);
  42. pascal  OSErr   FSpGetDirectoryID(const FSSpec *spec,long *theDirID,
  43.                                   Boolean *isDirectory);
  44. pascal  short   FSpOpenResFileCompat(const FSSpec *spec, SignedByte permission);
  45. pascal  void    FSpCreateResFileCompat(const FSSpec *spec,OSType creator,
  46.                                        OSType fileType,
  47.                                        ScriptCode scriptTag);
  48. OSErr           FSpFindFolder (short vRefNum, OSType folderType,
  49.                                Boolean createFolder,
  50.                                FSSpec *spec);
  51. /*****************************************************************************/
  52. pascal  OSErr   GetVolumeInfoNoName(ConstStr255Param pathname,
  53.                                     short vRefNum,
  54.                                     HParmBlkPtr pb);
  55. /*   Call PBHGetVInfoSync ignoring returned name.
  56.     GetVolumeInfoNoName uses pathname and vRefNum to call PBHGetVInfoSync
  57.     in cases where the returned volume name is not needed by the caller.
  58.     The pathname and vRefNum parameters are not touched, and the pb
  59.     parameter is initialized by PBHGetVInfoSync except that ioNamePtr in
  60.     the parameter block is always returned as NULL (since it might point
  61.     to GetVolumeInfoNoName's local variable tempPathname).
  62.     I noticed using this code in several places, so here it is once.
  63.     This reduces the code size of MoreFiles.
  64.     pathName    input:  Pointer to a full pathname or nil.  If you pass in a
  65.                         partial pathname, it is ignored. A full pathname to a
  66.                         volume must end with a colon character (:).
  67.     vRefNum     input:  Volume specification (volume reference number, working
  68.                         directory number, drive number, or 0).
  69.     pb          input:  A pointer to HParamBlockRec.
  70.                 output: The parameter block as filled in by PBHGetVInfoSync
  71.                         except that ioNamePtr will always be NULL.
  72.     Result Codes
  73.         noErr               0       No error
  74.         nsvErr              -35     No such volume
  75.         paramErr            -50     No default volume, or pb was NULL
  76. */
  77. /*****************************************************************************/
  78. pascal  OSErr   GetFilenameFromPathname(ConstStr255Param pathname,
  79.                                         Str255 filename);
  80. /*   Get the object name from the end of a full or partial pathname.
  81.     The GetFilenameFromPathname function gets the file (or directory) name
  82.     from the end of a full or partial pathname. Returns notAFileErr if the
  83.     pathname is nil, the pathname is empty, or the pathname cannot refer to
  84.     a filename (with a noErr result, the pathname could still refer to a
  85.     directory).
  86.     pathname    input:  A full or partial pathname.
  87.     filename    output: The file (or directory) name.
  88.     Result Codes
  89.         noErr               0       No error
  90.         notAFileErr         -1302   The pathname is nil, the pathname
  91.                                     is empty, or the pathname cannot refer
  92.                                     to a filename
  93.     __________
  94.     See also:   GetObjectLocation.
  95. */
  96. /*****************************************************************************/
  97. pascal  OSErr   FSMakeFSSpecCompat(short vRefNum, long dirID,
  98.                                    ConstStr255Param fileName,
  99.                                    FSSpec *spec);
  100. /*   Initialize a FSSpec record.
  101.     The FSMakeFSSpecCompat function fills in the fields of an FSSpec record.
  102.     If the file system can't create the FSSpec, then the compatibility code
  103.     creates a FSSpec that is exactly like an FSSpec except that spec.name
  104.     for a file may not have the same capitalization as the file's catalog
  105.     entry on the disk volume. That is because fileName is parsed to get the
  106.     name instead of getting the name back from the file system. This works
  107.     fine with System 6 where FSMakeSpec isn't available.
  108.     vRefNum     input:  Volume specification.
  109.     dirID       input:  Directory ID.
  110.     fileName    input:  Pointer to object name, or nil when dirID specifies
  111.                         a directory that's the object.
  112.     spec        output: A file system specification to be filled in by
  113.                         FSMakeFSSpecCompat.
  114.     Result Codes
  115.         noErr               0       No error
  116.         nsvErr              -35     Volume doesnt exist
  117.         fnfErr              -43     File or directory does not exist
  118.                                     (FSSpec is still valid)
  119. */
  120. #if !SystemSevenOrLater
  121. static  Boolean FSHasFSSpecCalls(void);
  122. static  Boolean QTHasFSSpecCalls(void);
  123. #endif  /* !SystemSevenOrLater */
  124. /*****************************************************************************/
  125. pascal  OSErr   GetObjectLocation(short vRefNum,
  126.                                   long dirID,
  127.                                   ConstStr255Param pathname,
  128.                                   short *realVRefNum,
  129.                                   long *realParID,
  130.                                   Str255 realName,
  131.                                   Boolean *isDirectory);
  132. /*   Get a file system object's location.
  133.     The GetObjectLocation function gets a file system object's location -
  134.     that is, its real volume reference number, real parent directory ID,
  135.     and name. While we're at it, determine if the object is a file or directory.
  136.     If GetObjectLocation returns fnfErr, then the location information
  137.     returned is valid, but it describes an object that doesn't exist.
  138.     You can use the location information for another operation, such as
  139.     creating a file or directory.
  140.     vRefNum     input:  Volume specification.
  141.     dirID       input:  Directory ID.
  142.     pathname    input:  Pointer to object name, or nil when dirID specifies
  143.                         a directory that's the object.
  144.     realVRefNum output: The real volume reference number.
  145.     realParID   output: The parent directory ID of the specified object.
  146.     realName    output: The name of the specified object (the case of the
  147.                         object name may not be the same as the object's
  148.                         catalog entry on disk - since the Macintosh file
  149.                         system is not case sensitive, it shouldn't matter).
  150.     isDirectory output: True if object is a directory; false if object
  151.                         is a file.
  152.     Result Codes
  153.         noErr               0       No error
  154.         nsvErr              -35     No such volume
  155.         ioErr               -36     I/O error
  156.         bdNamErr            -37     Bad filename
  157.         fnfErr              -43     File not found
  158.         paramErr            -50     No default volume
  159.         dirNFErr            -120    Directory not found or incomplete pathname
  160.         notAFileErr         -1302   The pathname is nil, the pathname
  161.                                     is empty, or the pathname cannot refer
  162.                                     to a filename
  163.         afpAccessDenied     -5000   User does not have the correct access
  164.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  165.     __________
  166.     See also:   FSMakeFSSpecCompat
  167. */
  168. pascal  OSErr   FSpGetDirectoryID(const FSSpec *spec, long *theDirID,
  169.                                   Boolean *isDirectory);
  170. pascal  OSErr   GetDirectoryID(short vRefNum,long dirID,ConstStr255Param name,
  171.                                long *theDirID,Boolean *isDirectory);
  172. /*****************************************************************************/
  173. pascal  OSErr GetCatInfoNoName(short vRefNum,
  174.                                long dirID,
  175.                                ConstStr255Param name,
  176.                                CInfoPBPtr pb);
  177. /*   Call PBGetCatInfoSync ignoring returned name.
  178.     GetCatInfoNoName uses vRefNum, dirID and name to call PBGetCatInfoSync
  179.     in cases where the returned object is not needed by the caller.
  180.     The vRefNum, dirID and name parameters are not touched, and the pb
  181.     parameter is initialized by PBGetCatInfoSync except that ioNamePtr in
  182.     the parameter block is always returned as NULL (since it might point
  183.     to GetCatInfoNoName's local variable tempName).
  184.     I noticed using this code in several places, so here it is once.
  185.     This reduces the code size of MoreFiles.
  186.     vRefNum         input:  Volume specification.
  187.     dirID           input:  Directory ID.
  188.     name            input:  Pointer to object name, or nil when dirID
  189.                             specifies a directory that's the object.
  190.     pb              input:  A pointer to CInfoPBRec.
  191.                     output: The parameter block as filled in by
  192.                             PBGetCatInfoSync except that ioNamePtr will
  193.                             always be NULL.
  194.     Result Codes
  195.         noErr               0       No error
  196.         nsvErr              -35     No such volume
  197.         ioErr               -36     I/O error
  198.         bdNamErr            -37     Bad filename
  199.         fnfErr              -43     File not found
  200.         paramErr            -50     No default volume
  201.         dirNFErr            -120    Directory not found or incomplete pathname
  202.         afpAccessDenied     -5000   User does not have the correct access
  203.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  204. */
  205. /*****************************************************************************/
  206. pascal  OSErr   DetermineVRefNum(ConstStr255Param pathname,
  207.                                  short vRefNum,
  208.                                  short *realVRefNum);
  209. /*   Determine the real volume reference number.
  210.     The DetermineVRefNum function determines the volume reference number of
  211.     a volume from a pathname, a volume specification, or a combination
  212.     of the two.
  213.     WARNING: Volume names on the Macintosh are *not* unique -- Multiple
  214.     mounted volumes can have the same name. For this reason, the use of a
  215.     volume name or full pathname to identify a specific volume may not
  216.     produce the results you expect.  If more than one volume has the same
  217.     name and a volume name or full pathname is used, the File Manager
  218.     currently uses the first volume it finds with a matching name in the
  219.     volume queue.
  220.     pathName    input:  Pointer to a full pathname or nil.  If you pass in a
  221.                         partial pathname, it is ignored. A full pathname to a
  222.                         volume must end with a colon character (:).
  223.     vRefNum     input:  Volume specification (volume reference number, working
  224.                         directory number, drive number, or 0).
  225.     realVRefNum output: The real volume reference number.
  226.     Result Codes
  227.         noErr               0       No error
  228.         nsvErr              -35     No such volume
  229.         paramErr            -50     No default volume
  230. */
  231. /*****************************************************************************/
  232. pascal  OSErr   FSpGetFullPath(const FSSpec *spec,
  233.                                short *fullPathLength,
  234.                                Handle *fullPath);
  235. /*   Get a full pathname to a volume, directory or file.
  236.     The GetFullPath function builds a full pathname to the specified
  237.     object. The full pathname is returned in the newly created handle
  238.     fullPath and the length of the full pathname is returned in
  239.     fullPathLength. Your program is responsible for disposing of the
  240.     fullPath handle.
  241.     spec            input:  An FSSpec record specifying the object.
  242.     fullPathLength  output: The number of characters in the full pathname.
  243.                             If the function fails to create a full pathname,
  244.                             it sets fullPathLength to 0.
  245.     fullPath        output: A handle to the newly created full pathname
  246.                             buffer. If the function fails to create a
  247.                             full pathname, it sets fullPath to NULL.
  248.     Result Codes
  249.         noErr               0       No error
  250.         nsvErr              -35     No such volume
  251.         ioErr               -36     I/O error
  252.         bdNamErr            -37     Bad filename
  253.         fnfErr              -43     File or directory does not exist
  254.         paramErr            -50     No default volume
  255.         memFullErr          -108    Not enough memory
  256.         dirNFErr            -120    Directory not found or incomplete pathname
  257.         afpAccessDenied     -5000   User does not have the correct access
  258.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  259.     __________
  260.     See also:   GetFullPath
  261. */
  262. /*****************************************************************************/
  263. pascal OSErr FSpLocationFromFullPath(short fullPathLength,
  264.                                      const void *fullPath,
  265.                                      FSSpec *spec);
  266. /*   Get a FSSpec from a full pathname.
  267.     The FSpLocationFromFullPath function returns a FSSpec to the object
  268.     specified by full pathname. This function requires the Alias Manager.
  269.     fullPathLength  input:  The number of characters in the full pathname
  270.                             of the target.
  271.     fullPath        input:  A pointer to a buffer that contains the full
  272.                             pathname of the target. The full pathname
  273.                             starts with the name of the volume, includes
  274.                             all of the directory names in the path to the
  275.                             target, and ends with the target name.
  276.     spec            output: An FSSpec record specifying the object.
  277.     Result Codes
  278.         noErr               0       No error
  279.         nsvErr              -35     The volume is not mounted
  280.         fnfErr              -43     Target not found, but volume and parent
  281.                                     directory found
  282.         paramErr            -50     Parameter error
  283.         usrCanceledErr      -128    The user canceled the operation
  284.     __________
  285.     See also:   LocationFromFullPath
  286. */
  287. /*****************************************************************************/
  288. pascal  OSErr   GetFullPath(short vRefNum,
  289.                             long dirID,
  290.                             ConstStr255Param name,
  291.                             short *fullPathLength,
  292.                             Handle *fullPath);
  293. /*   Get a full pathname to a volume, directory or file.
  294.     The GetFullPath function builds a full pathname to the specified
  295.     object. The full pathname is returned in the newly created handle
  296.     fullPath and the length of the full pathname is returned in
  297.     fullPathLength. Your program is responsible for disposing of the
  298.     fullPath handle.
  299.     Note that a full pathname can be made to a file/directory that does not
  300.     yet exist if all directories up to that file/directory exist. In this case,
  301.     GetFullPath will return a fnfErr.
  302.     vRefNum         input:  Volume specification.
  303.     dirID           input:  Directory ID.
  304.     name            input:  Pointer to object name, or nil when dirID
  305.                             specifies a directory that's the object.
  306.     fullPathLength  output: The number of characters in the full pathname.
  307.                             If the function fails to create a full
  308.                             pathname, it sets fullPathLength to 0.
  309.     fullPath        output: A handle to the newly created full pathname
  310.                             buffer. If the function fails to create a
  311.                             full pathname, it sets fullPath to NULL.
  312.     Result Codes
  313.         noErr               0       No error
  314.         nsvErr              -35     No such volume
  315.         ioErr               -36     I/O error
  316.         bdNamErr            -37     Bad filename
  317.         fnfErr              -43     File or directory does not exist (fullPath
  318.                                     and fullPathLength are still valid)
  319.         paramErr            -50     No default volume
  320.         memFullErr          -108    Not enough memory
  321.         dirNFErr            -120    Directory not found or incomplete pathname
  322.         afpAccessDenied     -5000   User does not have the correct access
  323.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  324.     __________
  325.     See also:   FSpGetFullPath
  326. */
  327. /*****************************************************************************/
  328. pascal  OSErr   ChangeCreatorType(short vRefNum,
  329.                                   long dirID,
  330.                                   ConstStr255Param name,
  331.                                   OSType creator,
  332.                                   OSType fileType);
  333. /*   Change the creator or file type of a file.
  334.     The ChangeCreatorType function changes the creator or file type of a file.
  335.     vRefNum     input:  Volume specification.
  336.     dirID       input:  Directory ID.
  337.     name        input:  The name of the file.
  338.     creator     input:  The new creator type or 0x00000000 to leave
  339.                         the creator type alone.
  340.     fileType    input:  The new file type or 0x00000000 to leave the
  341.                         file type alone.
  342.     Result Codes
  343.         noErr               0       No error
  344.         nsvErr              -35     No such volume
  345.         ioErr               -36     I/O error
  346.         bdNamErr            -37     Bad filename
  347.         fnfErr              -43     File not found
  348.         fLckdErr            -45     File is locked
  349.         vLckdErr            -46     Volume is locked or read-only
  350.         paramErr            -50     No default volume
  351.         dirNFErr            -120    Directory not found or incomplete pathname
  352.         notAFileErr         -1302   Name was not a file
  353.         afpAccessDenied     -5000   User does not have the correct access
  354.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  355.     __________
  356.     See also:   FSpChangeCreatorType
  357. */
  358. /*****************************************************************************/
  359. pascal  OSErr   FSpChangeCreatorType(const FSSpec *spec,
  360.                                      OSType creator,
  361.                                      OSType fileType);
  362. /*   Change the creator or file type of a file.
  363.     The FSpChangeCreatorType function changes the creator or file type of a file.
  364.     spec        input:  An FSSpec record specifying the file.
  365.     creator     input:  The new creator type or 0x00000000 to leave
  366.                         the creator type alone.
  367.     fileType    input:  The new file type or 0x00000000 to leave the
  368.                         file type alone.
  369.     Result Codes
  370.         noErr               0       No error
  371.         nsvErr              -35     No such volume
  372.         ioErr               -36     I/O error
  373.         bdNamErr            -37     Bad filename
  374.         fnfErr              -43     File not found
  375.         fLckdErr            -45     File is locked
  376.         vLckdErr            -46     Volume is locked or read-only
  377.         paramErr            -50     No default volume
  378.         dirNFErr            -120    Directory not found or incomplete pathname
  379.         notAFileErr         -1302   Name was not a file
  380.         afpAccessDenied     -5000   User does not have the correct access
  381.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  382.     __________
  383.     See also:   ChangeCreatorType
  384. */
  385. /*****************************************************************************/
  386. pascal  OSErr   BumpDate(short vRefNum,
  387.                          long dirID,
  388.                          ConstStr255Param name);
  389. /*   Update the modification date of a file or directory.
  390.     The BumpDate function changes the modification date of a file or
  391.     directory to the current date/time.  If the modification date is already
  392.     equal to the current date/time, then add one second to the
  393.     modification date.
  394.     vRefNum input:  Volume specification.
  395.     dirID   input:  Directory ID.
  396.     name    input:  Pointer to object name, or nil when dirID specifies
  397.                     a directory that's the object.
  398.     Result Codes
  399.         noErr               0       No error
  400.         nsvErr              -35     No such volume
  401.         ioErr               -36     I/O error
  402.         bdNamErr            -37     Bad filename
  403.         fnfErr              -43     File not found
  404.         fLckdErr            -45     File is locked
  405.         vLckdErr            -46     Volume is locked or read-only
  406.         paramErr            -50     No default volume
  407.         dirNFErr            -120    Directory not found or incomplete pathname
  408.         afpAccessDenied     -5000   User does not have the correct access
  409.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  410.     __________
  411.     See also:   FSpBumpDate
  412. */
  413. /*****************************************************************************/
  414. pascal  OSErr   FSpBumpDate(const FSSpec *spec);
  415. /*   Update the modification date of a file or directory.
  416.     The FSpBumpDate function changes the modification date of a file or
  417.     directory to the current date/time.  If the modification date is already
  418.     equal to the current date/time, then add one second to the
  419.     modification date.
  420.     spec    input:  An FSSpec record specifying the object.
  421.     Result Codes
  422.         noErr               0       No error
  423.         nsvErr              -35     No such volume
  424.         ioErr               -36     I/O error
  425.         bdNamErr            -37     Bad filename
  426.         fnfErr              -43     File not found
  427.         fLckdErr            -45     File is locked
  428.         vLckdErr            -46     Volume is locked or read-only
  429.         paramErr            -50     No default volume
  430.         dirNFErr            -120    Directory not found or incomplete pathname
  431.         afpAccessDenied     -5000   User does not have the correct access
  432.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  433.     __________
  434.     See also:   BumpDate
  435. */
  436. /*****************************************************************************/
  437. pascal  OSErr   OnLine(FSSpecPtr volumes,
  438.                        short reqVolCount,
  439.                        short *actVolCount,
  440.                        short *volIndex);
  441. /*   Return the list of volumes currently mounted.
  442.     The OnLine function returns the list of volumes currently mounted in
  443.     an array of FSSpec records.
  444.     A noErr result indicates that the volumes array was filled
  445.     (actVolCount == reqVolCount) and there may be additional volumes
  446.     mounted. A nsvErr result indicates that the end of the volume list
  447.     was found and actVolCount volumes were actually found this time.
  448.     volumes     input:  Pointer to array of FSSpec where the volume list
  449.                         is returned.
  450.     reqVolCount input:  Maximum number of volumes to return (the number of
  451.                         elements in the volumes array).
  452.     actVolCount output: The number of volumes actually returned.
  453.     volIndex    input:  The current volume index position. Set to 1 to
  454.                         start with the first volume.
  455.                 output: The volume index position to get the next volume.
  456.                         Pass this value the next time you call OnLine to
  457.                         start where you left off.
  458.     Result Codes
  459.         noErr               0       No error, but there are more volumes
  460.                                     to list
  461.         nsvErr              -35     No more volumes to be listed
  462.         paramErr            -50     volIndex was <= 0
  463. */
  464. /*****************************************************************************/
  465. pascal  OSErr   DTGetComment(short vRefNum,
  466.                              long dirID,
  467.                              ConstStr255Param name,
  468.                              Str255 comment);
  469. /*   Get a file or directory's Finder comment field (if any).
  470.     The DTGetComment function gets a file or directory's Finder comment
  471.     field (if any) from the Desktop Manager or if the Desktop Manager is
  472.     not available, from the Finder's Desktop file.
  473.     IMPORTANT NOTE: Inside Macintosh says that comments are up to
  474.     200 characters. While that may be correct for the HFS file system's
  475.     Desktop Manager, other file systems (such as Apple Photo Access) return
  476.     up to 255 characters. Make sure the comment buffer is a Str255 or you'll
  477.     regret it.
  478.     vRefNum input:  Volume specification.
  479.     dirID   input:  Directory ID.
  480.     name    input:  Pointer to object name, or nil when dirID
  481.                     specifies a directory that's the object.
  482.     comment output: A Str255 where the comment is to be returned.
  483.     Result Codes
  484.         noErr               0       No error
  485.         nsvErr              -35     Volume not found
  486.         ioErr               -36     I/O error
  487.         fnfErr              -43     File not found
  488.         paramErr            -50     Volume doesn't support this function
  489.         rfNumErr            -51     Reference number invalid
  490.         extFSErr            -58     External file system error - no file
  491.                                     system claimed this call.
  492.         desktopDamagedErr   -1305   The desktop database has become corrupted -
  493.                                     the Finder will fix this, but if your
  494.                                     application is not running with the
  495.                                     Finder, use PBDTReset or PBDTDelete
  496.         afpItemNotFound     -5012   Information not found
  497.     __________
  498.     Also see:   DTCopyComment, FSpDTCopyComment, DTSetComment, FSpDTSetComment,
  499.                 FSpDTGetComment
  500. */
  501. /*****************************************************************************/
  502. pascal  OSErr   FSpDTGetComment(const FSSpec *spec,
  503.                                 Str255 comment);
  504. /*   Get a file or directory's Finder comment field (if any).
  505.     The FSpDTGetComment function gets a file or directory's Finder comment
  506.     field (if any) from the Desktop Manager or if the Desktop Manager is
  507.     not available, from the Finder's Desktop file.
  508.     IMPORTANT NOTE: Inside Macintosh says that comments are up to
  509.     200 characters. While that may be correct for the HFS file system's
  510.     Desktop Manager, other file systems (such as Apple Photo Access) return
  511.     up to 255 characters. Make sure the comment buffer is a Str255 or you'll
  512.     regret it.
  513.     spec    input:  An FSSpec record specifying the file or directory.
  514.     comment output: A Str255 where the comment is to be returned.
  515.     Result Codes
  516.         noErr               0       No error
  517.         nsvErr              -35     Volume not found
  518.         ioErr               -36     I/O error
  519.         fnfErr              -43     File not found
  520.         paramErr            -50     Volume doesn't support this function
  521.         rfNumErr            -51     Reference number invalid
  522.         extFSErr            -58     External file system error - no file
  523.                                     system claimed this call.
  524.         desktopDamagedErr   -1305   The desktop database has become corrupted -
  525.                                     the Finder will fix this, but if your
  526.                                     application is not running with the
  527.                                     Finder, use PBDTReset or PBDTDelete
  528.         afpItemNotFound     -5012   Information not found
  529.     __________
  530.     Also see:   DTCopyComment, FSpDTCopyComment, DTSetComment, FSpDTSetComment,
  531.                 DTGetComment
  532. */
  533. /*****************************************************************************/
  534. pascal  OSErr   DTOpen(ConstStr255Param volName,
  535.                        short vRefNum,
  536.                        short *dtRefNum,
  537.                        Boolean *newDTDatabase);
  538. /*   Open a volume's desktop database and return the desktop database refNum.
  539.     The DTOpen function opens a volume's desktop database. It returns
  540.     the reference number of the desktop database and indicates if the
  541.     desktop database was created as a result of this call (if it was created,
  542.     then it is empty).
  543.     volName         input:  A pointer to the name of a mounted volume
  544.                             or nil.
  545.     vRefNum         input:  Volume specification.
  546.     dtRefNum        output: The reference number of Desktop Manager's
  547.                             desktop database on the specified volume.
  548.     newDTDatabase   output: true if the desktop database was created as a
  549.                             result of this call and thus empty.
  550.                             false if the desktop database was already created,
  551.                             or if it could not be determined if it was already
  552.                             created.
  553.     Result Codes
  554.         noErr               0       No error
  555.         nsvErr              -35     Volume not found
  556.         ioErr               -36     I/O error
  557.         paramErr            -50     Volume doesn't support this function
  558.         extFSErr            -58     External file system error - no file
  559.                                     system claimed this call.
  560.         desktopDamagedErr   -1305   The desktop database has become corrupted -
  561.                                     the Finder will fix this, but if your
  562.                                     application is not running with the
  563.                                     Finder, use PBDTReset or PBDTDelete
  564. */
  565. /*****************************************************************************/
  566. pascal  OSErr   HGetVolParms(ConstStr255Param volName,
  567.                              short vRefNum,
  568.                              GetVolParmsInfoBuffer *volParmsInfo,
  569.                              long *infoSize);
  570. /*   Determine the characteristics of a volume.
  571.     The HGetVolParms function returns information about the characteristics
  572.     of a volume. A result of paramErr usually just means the volume doesn't
  573.     support PBHGetVolParms and the feature you were going to check
  574.     for isn't available.
  575.     volName         input:  A pointer to the name of a mounted volume
  576.                             or nil.
  577.     vRefNum         input:  Volume specification.
  578.     volParmsInfo    input:  Pointer to GetVolParmsInfoBuffer where the
  579.                             volume attributes information is returned.
  580.                     output: Atributes information.
  581.     infoSize        input:  Size of buffer pointed to by volParmsInfo.
  582.                     output: Size of data actually returned.
  583.     Result Codes
  584.         noErr               0       No error
  585.         nsvErr              -35     Volume not found
  586.         paramErr            -50     Volume doesn't support this function
  587.     __________
  588.     Also see the macros for checking attribute bits in MoreFilesExtras.h
  589. */
  590. /*****************************************************************************/
  591. pascal  OSErr   DeleteDirectoryContents(short vRefNum,
  592.                                         long dirID,
  593.                                         ConstStr255Param name);
  594. /*   Delete the contents of a directory.
  595.     The DeleteDirectoryContents function deletes the contents of a directory.
  596.     All files and subdirectories in the specified directory are deleted.
  597.     If a locked file or directory is encountered, it is unlocked and then
  598.     deleted.  If any unexpected errors are encountered,
  599.     DeleteDirectoryContents quits and returns to the caller.
  600.     vRefNum input:  Volume specification.
  601.     dirID   input:  Directory ID.
  602.     name    input:  Pointer to directory name, or nil when dirID specifies
  603.                     a directory that's the object.
  604.     Result Codes
  605.         noErr               0       No error
  606.         nsvErr              -35     No such volume
  607.         ioErr               -36     I/O error
  608.         bdNamErr            -37     Bad filename
  609.         fnfErr              -43     File not found
  610.         wPrErr              -44     Hardware volume lock
  611.         fLckdErr            -45     File is locked
  612.         vLckdErr            -46     Software volume lock
  613.         fBsyErr             -47     File busy, directory not empty, or working
  614.                                     directory control block open
  615.         paramErr            -50     No default volume
  616.         dirNFErr            -120    Directory not found or incomplete pathname
  617.         afpAccessDenied     -5000   User does not have the correct access
  618.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  619.     __________
  620.     Also see:   DeleteDirectory
  621. */
  622. /*****************************************************************************/
  623. pascal  OSErr   DeleteDirectory(short vRefNum,
  624.                                 long dirID,
  625.                                 ConstStr255Param name);
  626. /*   Delete a directory and its contents.
  627.     The DeleteDirectory function deletes a directory and its contents.
  628.     All files and subdirectories in the specified directory are deleted.
  629.     If a locked file or directory is encountered, it is unlocked and then
  630.     deleted.  After deleting the directories contents, the directory is
  631.     deleted. If any unexpected errors are encountered, DeleteDirectory
  632.     quits and returns to the caller.
  633.     vRefNum input:  Volume specification.
  634.     dirID   input:  Directory ID.
  635.     name    input:  Pointer to directory name, or nil when dirID specifies
  636.                     a directory that's the object.
  637.     Result Codes
  638.         noErr               0       No error
  639.         nsvErr              -35     No such volume
  640.         ioErr               -36     I/O error
  641.         bdNamErr            -37     Bad filename
  642.         fnfErr              -43     File not found
  643.         wPrErr              -44     Hardware volume lock
  644.         fLckdErr            -45     File is locked
  645.         vLckdErr            -46     Software volume lock
  646.         fBsyErr             -47     File busy, directory not empty, or working
  647.                                     directory control block open
  648.         paramErr            -50     No default volume
  649.         dirNFErr            -120    Directory not found or incomplete pathname
  650.         afpAccessDenied     -5000   User does not have the correct access
  651.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  652.     __________
  653.     Also see:   DeleteDirectoryContents
  654. */
  655. /*****************************************************************************/
  656. pascal  OSErr   DTSetComment(short vRefNum,
  657.                              long dirID,
  658.                              ConstStr255Param name,
  659.                              ConstStr255Param comment);
  660. /*   Set a file or directory's Finder comment field.
  661.     The DTSetComment function sets a file or directory's Finder comment
  662.     field. The volume must support the Desktop Manager because you only
  663.     have read access to the Desktop file.
  664.     vRefNum input:  Volume specification.
  665.     dirID   input:  Directory ID.
  666.     name    input:  Pointer to object name, or nil when dirID
  667.                     specifies a directory that's the object.
  668.     comment input:  The comment to add. Comments are limited to 200 characters;
  669.                     longer comments are truncated.
  670.     Result Codes
  671.         noErr               0       No error
  672.         nsvErr              -35     Volume not found
  673.         ioErr               -36     I/O error
  674.         fnfErr              -43     File or directory doesnt exist
  675.         paramErr            -50     Volume doesn't support this function
  676.         wPrErr              -44     Volume is locked through hardware
  677.         vLckdErr            -46     Volume is locked through software
  678.         rfNumErr            -51     Reference number invalid
  679.         extFSErr            -58     External file system error - no file
  680.                                     system claimed this call.
  681.         desktopDamagedErr   -1305   The desktop database has become corrupted -
  682.                                     the Finder will fix this, but if your
  683.                                     application is not running with the
  684.                                     Finder, use PBDTReset or PBDTDelete
  685.     __________
  686.     Also see:   DTCopyComment, FSpDTCopyComment, FSpDTSetComment, DTGetComment,
  687.                 FSpDTGetComment
  688. */
  689. /*****************************************************************************/
  690. pascal  OSErr   FSpDTSetComment(const FSSpec *spec,
  691.                                 ConstStr255Param comment);
  692. /*   Set a file or directory's Finder comment field.
  693.     The FSpDTSetComment function sets a file or directory's Finder comment
  694.     field. The volume must support the Desktop Manager because you only
  695.     have read access to the Desktop file.
  696.     spec    input:  An FSSpec record specifying the file or directory.
  697.     comment input:  The comment to add. Comments are limited to 200 characters;
  698.                     longer comments are truncated.
  699.     Result Codes
  700.         noErr               0       No error
  701.         nsvErr              -35     Volume not found
  702.         ioErr               -36     I/O error
  703.         fnfErr              -43     File or directory doesnt exist
  704.         wPrErr              -44     Volume is locked through hardware
  705.         vLckdErr            -46     Volume is locked through software
  706.         rfNumErr            -51     Reference number invalid
  707.         paramErr            -50     Volume doesn't support this function
  708.         extFSErr            -58     External file system error - no file
  709.                                     system claimed this call.
  710.         desktopDamagedErr   -1305   The desktop database has become corrupted -
  711.                                     the Finder will fix this, but if your
  712.                                     application is not running with the
  713.                                     Finder, use PBDTReset or PBDTDelete
  714.     __________
  715.     Also see:   DTCopyComment, FSpDTCopyComment, DTSetComment, DTGetComment,
  716.                 FSpDTGetComment
  717. */
  718. /*****************************************************************************/
  719. pascal  OSErr   XGetVInfo(short volReference,
  720.                           StringPtr volName,
  721.                           short *vRefNum,
  722.                           UnsignedWide *freeBytes,
  723.                           UnsignedWide *totalBytes);
  724. /*   Get extended information about a mounted volume.
  725.     The XGetVInfo function returns the name, volume reference number,
  726.     available space (in bytes), and total space (in bytes) for the
  727.     specified volume. You can specify the volume by providing its drive
  728.     number, volume reference number, or 0 for the default volume.
  729.     This routine is compatible with volumes up to 2 terabytes.
  730.     volReference    input:  The drive number, volume reference number,
  731.                             or 0 for the default volume.
  732.     volName         input:  A pointer to a buffer (minimum Str27) where
  733.                             the volume name is to be returned or must
  734.                             be nil.
  735.                     output: The volume name.
  736.     vRefNum         output: The volume reference number.
  737.     freeBytes       output: The number of free bytes on the volume.
  738.                             freeBytes is an UnsignedWide value.
  739.     totalBytes      output: The total number of bytes on the volume.
  740.                             totalBytes is an UnsignedWide value.
  741.     Result Codes
  742.         noErr               0       No error
  743.         nsvErr              -35     No such volume
  744.         paramErr            -50     No default volume
  745.     __________
  746.     Also see:   HGetVInfo
  747. */
  748. /*****************************************************************************/
  749. pascal  OSErr   HGetVInfo(short volReference,
  750.                           StringPtr volName,
  751.                           short *vRefNum,
  752.                           unsigned long *freeBytes,
  753.                           unsigned long *totalBytes);
  754. /*   Get information about a mounted volume.
  755.     The HGetVInfo function returns the name, volume reference number,
  756.     available space (in bytes), and total space (in bytes) for the
  757.     specified volume. You can specify the volume by providing its drive
  758.     number, volume reference number, or 0 for the default volume.
  759.     This routine is compatible with volumes up to 4 gigabytes.
  760.     volReference    input:  The drive number, volume reference number,
  761.                             or 0 for the default volume.
  762.     volName         input:  A pointer to a buffer (minimum Str27) where
  763.                             the volume name is to be returned or must
  764.                             be nil.
  765.                     output: The volume name.
  766.     vRefNum         output: The volume reference number.
  767.     freeBytes       output: The number of free bytes on the volume.
  768.                             freeBytes is an unsigned long value.
  769.     totalBytes      output: The total number of bytes on the volume.
  770.                             totalBytes is an unsigned long value.
  771.     Result Codes
  772.         noErr               0       No error
  773.         nsvErr              -35     No such volume
  774.         paramErr            -50     No default volume
  775.     __________
  776.     Also see:   XGetVInfo
  777. */
  778. /*****************************************************************************/
  779. pascal  OSErr   GetDirName(short vRefNum,
  780.                            long dirID,
  781.                            Str31 name);
  782. /*   Get the name of a directory from its directory ID.
  783.     The GetDirName function gets the name of a directory from its
  784.     directory ID.
  785.     vRefNum     input:  Volume specification.
  786.     dirID       input:  Directory ID.
  787.     name        output: Points to a Str31 where the directory name is to be
  788.                         returned.
  789.     Result Codes
  790.         noErr               0       No error
  791.         nsvErr              -35     No such volume
  792.         ioErr               -36     I/O error
  793.         bdNamErr            -37     Bad filename
  794.         fnfErr              -43     File not found
  795.         paramErr            -50     No default volume or
  796.                                     name parameter was NULL
  797.         dirNFErr            -120    Directory not found or incomplete pathname
  798.         afpAccessDenied     -5000   User does not have the correct access
  799.         afpObjectTypeErr    -5025   Directory not found or incomplete pathname
  800. */
  801. #endif    /*  _MACSTUFF_H  */