Mac OS 9
Data Structures | Typedefs | Enumerations | Functions
ICAApplication.h File Reference
Misc

General purpose Image Capture definitions. More...

#include <MacTypes.h>
#include <Files.h>
#include <CFDictionary.h>

Go to the source code of this file.

Data Structures

struct  ICAObjectInfo
 
struct  ICAPropertyInfo
 
struct  ICAMessage
 
struct  ICAThumbnail
 
struct  ICAHeader
 
struct  ICAGetChildCountPB
 
struct  ICAGetNthChildPB
 
struct  ICAGetObjectInfoPB
 
struct  ICAGetParentOfObjectPB
 
struct  ICAGetRootOfObjectPB
 
struct  ICAGetObjectRefConPB
 
struct  ICASetObjectRefConPB
 
struct  ICAGetPropertyCountPB
 
struct  ICAGetNthPropertyPB
 
struct  ICAGetPropertyByTypePB
 
struct  ICAGetPropertyInfoPB
 
struct  ICAGetPropertyDataPB
 
struct  ICASetPropertyDataPB
 
struct  ICAGetParentOfPropertyPB
 
struct  ICAGetRootOfPropertyPB
 
struct  ICAGetPropertyRefConPB
 
struct  ICASetPropertyRefConPB
 
struct  ICAGetDeviceListPB
 
struct  ICAObjectSendMessagePB
 
struct  ICARegisterEventNotificationPB
 
struct  ICADownloadFilePB
 
struct  ICACopyObjectPropertyDictionaryPB
 

Typedefs

typedef struct OpaqueICAObject * ICAObject
 
typedef struct OpaqueICAProperty * ICAProperty
 
typedef struct OpaqueICAConnectionID * ICAConnectionID
 
typedef struct ICAObjectInfo ICAObjectInfo
 
typedef struct ICAPropertyInfo ICAPropertyInfo
 
typedef struct ICAMessage ICAMessage
 
typedef struct ICAThumbnail ICAThumbnail
 
typedef struct ICAHeader ICAHeader
 
typedef struct ICAGetChildCountPB ICAGetChildCountPB
 
typedef struct ICAGetNthChildPB ICAGetNthChildPB
 
typedef struct ICAGetObjectInfoPB ICAGetObjectInfoPB
 
typedef struct ICAGetParentOfObjectPB ICAGetParentOfObjectPB
 
typedef struct ICAGetRootOfObjectPB ICAGetRootOfObjectPB
 
typedef struct ICAGetObjectRefConPB ICAGetObjectRefConPB
 
typedef struct ICASetObjectRefConPB ICASetObjectRefConPB
 
typedef struct ICAGetPropertyCountPB ICAGetPropertyCountPB
 
typedef struct ICAGetNthPropertyPB ICAGetNthPropertyPB
 
typedef struct ICAGetPropertyByTypePB ICAGetPropertyByTypePB
 
typedef struct ICAGetPropertyInfoPB ICAGetPropertyInfoPB
 
typedef struct ICAGetPropertyDataPB ICAGetPropertyDataPB
 
typedef struct ICASetPropertyDataPB ICASetPropertyDataPB
 
typedef struct ICAGetParentOfPropertyPB ICAGetParentOfPropertyPB
 
typedef struct ICAGetRootOfPropertyPB ICAGetRootOfPropertyPB
 
typedef struct ICAGetPropertyRefConPB ICAGetPropertyRefConPB
 
typedef struct ICASetPropertyRefConPB ICASetPropertyRefConPB
 
typedef struct ICAGetDeviceListPB ICAGetDeviceListPB
 
typedef struct ICAObjectSendMessagePB ICAObjectSendMessagePB
 
typedef struct ICARegisterEventNotificationPB ICARegisterEventNotificationPB
 
typedef struct ICADownloadFilePB ICADownloadFilePB
 
typedef struct ICACopyObjectPropertyDictionaryPB ICACopyObjectPropertyDictionaryPB
 

Enumerations

enum  {
  kICACommunicationErr = -9900 , kICADeviceNotFoundErr = -9901 , kICADeviceNotOpenErr = -9902 , kICAFileCorruptedErr = -9903 ,
  kICAIOPendingErr = -9904 , kICAInvalidObjectErr = -9905 , kICAInvalidPropertyErr = -9906 , kICAIndexOutOfRangeErr = -9907 ,
  kICAPropertyTypeNotFoundErr = -9908
}
 
