Interfaces to Find by Content Plugins that scan files. More...

#include <ConditionalMacros.h>
#include <MacTypes.h>
#include <MixedMode.h>
#include <MacErrors.h>

Data Structures
struct	IAPluginInitBlock

struct	IADocAccessorRecord

Macros
#define	NewIAAllocUPP(userRoutine)

#define	NewIAFreeUPP(userRoutine)

#define	NewIAIdleUPP(userRoutine)

#define	DisposeIAAllocUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIAFreeUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIAIdleUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokeIAAllocUPP(inSize, userUPP) (void *)CALL_ONE_PARAMETER_UPP((userUPP), uppIAAllocProcInfo, (inSize))

#define	InvokeIAFreeUPP(inObject, userUPP) CALL_ONE_PARAMETER_UPP((userUPP), uppIAFreeProcInfo, (inObject))

#define	InvokeIAIdleUPP(userUPP) (UInt8) CALL_ZERO_PARAMETER_UPP((userUPP), uppIAIdleProcInfo)

#define	NewIAAllocProc(userRoutine) NewIAAllocUPP(userRoutine)

#define	NewIAFreeProc(userRoutine) NewIAFreeUPP(userRoutine)

#define	NewIAIdleProc(userRoutine) NewIAIdleUPP(userRoutine)

#define	CallIAAllocProc(userRoutine, inSize) InvokeIAAllocUPP(inSize, userRoutine)

#define	CallIAFreeProc(userRoutine, inObject) InvokeIAFreeUPP(inObject, userRoutine)

#define	CallIAIdleProc(userRoutine) InvokeIAIdleUPP(userRoutine)

#define	NewIADocAccessorOpenUPP(userRoutine)

#define	NewIADocAccessorCloseUPP(userRoutine)

#define	NewIADocAccessorReadUPP(userRoutine)

#define	NewIASetDocAccessorReadPositionUPP(userRoutine)

#define	NewIAGetDocAccessorReadPositionUPP(userRoutine)

#define	NewIAGetDocAccessorEOFUPP(userRoutine)

#define	DisposeIADocAccessorOpenUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIADocAccessorCloseUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIADocAccessorReadUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIASetDocAccessorReadPositionUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIAGetDocAccessorReadPositionUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeIAGetDocAccessorEOFUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokeIADocAccessorOpenUPP(inAccessor, userUPP)

#define	InvokeIADocAccessorCloseUPP(inAccessor, userUPP)

#define	InvokeIADocAccessorReadUPP(inAccessor, buffer, ioSize, userUPP)

#define	InvokeIASetDocAccessorReadPositionUPP(inAccessor, inMode, inOffset, userUPP)

#define	InvokeIAGetDocAccessorReadPositionUPP(inAccessor, outPostion, userUPP)

#define	InvokeIAGetDocAccessorEOFUPP(inAccessor, outEOF, userUPP)

#define	NewIADocAccessorOpenProc(userRoutine) NewIADocAccessorOpenUPP(userRoutine)

#define	NewIADocAccessorCloseProc(userRoutine) NewIADocAccessorCloseUPP(userRoutine)

#define	NewIADocAccessorReadProc(userRoutine) NewIADocAccessorReadUPP(userRoutine)

#define	NewIASetDocAccessorReadPositionProc(userRoutine) NewIASetDocAccessorReadPositionUPP(userRoutine)

#define	NewIAGetDocAccessorReadPositionProc(userRoutine) NewIAGetDocAccessorReadPositionUPP(userRoutine)

#define	NewIAGetDocAccessorEOFProc(userRoutine) NewIAGetDocAccessorEOFUPP(userRoutine)

#define	CallIADocAccessorOpenProc(userRoutine, inAccessor) InvokeIADocAccessorOpenUPP(inAccessor, userRoutine)

#define	CallIADocAccessorCloseProc(userRoutine, inAccessor) InvokeIADocAccessorCloseUPP(inAccessor, userRoutine)

#define	CallIADocAccessorReadProc(userRoutine, inAccessor, buffer, ioSize) InvokeIADocAccessorReadUPP(inAccessor, buffer, ioSize, userRoutine)

#define	CallIASetDocAccessorReadPositionProc(userRoutine, inAccessor, inMode, inOffset)

