1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
|
#ifndef _MACSTUFF_H
#define _MACSTUFF_H 1
/*
These Functions were originally part of More Files version 1.4.8
More Files fixes many of the broken or underfunctional
parts of the file system.
More Files
A collection of File Manager and related routines
by Jim Luther (Apple Macintosh Developer Technical Support Emeritus)
with significant code contributions by Nitin Ganatra
(Apple Macintosh Developer Technical Support Emeritus)
Copyright 1992-1998 Apple Computer, Inc.
Portions copyright 1995 Jim Luther
All rights reserved.
The Package "More Files" is distributed under the following
license terms:
"You may incorporate this sample code into your
applications without restriction, though the
sample code has been provided "AS IS" and the
responsibility for its operation is 100% yours.
However, what you are not permitted to do is to
redistribute the source as "DSC Sample Code" after
having made changes. If you're going to
redistribute the source, we require that you make
it clear in the source that the code was descended
from Apple Sample Code, but that you've made
changes."
The following changes are made by Info-ZIP:
- The only changes are made by pasting the functions
(mostly found in MoreFilesExtras.c / MoreFiles.c)
directly into macstuff.c / macstuff.h and slightly
reformatting the text (replacement of TABs by spaces,
removal/replacement of non-ASCII characters).
The code itself is NOT changed.
This file has been modified by Info-ZIP for use in MacZip.
This file is NOT part of the original package More Files.
More Files can be found on the MetroWerks CD and Developer CD from
Apple. You can also download the latest version from:
http://members.aol.com/JumpLong/#MoreFiles
Jim Luther's Home-page:
http://members.aol.com/JumpLong/
*/
#define __MACOSSEVENFIVEONEORLATER 1
#define __MACOSSEVENFIVEORLATER 1
#define __MACOSSEVENORLATER 1
#include <Errors.h>
#include <Files.h>
/*
* Like the MoreFiles routines these fix problems in the standard
* Mac calls.
*/
int FSpLocationFromPath (int length,const char *path, FSSpecPtr theSpec);
OSErr FSpPathFromLocation (FSSpecPtr theSpec,int *length, Handle *fullPath);
#define hasDesktopMgr(volParms) (((volParms).vMAttrib & (1L << bHasDesktopMgr)) != 0)
/*
* The following routines are utility functions. They are exported
* here because they are needed and they are not officially supported,
* however. The first set are from the MoreFiles package.
*/
int FSpGetDefaultDir (FSSpecPtr theSpec);
int FSpSetDefaultDir (FSSpecPtr dirSpec);
pascal OSErr FSpGetDirectoryID(const FSSpec *spec,long *theDirID,
Boolean *isDirectory);
pascal short FSpOpenResFileCompat(const FSSpec *spec, SignedByte permission);
pascal void FSpCreateResFileCompat(const FSSpec *spec,OSType creator,
OSType fileType,
ScriptCode scriptTag);
OSErr FSpFindFolder (short vRefNum, OSType folderType,
Boolean createFolder,
FSSpec *spec);
/*****************************************************************************/
pascal OSErr GetVolumeInfoNoName(ConstStr255Param pathname,
short vRefNum,
HParmBlkPtr pb);
/* Call PBHGetVInfoSync ignoring returned name.
GetVolumeInfoNoName uses pathname and vRefNum to call PBHGetVInfoSync
in cases where the returned volume name is not needed by the caller.
The pathname and vRefNum parameters are not touched, and the pb
parameter is initialized by PBHGetVInfoSync except that ioNamePtr in
the parameter block is always returned as NULL (since it might point
to GetVolumeInfoNoName's local variable tempPathname).
I noticed using this code in several places, so here it is once.
This reduces the code size of MoreFiles.
pathName input: Pointer to a full pathname or nil. If you pass in a
partial pathname, it is ignored. A full pathname to a
volume must end with a colon character (:).
vRefNum input: Volume specification (volume reference number, working
directory number, drive number, or 0).
pb input: A pointer to HParamBlockRec.
output: The parameter block as filled in by PBHGetVInfoSync
except that ioNamePtr will always be NULL.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
paramErr -50 No default volume, or pb was NULL
*/
/*****************************************************************************/
pascal OSErr GetFilenameFromPathname(ConstStr255Param pathname,
Str255 filename);
/* Get the object name from the end of a full or partial pathname.
The GetFilenameFromPathname function gets the file (or directory) name
from the end of a full or partial pathname. Returns notAFileErr if the
pathname is nil, the pathname is empty, or the pathname cannot refer to
a filename (with a noErr result, the pathname could still refer to a
directory).
pathname input: A full or partial pathname.
filename output: The file (or directory) name.
Result Codes
noErr 0 No error
notAFileErr -1302 The pathname is nil, the pathname
is empty, or the pathname cannot refer
to a filename
__________
See also: GetObjectLocation.
*/
/*****************************************************************************/
pascal OSErr FSMakeFSSpecCompat(short vRefNum, long dirID,
ConstStr255Param fileName,
FSSpec *spec);
/* Initialize a FSSpec record.
The FSMakeFSSpecCompat function fills in the fields of an FSSpec record.
If the file system can't create the FSSpec, then the compatibility code
creates a FSSpec that is exactly like an FSSpec except that spec.name
for a file may not have the same capitalization as the file's catalog
entry on the disk volume. That is because fileName is parsed to get the
name instead of getting the name back from the file system. This works
fine with System 6 where FSMakeSpec isn't available.
vRefNum input: Volume specification.
dirID input: Directory ID.
fileName input: Pointer to object name, or nil when dirID specifies
a directory that's the object.
spec output: A file system specification to be filled in by
FSMakeFSSpecCompat.
Result Codes
noErr 0 No error
nsvErr -35 Volume doesnt exist
fnfErr -43 File or directory does not exist
(FSSpec is still valid)
*/
#if !SystemSevenOrLater
static Boolean FSHasFSSpecCalls(void);
static Boolean QTHasFSSpecCalls(void);
#endif /* !SystemSevenOrLater */
/*****************************************************************************/
pascal OSErr GetObjectLocation(short vRefNum,
long dirID,
ConstStr255Param pathname,
short *realVRefNum,
long *realParID,
Str255 realName,
Boolean *isDirectory);
/* Get a file system object's location.
The GetObjectLocation function gets a file system object's location -
that is, its real volume reference number, real parent directory ID,
and name. While we're at it, determine if the object is a file or directory.
If GetObjectLocation returns fnfErr, then the location information
returned is valid, but it describes an object that doesn't exist.
You can use the location information for another operation, such as
creating a file or directory.
vRefNum input: Volume specification.
dirID input: Directory ID.
pathname input: Pointer to object name, or nil when dirID specifies
a directory that's the object.
realVRefNum output: The real volume reference number.
realParID output: The parent directory ID of the specified object.
realName output: The name of the specified object (the case of the
object name may not be the same as the object's
catalog entry on disk - since the Macintosh file
system is not case sensitive, it shouldn't matter).
isDirectory output: True if object is a directory; false if object
is a file.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
notAFileErr -1302 The pathname is nil, the pathname
is empty, or the pathname cannot refer
to a filename
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: FSMakeFSSpecCompat
*/
pascal OSErr FSpGetDirectoryID(const FSSpec *spec, long *theDirID,
Boolean *isDirectory);
pascal OSErr GetDirectoryID(short vRefNum,long dirID,ConstStr255Param name,
long *theDirID,Boolean *isDirectory);
/*****************************************************************************/
pascal OSErr GetCatInfoNoName(short vRefNum,
long dirID,
ConstStr255Param name,
CInfoPBPtr pb);
/* Call PBGetCatInfoSync ignoring returned name.
GetCatInfoNoName uses vRefNum, dirID and name to call PBGetCatInfoSync
in cases where the returned object is not needed by the caller.
The vRefNum, dirID and name parameters are not touched, and the pb
parameter is initialized by PBGetCatInfoSync except that ioNamePtr in
the parameter block is always returned as NULL (since it might point
to GetCatInfoNoName's local variable tempName).
I noticed using this code in several places, so here it is once.
This reduces the code size of MoreFiles.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID
specifies a directory that's the object.
pb input: A pointer to CInfoPBRec.
output: The parameter block as filled in by
PBGetCatInfoSync except that ioNamePtr will
always be NULL.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
*/
/*****************************************************************************/
pascal OSErr DetermineVRefNum(ConstStr255Param pathname,
short vRefNum,
short *realVRefNum);
/* Determine the real volume reference number.
The DetermineVRefNum function determines the volume reference number of
a volume from a pathname, a volume specification, or a combination
of the two.
WARNING: Volume names on the Macintosh are *not* unique -- Multiple
mounted volumes can have the same name. For this reason, the use of a
volume name or full pathname to identify a specific volume may not
produce the results you expect. If more than one volume has the same
name and a volume name or full pathname is used, the File Manager
currently uses the first volume it finds with a matching name in the
volume queue.
pathName input: Pointer to a full pathname or nil. If you pass in a
partial pathname, it is ignored. A full pathname to a
volume must end with a colon character (:).
vRefNum input: Volume specification (volume reference number, working
directory number, drive number, or 0).
realVRefNum output: The real volume reference number.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
paramErr -50 No default volume
*/
/*****************************************************************************/
pascal OSErr FSpGetFullPath(const FSSpec *spec,
short *fullPathLength,
Handle *fullPath);
/* Get a full pathname to a volume, directory or file.
The GetFullPath function builds a full pathname to the specified
object. The full pathname is returned in the newly created handle
fullPath and the length of the full pathname is returned in
fullPathLength. Your program is responsible for disposing of the
fullPath handle.
spec input: An FSSpec record specifying the object.
fullPathLength output: The number of characters in the full pathname.
If the function fails to create a full pathname,
it sets fullPathLength to 0.
fullPath output: A handle to the newly created full pathname
buffer. If the function fails to create a
full pathname, it sets fullPath to NULL.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File or directory does not exist
paramErr -50 No default volume
memFullErr -108 Not enough memory
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: GetFullPath
*/
/*****************************************************************************/
pascal OSErr FSpLocationFromFullPath(short fullPathLength,
const void *fullPath,
FSSpec *spec);
/* Get a FSSpec from a full pathname.
The FSpLocationFromFullPath function returns a FSSpec to the object
specified by full pathname. This function requires the Alias Manager.
fullPathLength input: The number of characters in the full pathname
of the target.
fullPath input: A pointer to a buffer that contains the full
pathname of the target. The full pathname
starts with the name of the volume, includes
all of the directory names in the path to the
target, and ends with the target name.
spec output: An FSSpec record specifying the object.
Result Codes
noErr 0 No error
nsvErr -35 The volume is not mounted
fnfErr -43 Target not found, but volume and parent
directory found
paramErr -50 Parameter error
usrCanceledErr -128 The user canceled the operation
__________
See also: LocationFromFullPath
*/
/*****************************************************************************/
pascal OSErr GetFullPath(short vRefNum,
long dirID,
ConstStr255Param name,
short *fullPathLength,
Handle *fullPath);
/* Get a full pathname to a volume, directory or file.
The GetFullPath function builds a full pathname to the specified
object. The full pathname is returned in the newly created handle
fullPath and the length of the full pathname is returned in
fullPathLength. Your program is responsible for disposing of the
fullPath handle.
Note that a full pathname can be made to a file/directory that does not
yet exist if all directories up to that file/directory exist. In this case,
GetFullPath will return a fnfErr.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID
specifies a directory that's the object.
fullPathLength output: The number of characters in the full pathname.
If the function fails to create a full
pathname, it sets fullPathLength to 0.
fullPath output: A handle to the newly created full pathname
buffer. If the function fails to create a
full pathname, it sets fullPath to NULL.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File or directory does not exist (fullPath
and fullPathLength are still valid)
paramErr -50 No default volume
memFullErr -108 Not enough memory
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: FSpGetFullPath
*/
/*****************************************************************************/
pascal OSErr ChangeCreatorType(short vRefNum,
long dirID,
ConstStr255Param name,
OSType creator,
OSType fileType);
/* Change the creator or file type of a file.
The ChangeCreatorType function changes the creator or file type of a file.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: The name of the file.
creator input: The new creator type or 0x00000000 to leave
the creator type alone.
fileType input: The new file type or 0x00000000 to leave the
file type alone.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
fLckdErr -45 File is locked
vLckdErr -46 Volume is locked or read-only
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
notAFileErr -1302 Name was not a file
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: FSpChangeCreatorType
*/
/*****************************************************************************/
pascal OSErr FSpChangeCreatorType(const FSSpec *spec,
OSType creator,
OSType fileType);
/* Change the creator or file type of a file.
The FSpChangeCreatorType function changes the creator or file type of a file.
spec input: An FSSpec record specifying the file.
creator input: The new creator type or 0x00000000 to leave
the creator type alone.
fileType input: The new file type or 0x00000000 to leave the
file type alone.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
fLckdErr -45 File is locked
vLckdErr -46 Volume is locked or read-only
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
notAFileErr -1302 Name was not a file
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: ChangeCreatorType
*/
/*****************************************************************************/
pascal OSErr BumpDate(short vRefNum,
long dirID,
ConstStr255Param name);
/* Update the modification date of a file or directory.
The BumpDate function changes the modification date of a file or
directory to the current date/time. If the modification date is already
equal to the current date/time, then add one second to the
modification date.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID specifies
a directory that's the object.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
fLckdErr -45 File is locked
vLckdErr -46 Volume is locked or read-only
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: FSpBumpDate
*/
/*****************************************************************************/
pascal OSErr FSpBumpDate(const FSSpec *spec);
/* Update the modification date of a file or directory.
The FSpBumpDate function changes the modification date of a file or
directory to the current date/time. If the modification date is already
equal to the current date/time, then add one second to the
modification date.
spec input: An FSSpec record specifying the object.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
fLckdErr -45 File is locked
vLckdErr -46 Volume is locked or read-only
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
See also: BumpDate
*/
/*****************************************************************************/
pascal OSErr OnLine(FSSpecPtr volumes,
short reqVolCount,
short *actVolCount,
short *volIndex);
/* Return the list of volumes currently mounted.
The OnLine function returns the list of volumes currently mounted in
an array of FSSpec records.
A noErr result indicates that the volumes array was filled
(actVolCount == reqVolCount) and there may be additional volumes
mounted. A nsvErr result indicates that the end of the volume list
was found and actVolCount volumes were actually found this time.
volumes input: Pointer to array of FSSpec where the volume list
is returned.
reqVolCount input: Maximum number of volumes to return (the number of
elements in the volumes array).
actVolCount output: The number of volumes actually returned.
volIndex input: The current volume index position. Set to 1 to
start with the first volume.
output: The volume index position to get the next volume.
Pass this value the next time you call OnLine to
start where you left off.
Result Codes
noErr 0 No error, but there are more volumes
to list
nsvErr -35 No more volumes to be listed
paramErr -50 volIndex was <= 0
*/
/*****************************************************************************/
pascal OSErr DTGetComment(short vRefNum,
long dirID,
ConstStr255Param name,
Str255 comment);
/* Get a file or directory's Finder comment field (if any).
The DTGetComment function gets a file or directory's Finder comment
field (if any) from the Desktop Manager or if the Desktop Manager is
not available, from the Finder's Desktop file.
IMPORTANT NOTE: Inside Macintosh says that comments are up to
200 characters. While that may be correct for the HFS file system's
Desktop Manager, other file systems (such as Apple Photo Access) return
up to 255 characters. Make sure the comment buffer is a Str255 or you'll
regret it.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID
specifies a directory that's the object.
comment output: A Str255 where the comment is to be returned.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
ioErr -36 I/O error
fnfErr -43 File not found
paramErr -50 Volume doesn't support this function
rfNumErr -51 Reference number invalid
extFSErr -58 External file system error - no file
system claimed this call.
desktopDamagedErr -1305 The desktop database has become corrupted -
the Finder will fix this, but if your
application is not running with the
Finder, use PBDTReset or PBDTDelete
afpItemNotFound -5012 Information not found
__________
Also see: DTCopyComment, FSpDTCopyComment, DTSetComment, FSpDTSetComment,
FSpDTGetComment
*/
/*****************************************************************************/
pascal OSErr FSpDTGetComment(const FSSpec *spec,
Str255 comment);
/* Get a file or directory's Finder comment field (if any).
The FSpDTGetComment function gets a file or directory's Finder comment
field (if any) from the Desktop Manager or if the Desktop Manager is
not available, from the Finder's Desktop file.
IMPORTANT NOTE: Inside Macintosh says that comments are up to
200 characters. While that may be correct for the HFS file system's
Desktop Manager, other file systems (such as Apple Photo Access) return
up to 255 characters. Make sure the comment buffer is a Str255 or you'll
regret it.
spec input: An FSSpec record specifying the file or directory.
comment output: A Str255 where the comment is to be returned.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
ioErr -36 I/O error
fnfErr -43 File not found
paramErr -50 Volume doesn't support this function
rfNumErr -51 Reference number invalid
extFSErr -58 External file system error - no file
system claimed this call.
desktopDamagedErr -1305 The desktop database has become corrupted -
the Finder will fix this, but if your
application is not running with the
Finder, use PBDTReset or PBDTDelete
afpItemNotFound -5012 Information not found
__________
Also see: DTCopyComment, FSpDTCopyComment, DTSetComment, FSpDTSetComment,
DTGetComment
*/
/*****************************************************************************/
pascal OSErr DTOpen(ConstStr255Param volName,
short vRefNum,
short *dtRefNum,
Boolean *newDTDatabase);
/* Open a volume's desktop database and return the desktop database refNum.
The DTOpen function opens a volume's desktop database. It returns
the reference number of the desktop database and indicates if the
desktop database was created as a result of this call (if it was created,
then it is empty).
volName input: A pointer to the name of a mounted volume
or nil.
vRefNum input: Volume specification.
dtRefNum output: The reference number of Desktop Manager's
desktop database on the specified volume.
newDTDatabase output: true if the desktop database was created as a
result of this call and thus empty.
false if the desktop database was already created,
or if it could not be determined if it was already
created.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
ioErr -36 I/O error
paramErr -50 Volume doesn't support this function
extFSErr -58 External file system error - no file
system claimed this call.
desktopDamagedErr -1305 The desktop database has become corrupted -
the Finder will fix this, but if your
application is not running with the
Finder, use PBDTReset or PBDTDelete
*/
/*****************************************************************************/
pascal OSErr HGetVolParms(ConstStr255Param volName,
short vRefNum,
GetVolParmsInfoBuffer *volParmsInfo,
long *infoSize);
/* Determine the characteristics of a volume.
The HGetVolParms function returns information about the characteristics
of a volume. A result of paramErr usually just means the volume doesn't
support PBHGetVolParms and the feature you were going to check
for isn't available.
volName input: A pointer to the name of a mounted volume
or nil.
vRefNum input: Volume specification.
volParmsInfo input: Pointer to GetVolParmsInfoBuffer where the
volume attributes information is returned.
output: Atributes information.
infoSize input: Size of buffer pointed to by volParmsInfo.
output: Size of data actually returned.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
paramErr -50 Volume doesn't support this function
__________
Also see the macros for checking attribute bits in MoreFilesExtras.h
*/
/*****************************************************************************/
pascal OSErr DeleteDirectoryContents(short vRefNum,
long dirID,
ConstStr255Param name);
/* Delete the contents of a directory.
The DeleteDirectoryContents function deletes the contents of a directory.
All files and subdirectories in the specified directory are deleted.
If a locked file or directory is encountered, it is unlocked and then
deleted. If any unexpected errors are encountered,
DeleteDirectoryContents quits and returns to the caller.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to directory name, or nil when dirID specifies
a directory that's the object.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
wPrErr -44 Hardware volume lock
fLckdErr -45 File is locked
vLckdErr -46 Software volume lock
fBsyErr -47 File busy, directory not empty, or working
directory control block open
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
Also see: DeleteDirectory
*/
/*****************************************************************************/
pascal OSErr DeleteDirectory(short vRefNum,
long dirID,
ConstStr255Param name);
/* Delete a directory and its contents.
The DeleteDirectory function deletes a directory and its contents.
All files and subdirectories in the specified directory are deleted.
If a locked file or directory is encountered, it is unlocked and then
deleted. After deleting the directories contents, the directory is
deleted. If any unexpected errors are encountered, DeleteDirectory
quits and returns to the caller.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to directory name, or nil when dirID specifies
a directory that's the object.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
wPrErr -44 Hardware volume lock
fLckdErr -45 File is locked
vLckdErr -46 Software volume lock
fBsyErr -47 File busy, directory not empty, or working
directory control block open
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
Also see: DeleteDirectoryContents
*/
/*****************************************************************************/
pascal OSErr DTSetComment(short vRefNum,
long dirID,
ConstStr255Param name,
ConstStr255Param comment);
/* Set a file or directory's Finder comment field.
The DTSetComment function sets a file or directory's Finder comment
field. The volume must support the Desktop Manager because you only
have read access to the Desktop file.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID
specifies a directory that's the object.
comment input: The comment to add. Comments are limited to 200 characters;
longer comments are truncated.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
ioErr -36 I/O error
fnfErr -43 File or directory doesnt exist
paramErr -50 Volume doesn't support this function
wPrErr -44 Volume is locked through hardware
vLckdErr -46 Volume is locked through software
rfNumErr -51 Reference number invalid
extFSErr -58 External file system error - no file
system claimed this call.
desktopDamagedErr -1305 The desktop database has become corrupted -
the Finder will fix this, but if your
application is not running with the
Finder, use PBDTReset or PBDTDelete
__________
Also see: DTCopyComment, FSpDTCopyComment, FSpDTSetComment, DTGetComment,
FSpDTGetComment
*/
/*****************************************************************************/
pascal OSErr FSpDTSetComment(const FSSpec *spec,
ConstStr255Param comment);
/* Set a file or directory's Finder comment field.
The FSpDTSetComment function sets a file or directory's Finder comment
field. The volume must support the Desktop Manager because you only
have read access to the Desktop file.
spec input: An FSSpec record specifying the file or directory.
comment input: The comment to add. Comments are limited to 200 characters;
longer comments are truncated.
Result Codes
noErr 0 No error
nsvErr -35 Volume not found
ioErr -36 I/O error
fnfErr -43 File or directory doesnt exist
wPrErr -44 Volume is locked through hardware
vLckdErr -46 Volume is locked through software
rfNumErr -51 Reference number invalid
paramErr -50 Volume doesn't support this function
extFSErr -58 External file system error - no file
system claimed this call.
desktopDamagedErr -1305 The desktop database has become corrupted -
the Finder will fix this, but if your
application is not running with the
Finder, use PBDTReset or PBDTDelete
__________
Also see: DTCopyComment, FSpDTCopyComment, DTSetComment, DTGetComment,
FSpDTGetComment
*/
/*****************************************************************************/
pascal OSErr XGetVInfo(short volReference,
StringPtr volName,
short *vRefNum,
UnsignedWide *freeBytes,
UnsignedWide *totalBytes);
/* Get extended information about a mounted volume.
The XGetVInfo function returns the name, volume reference number,
available space (in bytes), and total space (in bytes) for the
specified volume. You can specify the volume by providing its drive
number, volume reference number, or 0 for the default volume.
This routine is compatible with volumes up to 2 terabytes.
volReference input: The drive number, volume reference number,
or 0 for the default volume.
volName input: A pointer to a buffer (minimum Str27) where
the volume name is to be returned or must
be nil.
output: The volume name.
vRefNum output: The volume reference number.
freeBytes output: The number of free bytes on the volume.
freeBytes is an UnsignedWide value.
totalBytes output: The total number of bytes on the volume.
totalBytes is an UnsignedWide value.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
paramErr -50 No default volume
__________
Also see: HGetVInfo
*/
/*****************************************************************************/
pascal OSErr HGetVInfo(short volReference,
StringPtr volName,
short *vRefNum,
unsigned long *freeBytes,
unsigned long *totalBytes);
/* Get information about a mounted volume.
The HGetVInfo function returns the name, volume reference number,
available space (in bytes), and total space (in bytes) for the
specified volume. You can specify the volume by providing its drive
number, volume reference number, or 0 for the default volume.
This routine is compatible with volumes up to 4 gigabytes.
volReference input: The drive number, volume reference number,
or 0 for the default volume.
volName input: A pointer to a buffer (minimum Str27) where
the volume name is to be returned or must
be nil.
output: The volume name.
vRefNum output: The volume reference number.
freeBytes output: The number of free bytes on the volume.
freeBytes is an unsigned long value.
totalBytes output: The total number of bytes on the volume.
totalBytes is an unsigned long value.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
paramErr -50 No default volume
__________
Also see: XGetVInfo
*/
/*****************************************************************************/
pascal OSErr GetDirName(short vRefNum,
long dirID,
Str31 name);
/* Get the name of a directory from its directory ID.
The GetDirName function gets the name of a directory from its
directory ID.
vRefNum input: Volume specification.
dirID input: Directory ID.
name output: Points to a Str31 where the directory name is to be
returned.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
paramErr -50 No default volume or
name parameter was NULL
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
*/
/*****************************************************************************/
pascal OSErr GetVolFileSystemID(ConstStr255Param pathname,
short vRefNum,
short *fileSystemID);
/* Get a volume's file system ID.
The GetVolFileSystemID function returned the file system ID of
a mounted volume. The file system ID identifies the file system
that handles requests to a particular volume. Here's a partial list
of file system ID numbers (only Apple's file systems are listed):
FSID File System
----- -----------------------------------------------------
$0000 Macintosh HFS or MFS
$0100 ProDOS File System
$0101 PowerTalk Mail Enclosures
$4147 ISO 9660 File Access (through Foreign File Access)
$4242 High Sierra File Access (through Foreign File Access)
$464D QuickTake File System (through Foreign File Access)
$4953 Macintosh PC Exchange (MS-DOS)
$4A48 Audio CD Access (through Foreign File Access)
$4D4B Apple Photo Access (through Foreign File Access)
See the Technical Note "FL 35 - Determining Which File System
Is Active" and the "Guide to the File System Manager" for more
information.
pathName input: Pointer to a full pathname or nil. If you pass
in a partial pathname, it is ignored. A full
pathname to a volume must contain at least
one colon character (:) and must not start with
a colon character.
vRefNum input: Volume specification (volume reference number,
working directory number, drive number, or 0).
fileSystemID output: The volume's file system ID.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
paramErr -50 No default volume, or pb was NULL
*/
/*****************************************************************************/
pascal OSErr GetDInfo(short vRefNum,
long dirID,
ConstStr255Param name,
DInfo *fndrInfo);
/* Get the finder information for a directory.
The GetDInfo function gets the finder information for a directory.
vRefNum input: Volume specification.
dirID input: Directory ID.
name input: Pointer to object name, or nil when dirID
specifies a directory that's the object.
fndrInfo output: If the object is a directory, then its DInfo.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
Also see: FSpGetDInfo, FSpGetFInfoCompat
*/
/*****************************************************************************/
pascal OSErr FSpGetDInfo(const FSSpec *spec,
DInfo *fndrInfo);
/* Get the finder information for a directory.
The FSpGetDInfo function gets the finder information for a directory.
spec input: An FSSpec record specifying the directory.
fndrInfo output: If the object is a directory, then its DInfo.
Result Codes
noErr 0 No error
nsvErr -35 No such volume
ioErr -36 I/O error
bdNamErr -37 Bad filename
fnfErr -43 File not found
paramErr -50 No default volume
dirNFErr -120 Directory not found or incomplete pathname
afpAccessDenied -5000 User does not have the correct access
afpObjectTypeErr -5025 Directory not found or incomplete pathname
__________
Also see: FSpGetFInfoCompat, GetDInfo
*/
#endif /* _MACSTUFF_H */
|