enum  {
  kICADevice , kICADeviceCamera , kICADeviceScanner , kICADeviceMFP ,
  kICAList = FOUR_CHAR_CODE('objl') , kICADirectory = FOUR_CHAR_CODE('dire') , kICAFile = FOUR_CHAR_CODE('file') , kICAFileImage = FOUR_CHAR_CODE('imag') ,
  kICAFileMovie = FOUR_CHAR_CODE('moov') , kICAFileAudio = FOUR_CHAR_CODE('audo') , kICAFileFirmware = FOUR_CHAR_CODE('firm') , kICAFileOther = FOUR_CHAR_CODE('othe')
}
 
enum  {
  kICAProperty = FOUR_CHAR_CODE('prop') , kICAPropertyImageWidth = FOUR_CHAR_CODE('0100') , kICAPropertyImageHeight = FOUR_CHAR_CODE('0101') , kICAPropertyImageBitDepth = FOUR_CHAR_CODE('0102') ,
  kICAPropertyImageDPI = FOUR_CHAR_CODE('011A') , kICAPropertyImageExposureTime = FOUR_CHAR_CODE('829A') , kICAPropertyImageFNumber = FOUR_CHAR_CODE('829D') , kICAPropertyImageDateOriginal ,
  kICAPropertyImageDateDigitized , kICAPropertyImageShutterSpeed = FOUR_CHAR_CODE('9201') , kICAPropertyImageAperture = FOUR_CHAR_CODE('9202') , kICAPropertyImageFlash = FOUR_CHAR_CODE('9209') ,
  kICAPropertyColorSpace = FOUR_CHAR_CODE('A001') , kICAPropertyImageFilename , kICAPropertyImageSize = FOUR_CHAR_CODE('isiz') , kICAPropertyImageData = FOUR_CHAR_CODE('idat') ,
  kICAPropertyImageThumbnail = FOUR_CHAR_CODE('thum') , kICAPropertyColorSyncProfile = FOUR_CHAR_CODE('prof')
}
 
enum  { kICAMessageConnect = FOUR_CHAR_CODE('open') , kICAMessageDisconnect = FOUR_CHAR_CODE('clos') , kICAMessageReset = FOUR_CHAR_CODE('rese') , kICAMessageCheckDevice = FOUR_CHAR_CODE('chkd') }
 
enum  {
  kICATypeUInt16 = FOUR_CHAR_CODE('ui16') , kICATypeUInt32 = FOUR_CHAR_CODE('ui32') , kICATypeUInt64 = FOUR_CHAR_CODE('ui64') , kICATypeSInt16 = FOUR_CHAR_CODE('si16') ,
  kICATypeSInt32 = FOUR_CHAR_CODE('si32') , kICATypeSInt64 = FOUR_CHAR_CODE('si64') , kICATypeFixed = FOUR_CHAR_CODE('sing') , kICATypeBoolean = FOUR_CHAR_CODE('bool') ,
  kICATypeString = FOUR_CHAR_CODE('TEXT') , kICATypeData = FOUR_CHAR_CODE('data') , kICATypeThumbnail = FOUR_CHAR_CODE('thum')
}
 
enum  { kICAFlagReadWriteAccess = 1L << 0 , kICAFlagReadAccess = 1L << 1 }
 
enum  {
  kICAEventCancelTransaction = FOUR_CHAR_CODE('ecnt') , kICAEventObjectAdded = FOUR_CHAR_CODE('eoba') , kICAEventObjectRemoved = FOUR_CHAR_CODE('eobr') , kICAEventStoreAdded = FOUR_CHAR_CODE('esta') ,
  kICAEventStoreRemoved = FOUR_CHAR_CODE('estr') , kICAEventDeviceAdded = FOUR_CHAR_CODE('edea') , kICAEventDeviceRemoved = FOUR_CHAR_CODE('eder') , kICAEventDevicePropChanged = FOUR_CHAR_CODE('edpc') ,
  kICAEventObjectInfoChanged = FOUR_CHAR_CODE('eoic') , kICAEventDeviceInfoChanged = FOUR_CHAR_CODE('edic') , kICAEventRequestObjectTransfer = FOUR_CHAR_CODE('erot') , kICAEventStoreFull = FOUR_CHAR_CODE('estf') ,
  kICAEventDeviceReset = FOUR_CHAR_CODE('edvr') , kICAEventStorageInfoChanged = FOUR_CHAR_CODE('esic') , kICAEventCaptureComplete = FOUR_CHAR_CODE('ecpc') , kICAEventUnreportedStatus = FOUR_CHAR_CODE('eurs')
}
 
enum  { kICAStartAtBeginning = 0 , kICAEntireLength = -1 }
 
enum  {
  kDeleteAfterDownload = 0x00000001 , kCreateCustomIcon = 0x00000002 , kAddMetaDataToFinderComment = 0x00000004 , kAdjustCreationDate = 0x00000008 ,
  kSetFileTypeAndCreator = 0x00000010 , kEmbedColorSyncProfile = 0x00000020 , kRotateImage = 0x00000040
}
 
