mirror of
https://github.com/nickshanks/ResKnife.git
synced 2024-06-03 01:29:40 +00:00
1 line
24 KiB
C
Executable File
1 line
24 KiB
C
Executable File
/*
|
|
File: MoreDesktopMgr.h
|
|
|
|
Contains: A collection of useful high-level Desktop Manager routines. If the Desktop Manager is not available, use the Desktop file for 'read' operations.
|
|
|
|
Version: Technology: MoreFiles
|
|
Release: 1.5.2
|
|
|
|
Copyright: © 1992-2001 by Apple Computer, Inc., all rights reserved.
|
|
|
|
Bugs?: For bug reports, consult the following page on
|
|
the World Wide Web:
|
|
|
|
http://developer.apple.com/bugreporter/
|
|
|
|
*/
|
|
|
|
/*
|
|
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 re-distribute 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.
|
|
*/
|
|
|
|
#ifndef __MOREDESKTOPMGR__
|
|
#define __MOREDESKTOPMGR__
|
|
|
|
#ifndef __MACTYPES__
|
|
#include <MacTypes.h>
|
|
#endif
|
|
|
|
#ifndef __FILES__
|
|
#include <Files.h>
|
|
#endif
|
|
|
|
#include "Optimization.h"
|
|
|
|
|
|
#if PRAGMA_ONCE
|
|
#pragma once
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if PRAGMA_IMPORT
|
|
#pragma import on
|
|
#endif
|
|
|
|
#if PRAGMA_STRUCT_ALIGN
|
|
#pragma options align=mac68k
|
|
#elif PRAGMA_STRUCT_PACKPUSH
|
|
#pragma pack(push, 2)
|
|
#elif PRAGMA_STRUCT_PACK
|
|
#pragma pack(2)
|
|
#endif
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTOpen(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
short * dtRefNum,
|
|
Boolean * newDTDatabase);
|
|
|
|
|
|
/*
|
|
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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTXGetAPPL(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
OSType creator,
|
|
Boolean searchCatalog,
|
|
short * applVRefNum,
|
|
long * applParID,
|
|
Str255 applName);
|
|
|
|
|
|
/*
|
|
The DTXGetAPPL function finds an application (file type 'APPL') with
|
|
the specified creator on the specified volume. It first tries to get
|
|
the application mapping from the desktop database. If that fails,
|
|
then it tries to find an application in the Desktop file. If that
|
|
fails and searchCatalog is true, then it tries to find an application
|
|
with the specified creator using the File Manager's CatSearch routine.
|
|
|
|
volName input: A pointer to the name of a mounted volume
|
|
or nil.
|
|
vRefNum input: Volume specification.
|
|
creator input: The file's creator type.
|
|
searchCatalog input: If true, search the catalog for the application
|
|
if it isn't found in the desktop database.
|
|
applVRefNum output: The volume reference number of the volume the
|
|
application is on.
|
|
applParID output: The parent directory ID of the application.
|
|
applName output: The name of the application.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
paramErr -50 No default volume
|
|
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: FSpDTGetAPPL
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
FSpDTXGetAPPL(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
OSType creator,
|
|
Boolean searchCatalog,
|
|
FSSpec * spec);
|
|
|
|
|
|
/*
|
|
The FSpDTXGetAPPL function finds an application (file type 'APPL') with
|
|
the specified creator on the specified volume. It first tries to get
|
|
the application mapping from the desktop database. If that fails,
|
|
then it tries to find an application in the Desktop file. If that
|
|
fails and searchCatalog is true, then it tries to find an application
|
|
with the specified creator using the File Manager's CatSearch routine.
|
|
|
|
volName input: A pointer to the name of a mounted volume
|
|
or nil.
|
|
vRefNum input: Volume specification.
|
|
creator input: The file's creator type.
|
|
searchCatalog input: If true, search the catalog for the application
|
|
if it isn't found in the desktop database.
|
|
spec output: FSSpec record containing the application name and
|
|
location.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
paramErr -50 No default volume
|
|
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: FSpDTGetAPPL
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTGetAPPL(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
OSType creator,
|
|
short * applVRefNum,
|
|
long * applParID,
|
|
Str255 applName);
|
|
|
|
|
|
/*
|
|
The DTGetAPPL function finds an application (file type 'APPL') with
|
|
the specified creator on the specified volume. It first tries to get
|
|
the application mapping from the desktop database. If that fails,
|
|
then it tries to find an application in the Desktop file. If that
|
|
fails, then it tries to find an application with the specified creator
|
|
using the File Manager's CatSearch routine.
|
|
|
|
volName input: A pointer to the name of a mounted volume
|
|
or nil.
|
|
vRefNum input: Volume specification.
|
|
creator input: The file's creator type.
|
|
applVRefNum output: The volume reference number of the volume the
|
|
application is on.
|
|
applParID output: The parent directory ID of the application.
|
|
applName output: The name of the application.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
paramErr -50 No default volume
|
|
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: FSpDTGetAPPL
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
FSpDTGetAPPL(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
OSType creator,
|
|
FSSpec * spec);
|
|
|
|
|
|
/*
|
|
The FSpDTGetAPPL function finds an application (file type 'APPL') with
|
|
the specified creator on the specified volume. It first tries to get
|
|
the application mapping from the desktop database. If that fails,
|
|
then it tries to find an application in the Desktop file. If that
|
|
fails, then it tries to find an application with the specified creator
|
|
using the File Manager's CatSearch routine.
|
|
|
|
volName input: A pointer to the name of a mounted volume
|
|
or nil.
|
|
vRefNum input: Volume specification.
|
|
creator input: The file's creator type.
|
|
spec output: FSSpec record containing the application name and
|
|
location.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
paramErr -50 No default volume
|
|
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: DTGetAPPL
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTGetIcon(
|
|
ConstStr255Param volName,
|
|
short vRefNum,
|
|
short iconType,
|
|
OSType fileCreator,
|
|
OSType fileType,
|
|
Handle * iconHandle);
|
|
|
|
|
|
/*
|
|
The DTGetIcon function retrieves the specified icon and returns it in
|
|
a newly created handle. The icon is retrieves from the Desktop Manager
|
|
or if the Desktop Manager is not available, from the Finder's Desktop
|
|
file. Your program is responsible for disposing of the handle when it is
|
|
done using the icon.
|
|
|
|
volName input: A pointer to the name of a mounted volume
|
|
or nil.
|
|
vRefNum input: Volume specification.
|
|
iconType input: The icon type as defined in Files.h. Valid values are:
|
|
kLargeIcon
|
|
kLarge4BitIcon
|
|
kLarge8BitIcon
|
|
kSmallIcon
|
|
kSmall4BitIcon
|
|
kSmall8BitIcon
|
|
fileCreator input: The icon's creator type.
|
|
fileType input: The icon's file type.
|
|
iconHandle output: A Handle containing the newly created icon.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
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
|
|
memFullErr -108 iconHandle could not be allocated
|
|
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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTSetComment(
|
|
short vRefNum,
|
|
long dirID,
|
|
ConstStr255Param name,
|
|
ConstStr255Param comment);
|
|
|
|
|
|
/*
|
|
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 doesnÕt 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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
FSpDTSetComment(
|
|
const FSSpec * spec,
|
|
ConstStr255Param comment);
|
|
|
|
|
|
/*
|
|
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 doesnÕt 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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTGetComment(
|
|
short vRefNum,
|
|
long dirID,
|
|
ConstStr255Param name,
|
|
Str255 comment);
|
|
|
|
|
|
/*
|
|
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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
FSpDTGetComment(
|
|
const FSSpec * spec,
|
|
Str255 comment);
|
|
|
|
|
|
/*
|
|
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
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
DTCopyComment(
|
|
short srcVRefNum,
|
|
long srcDirID,
|
|
ConstStr255Param srcName,
|
|
short dstVRefNum,
|
|
long dstDirID,
|
|
ConstStr255Param dstName);
|
|
|
|
|
|
/*
|
|
The DTCopyComment function copies the file or folder comment from the
|
|
source to the destination object. The destination volume must support
|
|
the Desktop Manager because you only have read access to the Desktop file.
|
|
|
|
srcVRefNum input: Source volume specification.
|
|
srcDirID input: Source directory ID.
|
|
srcName input: Pointer to source object name, or nil when srcDirID
|
|
specifies a directory that's the object.
|
|
dstVRefNum input: Destination volume specification.
|
|
dstDirID input: Destination directory ID.
|
|
dstName input: Pointer to destination object name, or nil when
|
|
dstDirID specifies a directory that's the object.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
fnfErr Ð43 File or directory doesnÕt exist
|
|
wPrErr Ð44 Volume is locked through hardware
|
|
vLckdErr Ð46 Volume is locked through software
|
|
paramErr -50 Volume doesn't support this function
|
|
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
|
|
afpItemNotFound -5012 Information not found
|
|
|
|
__________
|
|
|
|
Also see: FSpDTCopyComment, DTSetComment, FSpDTSetComment, DTGetComment,
|
|
FSpDTGetComment
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
EXTERN_API( OSErr )
|
|
FSpDTCopyComment(
|
|
const FSSpec * srcSpec,
|
|
const FSSpec * dstSpec);
|
|
|
|
|
|
/*
|
|
The FSpDTCopyComment function copies the desktop database comment from
|
|
the source to the destination object. Both the source and the
|
|
destination volumes must support the Desktop Manager.
|
|
|
|
srcSpec input: An FSSpec record specifying the source object.
|
|
dstSpec input: An FSSpec record specifying the destination object.
|
|
|
|
Result Codes
|
|
noErr 0 No error
|
|
nsvErr -35 Volume not found
|
|
ioErr -36 I/O error
|
|
fnfErr Ð43 File or directory doesnÕt exist
|
|
wPrErr Ð44 Volume is locked through hardware
|
|
vLckdErr Ð46 Volume is locked through software
|
|
paramErr -50 Volume doesn't support this function
|
|
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
|
|
afpItemNotFound -5012 Information not found
|
|
|
|
__________
|
|
|
|
Also see: DTCopyComment, DTSetComment, FSpDTSetComment, DTGetComment,
|
|
FSpDTGetComment
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
|
|
#include "OptimizationEnd.h"
|
|
|
|
#if PRAGMA_STRUCT_ALIGN
|
|
#pragma options align=reset
|
|
#elif PRAGMA_STRUCT_PACKPUSH
|
|
#pragma pack(pop)
|
|
#elif PRAGMA_STRUCT_PACK
|
|
#pragma pack()
|
|
#endif
|
|
|
|
#ifdef PRAGMA_IMPORT_OFF
|
|
#pragma import off
|
|
#elif PRAGMA_IMPORT
|
|
#pragma import reset
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __MOREDESKTOPMGR__ */
|
|
|