#define	CallIAGetDocAccessorReadPositionProc(userRoutine, inAccessor, outPostion) InvokeIAGetDocAccessorReadPositionUPP(inAccessor, outPostion, userRoutine)

#define	CallIAGetDocAccessorEOFProc(userRoutine, inAccessor, outEOF) InvokeIAGetDocAccessorEOFUPP(inAccessor, outEOF, userRoutine)

#define	BUILDING_IAEXTRACTOR 1

Typedefs
typedef OSStatus	IAResult

typedef struct OpaqueIAPluginRef *	IAPluginRef

typedef struct OpaqueIADocAccessorRef *	IADocAccessorRef

typedef struct OpaqueIADocRef *	IADocRef

typedef struct IAPluginInitBlock	IAPluginInitBlock

typedef IAPluginInitBlock *	IAPluginInitBlockPtr

typedef void *	buffer

typedef void UInt32 *	ioSize

typedef SInt32	inMode

typedef SInt32 SInt32	inOffset

typedef SInt32 *	outPostion

typedef SInt32 *	outEOF

typedef struct IADocAccessorRecord	IADocAccessorRecord

typedef IADocAccessorRecord *	IADocAccessorPtr

Enumerations
enum	{ kIAFromStartMode = 0 , kIAFromCurrMode = 1 , kIAFromEndMode = 2 }

enum	{ kIAExtractorVersion1 = 0x00010001 , kIAExtractorCurrentVersion = kIAExtractorVersion1 }

enum	{ uppIAAllocProcInfo = 0x000000F1 }

enum	{ uppIAFreeProcInfo = 0x000000C1 }

enum	{ uppIAIdleProcInfo = 0x00000011 }

enum	{ uppIADocAccessorOpenProcInfo = 0x000000F1 }

enum	{ uppIADocAccessorCloseProcInfo = 0x000000F1 }

enum	{ uppIADocAccessorReadProcInfo = 0x00000FF1 }

enum	{ uppIASetDocAccessorReadPositionProcInfo = 0x00000FF1 }

enum	{ uppIAGetDocAccessorReadPositionProcInfo = 0x000003F1 }

enum	{ uppIAGetDocAccessorEOFProcInfo = 0x000003F1 }

Functions
typedef	CALLBACK_API_C (void *, IAAllocProcPtr)(UInt32 inSize)

typedef	CALLBACK_API_C (void, IAFreeProcPtr)(void *inObject)

typedef	CALLBACK_API_C (UInt8, IAIdleProcPtr)(void)

typedef	STACK_UPP_TYPE (IAAllocProcPtr) IAAllocUPP

typedef	STACK_UPP_TYPE (IAFreeProcPtr) IAFreeUPP

typedef	STACK_UPP_TYPE (IAIdleProcPtr) IAIdleUPP

IAAllocUPP	NewIAAllocUPP (IAAllocProcPtr userRoutine)

IAFreeUPP	NewIAFreeUPP (IAFreeProcPtr userRoutine)

IAIdleUPP	NewIAIdleUPP (IAIdleProcPtr userRoutine)

void	DisposeIAAllocUPP (IAAllocUPP userUPP)

void	DisposeIAFreeUPP (IAFreeUPP userUPP)

void	DisposeIAIdleUPP (IAIdleUPP userUPP)

void *	InvokeIAAllocUPP (UInt32 inSize, IAAllocUPP userUPP)

void	InvokeIAFreeUPP (void *inObject, IAFreeUPP userUPP)

UInt8	InvokeIAIdleUPP (IAIdleUPP userUPP)

typedef	CALLBACK_API_C (OSStatus, IADocAccessorOpenProcPtr)(IADocAccessorRef inAccessor)

typedef	CALLBACK_API_C (OSStatus, IADocAccessorCloseProcPtr)(IADocAccessorRef inAccessor)