enum  { kICAPBVersion = 0x00010000 }
 

Functions

typedef CALLBACK_API_C (void, ICACompletion)(ICAHeader *pb)
 
OSErr ICAGetChildCount (ICAGetChildCountPB *pb, ICACompletion completion)
 
OSErr ICAGetNthChild (ICAGetNthChildPB *pb, ICACompletion completion)
 
OSErr ICAGetObjectInfo (ICAGetObjectInfoPB *pb, ICACompletion completion)
 
OSErr ICAGetParentOfObject (ICAGetParentOfObjectPB *pb, ICACompletion completion)
 
OSErr ICAGetRootOfObject (ICAGetRootOfObjectPB *pb, ICACompletion completion)
 
OSErr ICAGetObjectRefCon (ICAGetObjectRefConPB *pb, ICACompletion completion)
 
OSErr ICASetObjectRefCon (ICASetObjectRefConPB *pb, ICACompletion completion)
 
OSErr ICAGetPropertyCount (ICAGetPropertyCountPB *pb, ICACompletion completion)
 
OSErr ICAGetNthProperty (ICAGetNthPropertyPB *pb, ICACompletion completion)
 
OSErr ICAGetPropertyByType (ICAGetPropertyByTypePB *pb, ICACompletion completion)
 
OSErr ICAGetPropertyInfo (ICAGetPropertyInfoPB *pb, ICACompletion completion)
 
OSErr ICAGetPropertyData (ICAGetPropertyDataPB *pb, ICACompletion completion)
 
OSErr ICASetPropertyData (ICASetPropertyDataPB *pb, ICACompletion completion)
 
OSErr ICAGetParentOfProperty (ICAGetParentOfPropertyPB *pb, ICACompletion completion)
 
OSErr ICAGetRootOfProperty (ICAGetRootOfPropertyPB *pb, ICACompletion completion)
 
OSErr ICAGetPropertyRefCon (ICAGetPropertyRefConPB *pb, ICACompletion completion)
 
OSErr ICASetPropertyRefCon (ICASetPropertyRefConPB *pb, ICACompletion completion)
 
OSErr ICAGetDeviceList (ICAGetDeviceListPB *pb, ICACompletion completion)
 
OSErr ICAObjectSendMessage (ICAObjectSendMessagePB *pb, ICACompletion completion)
 
OSErr ICARegisterEventNotification (ICARegisterEventNotificationPB *pb, ICACompletion completion)
 
OSErr ICADownloadFile (ICADownloadFilePB *pb, ICACompletion completion)
 
OSErr ICACopyObjectPropertyDictionary (ICACopyObjectPropertyDictionaryPB *pb, ICACompletion completion)
 

Detailed Description

General purpose Image Capture definitions.

Introduced In: 1.0
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 2000-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Typedef Documentation

◆ ICAHeader

typedef struct ICAHeader ICAHeader

------------— Completion Procs ------------— NOTE: the parameter for the completion proc (ICAHeader*) has to be casted to the appropriate type e.g. (ICAGetChildCountPB*), ...

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

------------— Defines ------------— Error codes (Image Capture range = -9900...-9949)

◆ anonymous enum

anonymous enum

NOTE: vendor specific constants are UPPERCASE (exception: 'TEXT') ICAObject types and subtypes

Enumerator
kICADeviceCamera 

Also creator of device library files

kICADeviceScanner 

Also file type of device library files

kICADeviceMFP 

Also file type of device library files

kICAList 

Also file type of device library files

◆ anonymous enum

anonymous enum

ICAProperties

Enumerator
kICAPropertyImageWidth 

file properties for images, refer to 'Digital Still Camera Image File Format Standard' Exif Version 2.1 section 2.6.4. and 2.6.5.

kICAPropertyImageHeight 

UInt32

kICAPropertyImageBitDepth 

UInt32

kICAPropertyImageDPI 

UInt32

kICAPropertyImageExposureTime 

UInt32

kICAPropertyImageDateDigitized 

null terminated string (YYYYMMDDThhmmss.s)

kICAPropertyImageShutterSpeed 

null terminated string (YYYYMMDDThhmmss.s)

kICAPropertyColorSpace 

UInt16

kICAPropertyImageFilename 

UInt16

kICAPropertyImageSize 

null terminated string

kICAPropertyImageData 

UInt32

kICAPropertyImageThumbnail 

void *

kICAPropertyColorSyncProfile 

void *

◆ anonymous enum

anonymous enum

Messages

◆ anonymous enum

anonymous enum

Data type definitions, mapped to AppleEvent types

Enumerator
kICATypeUInt32 

UInt16

kICATypeUInt64 

UInt32

kICATypeSInt16 

UInt64

kICATypeSInt32 

SInt16

kICATypeSInt64 

SInt32

kICATypeFixed 

SInt64

kICATypeBoolean 

typeIEEE32BitFloatingPoint

kICATypeString 

typeBoolean

kICATypeData 

typeChar

kICATypeThumbnail 

void *

◆ anonymous enum

anonymous enum

Flags for PropertyInfo flag element

◆ anonymous enum

anonymous enum

Notification types (Refer to section 12.4 of PTP spec)

◆ anonymous enum

anonymous enum

Used for partial reads via ICAGetPropertyData

◆ anonymous enum

anonymous enum

ICADownloadFile flags

Function Documentation

◆ ICACopyObjectPropertyDictionary()

OSErr ICACopyObjectPropertyDictionary ( ICACopyObjectPropertyDictionaryPB *  pb,
ICACompletion  completion 
)

can be NULL ICACopyObjectPropertyDictionary()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.4 and later
Mac OS X: in version 10.1 and later

◆ ICADownloadFile()

OSErr ICADownloadFile ( ICADownloadFilePB *  pb,
ICACompletion  completion 
)

can be NULL

ICADownloadFile()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.4 and later
Mac OS X: in version 10.1 and later

◆ ICAGetChildCount()

OSErr ICAGetChildCount ( ICAGetChildCountPB *  pb,
ICACompletion  completion 
)

NOTE: for all APIs - pass NULL as completion parameter to make a synchronous call ------------— Object functions ------------— ICAGetChildCount()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetDeviceList()

OSErr ICAGetDeviceList ( ICAGetDeviceListPB *  pb,
ICACompletion  completion 
)

can be NULL ------------— Device functions ------------— ICAGetDeviceList()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetNthChild()

OSErr ICAGetNthChild ( ICAGetNthChildPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetNthChild()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetNthProperty()

OSErr ICAGetNthProperty ( ICAGetNthPropertyPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetNthProperty()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetObjectInfo()

OSErr ICAGetObjectInfo ( ICAGetObjectInfoPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetObjectInfo()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetObjectRefCon()

OSErr ICAGetObjectRefCon ( ICAGetObjectRefConPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetObjectRefCon()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetParentOfObject()

OSErr ICAGetParentOfObject ( ICAGetParentOfObjectPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetParentOfObject()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetParentOfProperty()

OSErr ICAGetParentOfProperty ( ICAGetParentOfPropertyPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetParentOfProperty()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetPropertyByType()

OSErr ICAGetPropertyByType ( ICAGetPropertyByTypePB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetPropertyByType()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetPropertyCount()

OSErr ICAGetPropertyCount ( ICAGetPropertyCountPB *  pb,
ICACompletion  completion 
)

can be NULL ------------— Property functions ------------— ICAGetPropertyCount()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetPropertyData()

OSErr ICAGetPropertyData ( ICAGetPropertyDataPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetPropertyData()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetPropertyInfo()

OSErr ICAGetPropertyInfo ( ICAGetPropertyInfoPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetPropertyInfo()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetPropertyRefCon()

OSErr ICAGetPropertyRefCon ( ICAGetPropertyRefConPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetPropertyRefCon()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetRootOfObject()

OSErr ICAGetRootOfObject ( ICAGetRootOfObjectPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetRootOfObject()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAGetRootOfProperty()

OSErr ICAGetRootOfProperty ( ICAGetRootOfPropertyPB *  pb,
ICACompletion  completion 
)

can be NULL ICAGetRootOfProperty()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICAObjectSendMessage()

OSErr ICAObjectSendMessage ( ICAObjectSendMessagePB *  pb,
ICACompletion  completion 
)

can be NULL ICAObjectSendMessage()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICARegisterEventNotification()

OSErr ICARegisterEventNotification ( ICARegisterEventNotificationPB *  pb,
ICACompletion  completion 
)

can be NULL ICARegisterEventNotification()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICASetObjectRefCon()

OSErr ICASetObjectRefCon ( ICASetObjectRefConPB *  pb,
ICACompletion  completion 
)

can be NULL ICASetObjectRefCon()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICASetPropertyData()

OSErr ICASetPropertyData ( ICASetPropertyDataPB *  pb,
ICACompletion  completion 
)

can be NULL ICASetPropertyData()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ ICASetPropertyRefCon()

OSErr ICASetPropertyRefCon ( ICASetPropertyRefConPB *  pb,
ICACompletion  completion 
)

can be NULL ICASetPropertyRefCon()

Non-Carbon CFM: in ImageCaptureLib 1.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later