typedef	CALLBACK_API_C (OSStatus, IADocAccessorReadProcPtr)(IADocAccessorRef inAccessor

typedef	CALLBACK_API_C (OSStatus, IASetDocAccessorReadPositionProcPtr)(IADocAccessorRef inAccessor

typedef	CALLBACK_API_C (OSStatus, IAGetDocAccessorReadPositionProcPtr)(IADocAccessorRef inAccessor

typedef	CALLBACK_API_C (OSStatus, IAGetDocAccessorEOFProcPtr)(IADocAccessorRef inAccessor

typedef	STACK_UPP_TYPE (IADocAccessorOpenProcPtr) IADocAccessorOpenUPP

typedef	STACK_UPP_TYPE (IADocAccessorCloseProcPtr) IADocAccessorCloseUPP

typedef	STACK_UPP_TYPE (IADocAccessorReadProcPtr) IADocAccessorReadUPP

typedef	STACK_UPP_TYPE (IASetDocAccessorReadPositionProcPtr) IASetDocAccessorReadPositionUPP

typedef	STACK_UPP_TYPE (IAGetDocAccessorReadPositionProcPtr) IAGetDocAccessorReadPositionUPP

typedef	STACK_UPP_TYPE (IAGetDocAccessorEOFProcPtr) IAGetDocAccessorEOFUPP

IADocAccessorOpenUPP	NewIADocAccessorOpenUPP (IADocAccessorOpenProcPtr userRoutine)

IADocAccessorCloseUPP	NewIADocAccessorCloseUPP (IADocAccessorCloseProcPtr userRoutine)

IADocAccessorReadUPP	NewIADocAccessorReadUPP (IADocAccessorReadProcPtr userRoutine)

IASetDocAccessorReadPositionUPP	NewIASetDocAccessorReadPositionUPP (IASetDocAccessorReadPositionProcPtr userRoutine)

IAGetDocAccessorReadPositionUPP	NewIAGetDocAccessorReadPositionUPP (IAGetDocAccessorReadPositionProcPtr userRoutine)

IAGetDocAccessorEOFUPP	NewIAGetDocAccessorEOFUPP (IAGetDocAccessorEOFProcPtr userRoutine)

void	DisposeIADocAccessorOpenUPP (IADocAccessorOpenUPP userUPP)

void	DisposeIADocAccessorCloseUPP (IADocAccessorCloseUPP userUPP)

void	DisposeIADocAccessorReadUPP (IADocAccessorReadUPP userUPP)

void	DisposeIASetDocAccessorReadPositionUPP (IASetDocAccessorReadPositionUPP userUPP)

void	DisposeIAGetDocAccessorReadPositionUPP (IAGetDocAccessorReadPositionUPP userUPP)

void	DisposeIAGetDocAccessorEOFUPP (IAGetDocAccessorEOFUPP userUPP)

OSStatus	InvokeIADocAccessorOpenUPP (IADocAccessorRef inAccessor, IADocAccessorOpenUPP userUPP)

OSStatus	InvokeIADocAccessorCloseUPP (IADocAccessorRef inAccessor, IADocAccessorCloseUPP userUPP)

OSStatus	InvokeIADocAccessorReadUPP (IADocAccessorRef inAccessor, void buffer, UInt32 ioSize, IADocAccessorReadUPP userUPP)

OSStatus	InvokeIASetDocAccessorReadPositionUPP (IADocAccessorRef inAccessor, SInt32 inMode, SInt32 inOffset, IASetDocAccessorReadPositionUPP userUPP)

OSStatus	InvokeIAGetDocAccessorReadPositionUPP (IADocAccessorRef inAccessor, SInt32 *outPostion, IAGetDocAccessorReadPositionUPP userUPP)

OSStatus	InvokeIAGetDocAccessorEOFUPP (IADocAccessorRef inAccessor, SInt32 *outEOF, IAGetDocAccessorEOFUPP userUPP)

OSStatus	IAPluginInit (IAPluginInitBlockPtr initBlock, IAPluginRef *outPluginRef)

OSStatus	IAPluginTerm (IAPluginRef inPluginRef)

OSStatus	IAGetExtractorVersion (IAPluginRef inPluginRef, UInt32 *outPluginVersion)

OSStatus	IACountSupportedDocTypes (IAPluginRef inPluginRef, UInt32 *outCount)

OSStatus	IAGetIndSupportedDocType (IAPluginRef inPluginRef, UInt32 inIndex, char **outMIMEType)

OSStatus	IAOpenDocument (IAPluginRef inPluginRef, IADocAccessorRecord inDoc, IADocRef outDoc)

OSStatus	IACloseDocument (IADocRef inDoc)

OSStatus	IAGetNextTextRun (IADocRef inDoc, void buffer, UInt32 ioSize)

OSStatus	IAGetTextRunInfo (IADocRef inDoc, char outEncoding, char outLanguage)

Detailed Description

Interfaces to Find by Content Plugins that scan files.

Introduced In: Mac OS 8.6

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1999-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/

Macro Definition Documentation

◆ BUILDING_IAEXTRACTOR

#define BUILDING_IAEXTRACTOR 1

If building a text extractor, define BUILDING_IAEXTRACTOR to 1 to export the following functions. If building a client of text extractor plug-ins, define BUILDING_IAEXTRACTOR to false so the following methods are not exported.

◆ CallIASetDocAccessorReadPositionProc

#define CallIASetDocAccessorReadPositionProc	(	userRoutine,
		inAccessor,
		inMode,
		inOffset
	)

Value:

InvokeIASetDocAccessorReadPositionUPP(inAccessor, inMode, inOffset, \

userRoutine)

InvokeIASetDocAccessorReadPositionUPP

OSStatus InvokeIASetDocAccessorReadPositionUPP(IADocAccessorRef inAccessor, SInt32 inMode, SInt32 inOffset, IASetDocAccessorReadPositionUPP userUPP)

◆ InvokeIADocAccessorCloseUPP

#define InvokeIADocAccessorCloseUPP	(	inAccessor,
		userUPP
	)

Value:

(OSStatus) CALL_ONE_PARAMETER_UPP((userUPP), uppIADocAccessorCloseProcInfo, \

(inAccessor))

◆ InvokeIADocAccessorOpenUPP

#define InvokeIADocAccessorOpenUPP	(	inAccessor,
		userUPP
	)

Value:

(OSStatus) CALL_ONE_PARAMETER_UPP((userUPP), uppIADocAccessorOpenProcInfo, \

(inAccessor))

◆ InvokeIADocAccessorReadUPP

#define InvokeIADocAccessorReadUPP	(	inAccessor,
		buffer,
		ioSize,
		userUPP
	)

Value:

(OSStatus) CALL_THREE_PARAMETER_UPP((userUPP), uppIADocAccessorReadProcInfo, \

(inAccessor), (buffer), (ioSize))

◆ InvokeIAGetDocAccessorEOFUPP

#define InvokeIAGetDocAccessorEOFUPP	(	inAccessor,
		outEOF,
		userUPP
	)

Value:

(OSStatus) CALL_TWO_PARAMETER_UPP((userUPP), uppIAGetDocAccessorEOFProcInfo, \

(inAccessor), (outEOF))

◆ InvokeIAGetDocAccessorReadPositionUPP

#define InvokeIAGetDocAccessorReadPositionUPP	(	inAccessor,
		outPostion,
		userUPP
	)

Value:

  (OSStatus) CALL_TWO_PARAMETER_UPP((userUPP),                                 \
                                    uppIAGetDocAccessorReadPositionProcInfo,   \
                                    (inAccessor), (outPostion))

◆ InvokeIASetDocAccessorReadPositionUPP

#define InvokeIASetDocAccessorReadPositionUPP	(	inAccessor,
		inMode,
		inOffset,
		userUPP
	)

Value:

  (OSStatus) CALL_THREE_PARAMETER_UPP((userUPP),                               \
                                      uppIASetDocAccessorReadPositionProcInfo, \
                                      (inAccessor), (inMode), (inOffset))

◆ NewIAAllocUPP

#define NewIAAllocUPP ( userRoutine )

Value:

(IAAllocUPP) NewRoutineDescriptor( \

(ProcPtr)(userRoutine), uppIAAllocProcInfo, GetCurrentArchitecture())

NewRoutineDescriptor

UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

◆ NewIADocAccessorCloseUPP

#define NewIADocAccessorCloseUPP ( userRoutine )

Value:

  (IADocAccessorCloseUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),        \
                                               uppIADocAccessorCloseProcInfo, \
                                               GetCurrentArchitecture())

◆ NewIADocAccessorOpenUPP

#define NewIADocAccessorOpenUPP ( userRoutine )

Value:

  (IADocAccessorOpenUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),       \
                                              uppIADocAccessorOpenProcInfo, \
                                              GetCurrentArchitecture())

◆ NewIADocAccessorReadUPP

#define NewIADocAccessorReadUPP ( userRoutine )

Value:

  (IADocAccessorReadUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),       \
                                              uppIADocAccessorReadProcInfo, \
                                              GetCurrentArchitecture())

◆ NewIAFreeUPP

#define NewIAFreeUPP ( userRoutine )

Value:

(IAFreeUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppIAFreeProcInfo, \

GetCurrentArchitecture())

◆ NewIAGetDocAccessorEOFUPP

#define NewIAGetDocAccessorEOFUPP ( userRoutine )

Value:

  (IAGetDocAccessorEOFUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppIAGetDocAccessorEOFProcInfo, \
      GetCurrentArchitecture())

◆ NewIAGetDocAccessorReadPositionUPP

#define NewIAGetDocAccessorReadPositionUPP ( userRoutine )

Value:

  (IAGetDocAccessorReadPositionUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppIAGetDocAccessorReadPositionProcInfo, \
      GetCurrentArchitecture())

◆ NewIAIdleUPP

#define NewIAIdleUPP ( userRoutine )

Value:

(IAIdleUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppIAIdleProcInfo, \

GetCurrentArchitecture())

◆ NewIASetDocAccessorReadPositionUPP

#define NewIASetDocAccessorReadPositionUPP ( userRoutine )

Value:

  (IASetDocAccessorReadPositionUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppIASetDocAccessorReadPositionProcInfo, \
      GetCurrentArchitecture())

Function Documentation

◆ DisposeIAAllocUPP()

void DisposeIAAllocUPP ( IAAllocUPP userUPP )

DisposeIAAllocUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIADocAccessorCloseUPP()

void DisposeIADocAccessorCloseUPP ( IADocAccessorCloseUPP userUPP )

DisposeIADocAccessorCloseUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIADocAccessorOpenUPP()

void DisposeIADocAccessorOpenUPP ( IADocAccessorOpenUPP userUPP )

DisposeIADocAccessorOpenUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIADocAccessorReadUPP()

void DisposeIADocAccessorReadUPP ( IADocAccessorReadUPP userUPP )

DisposeIADocAccessorReadUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIAFreeUPP()

void DisposeIAFreeUPP ( IAFreeUPP userUPP )

DisposeIAFreeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIAGetDocAccessorEOFUPP()

void DisposeIAGetDocAccessorEOFUPP ( IAGetDocAccessorEOFUPP userUPP )

DisposeIAGetDocAccessorEOFUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIAGetDocAccessorReadPositionUPP()

void DisposeIAGetDocAccessorReadPositionUPP ( IAGetDocAccessorReadPositionUPP userUPP )

DisposeIAGetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIAIdleUPP()

void DisposeIAIdleUPP ( IAIdleUPP userUPP )

DisposeIAIdleUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeIASetDocAccessorReadPositionUPP()

void DisposeIASetDocAccessorReadPositionUPP ( IASetDocAccessorReadPositionUPP userUPP )

DisposeIASetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ IACloseDocument()

OSStatus IACloseDocument ( IADocRef inDoc )

IACloseDocument - perform any cleanup for IADocRef that was returned from IAOpenDocument. IACloseDocument()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IACountSupportedDocTypes()

OSStatus IACountSupportedDocTypes	(	IAPluginRef	inPluginRef,
		UInt32 *	outCount
	)

IACountSupportedDocTypes - returns number of document types the plug-in supports IACountSupportedDocTypes()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAGetExtractorVersion()

OSStatus IAGetExtractorVersion	(	IAPluginRef	inPluginRef,
		UInt32 *	outPluginVersion
	)

IAGetExtractorVersion - returns the version of the Text Extractor interface that the plug-in was built with. IAGetExtractorVersion()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAGetIndSupportedDocType()

OSStatus IAGetIndSupportedDocType	(	IAPluginRef	inPluginRef,
		UInt32	inIndex,
		char **	outMIMEType
	)

IAGetIndSupportedDocType - returns the nth document type the plug-in supports. First item is one not zero. Returns the MIME type of supported document IAGetIndSupportedDocType()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAGetNextTextRun()

OSStatus IAGetNextTextRun	(	IADocRef	inDoc,
		void *	buffer,
		UInt32 *	ioSize
	)

IAGetNextTextRun - get next run of text. On input, ioSize is the length of buffer argument. On output, ioSize contains the number of bytes written to buffer argument IAGetNextTextRun()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAGetTextRunInfo()

OSStatus IAGetTextRunInfo	(	IADocRef	inDoc,
		char **	outEncoding,
		char **	outLanguage
	)

IAGetTextRunInfo - get information about the text returned from the last call to IAGetNextTextRun. Arguments outEncoding ane outLanguage are options an NULL can be passed in. If arguments are non-null, plug-in will return pointer to internet encoding and language of last run of text. If encoding or language are unknown, plug-in will set *outEncoding and/or *outLanguage to NULL. IAGetTextRunInfo()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAOpenDocument()

OSStatus IAOpenDocument	(	IAPluginRef	inPluginRef,
		IADocAccessorRecord *	inDoc,
		IADocRef *	outDoc
	)

IAOpenDocument - returns a reference to the text of a document. Client passes in an IADocAccessorRecord* that the plug-in can use to to access a document. Plug-in returns IADocRef which an opaque type defined by plug-in to reference the text of a document. IAOpenDocument()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAPluginInit()

OSStatus IAPluginInit	(	IAPluginInitBlockPtr	initBlock,
		IAPluginRef *	outPluginRef
	)

A Sherlock Plugin is a CFM shared library that implements the following functions: IAPluginInit - plug-in's method that is called when opened by a client. The plug-in retuns an IAPluginRef which is an opaque type defined by the plug-in and used for the current session. IAPluginInit()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ IAPluginTerm()

OSStatus IAPluginTerm ( IAPluginRef inPluginRef )

IAPluginTerm - plug-in's method that is called when closed by a client. The client passes back the IAPluginRef that was returned from IAPluginInit. At this time the plug-in can perform any needed cleanup. IAPluginTerm()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIAAllocUPP()

void* InvokeIAAllocUPP	(	UInt32	inSize,
		IAAllocUPP	userUPP
	)

InvokeIAAllocUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIADocAccessorCloseUPP()

OSStatus InvokeIADocAccessorCloseUPP	(	IADocAccessorRef	inAccessor,
		IADocAccessorCloseUPP	userUPP
	)

InvokeIADocAccessorCloseUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIADocAccessorOpenUPP()

OSStatus InvokeIADocAccessorOpenUPP	(	IADocAccessorRef	inAccessor,
		IADocAccessorOpenUPP	userUPP
	)

InvokeIADocAccessorOpenUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIADocAccessorReadUPP()

OSStatus InvokeIADocAccessorReadUPP	(	IADocAccessorRef	inAccessor,
		void *	buffer,
		UInt32 *	ioSize,
		IADocAccessorReadUPP	userUPP
	)

InvokeIADocAccessorReadUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIAFreeUPP()

void InvokeIAFreeUPP	(	void *	inObject,
		IAFreeUPP	userUPP
	)

InvokeIAFreeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIAGetDocAccessorEOFUPP()

OSStatus InvokeIAGetDocAccessorEOFUPP	(	IADocAccessorRef	inAccessor,
		SInt32 *	outEOF,
		IAGetDocAccessorEOFUPP	userUPP
	)

InvokeIAGetDocAccessorEOFUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIAGetDocAccessorReadPositionUPP()

OSStatus InvokeIAGetDocAccessorReadPositionUPP	(	IADocAccessorRef	inAccessor,
		SInt32 *	outPostion,
		IAGetDocAccessorReadPositionUPP	userUPP
	)

InvokeIAGetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIAIdleUPP()

UInt8 InvokeIAIdleUPP ( IAIdleUPP userUPP )

InvokeIAIdleUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeIASetDocAccessorReadPositionUPP()

OSStatus InvokeIASetDocAccessorReadPositionUPP	(	IADocAccessorRef	inAccessor,
		SInt32	inMode,
		SInt32	inOffset,
		IASetDocAccessorReadPositionUPP	userUPP
	)

InvokeIASetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIAAllocUPP()

IAAllocUPP NewIAAllocUPP ( IAAllocProcPtr userRoutine )

NewIAAllocUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIADocAccessorCloseUPP()

IADocAccessorCloseUPP NewIADocAccessorCloseUPP ( IADocAccessorCloseProcPtr userRoutine )

NewIADocAccessorCloseUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIADocAccessorOpenUPP()

IADocAccessorOpenUPP NewIADocAccessorOpenUPP ( IADocAccessorOpenProcPtr userRoutine )

NewIADocAccessorOpenUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIADocAccessorReadUPP()

IADocAccessorReadUPP NewIADocAccessorReadUPP ( IADocAccessorReadProcPtr userRoutine )

NewIADocAccessorReadUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIAFreeUPP()

IAFreeUPP NewIAFreeUPP ( IAFreeProcPtr userRoutine )

NewIAFreeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIAGetDocAccessorEOFUPP()

IAGetDocAccessorEOFUPP NewIAGetDocAccessorEOFUPP ( IAGetDocAccessorEOFProcPtr userRoutine )

NewIAGetDocAccessorEOFUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIAGetDocAccessorReadPositionUPP()

IAGetDocAccessorReadPositionUPP NewIAGetDocAccessorReadPositionUPP ( IAGetDocAccessorReadPositionProcPtr userRoutine )

NewIAGetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIAIdleUPP()

IAIdleUPP NewIAIdleUPP ( IAIdleProcPtr userRoutine )

NewIAIdleUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewIASetDocAccessorReadPositionUPP()

IASetDocAccessorReadPositionUPP NewIASetDocAccessorReadPositionUPP ( IASetDocAccessorReadPositionProcPtr userRoutine )

NewIASetDocAccessorReadPositionUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ BUILDING_IAEXTRACTOR

◆ CallIASetDocAccessorReadPositionProc

◆ InvokeIADocAccessorCloseUPP

◆ InvokeIADocAccessorOpenUPP

◆ InvokeIADocAccessorReadUPP

◆ InvokeIAGetDocAccessorEOFUPP

◆ InvokeIAGetDocAccessorReadPositionUPP

◆ InvokeIASetDocAccessorReadPositionUPP

◆ NewIAAllocUPP

◆ NewIADocAccessorCloseUPP

◆ NewIADocAccessorOpenUPP

◆ NewIADocAccessorReadUPP

◆ NewIAFreeUPP

◆ NewIAGetDocAccessorEOFUPP

◆ NewIAGetDocAccessorReadPositionUPP

◆ NewIAIdleUPP

◆ NewIASetDocAccessorReadPositionUPP

Function Documentation

◆ DisposeIAAllocUPP()

◆ DisposeIADocAccessorCloseUPP()

◆ DisposeIADocAccessorOpenUPP()

◆ DisposeIADocAccessorReadUPP()

◆ DisposeIAFreeUPP()

◆ DisposeIAGetDocAccessorEOFUPP()

◆ DisposeIAGetDocAccessorReadPositionUPP()

◆ DisposeIAIdleUPP()

◆ DisposeIASetDocAccessorReadPositionUPP()

◆ IACloseDocument()

◆ IACountSupportedDocTypes()

◆ IAGetExtractorVersion()

◆ IAGetIndSupportedDocType()

◆ IAGetNextTextRun()

◆ IAGetTextRunInfo()

◆ IAOpenDocument()

◆ IAPluginInit()

◆ IAPluginTerm()

◆ InvokeIAAllocUPP()

◆ InvokeIADocAccessorCloseUPP()

◆ InvokeIADocAccessorOpenUPP()

◆ InvokeIADocAccessorReadUPP()

◆ InvokeIAFreeUPP()

◆ InvokeIAGetDocAccessorEOFUPP()

◆ InvokeIAGetDocAccessorReadPositionUPP()

◆ InvokeIAIdleUPP()

◆ InvokeIASetDocAccessorReadPositionUPP()

◆ NewIAAllocUPP()

◆ NewIADocAccessorCloseUPP()

◆ NewIADocAccessorOpenUPP()

◆ NewIADocAccessorReadUPP()

◆ NewIAFreeUPP()

◆ NewIAGetDocAccessorEOFUPP()

◆ NewIAGetDocAccessorReadPositionUPP()

◆ NewIAIdleUPP()

◆ NewIASetDocAccessorReadPositionUPP()