Mac OS 9
Data Structures | Macros | Typedefs | Enumerations | Functions
Components.h File Reference
Managers

Component Manager Interfaces. More...

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

Go to the source code of this file.

Data Structures

struct  ComponentDescription
 
struct  ResourceSpec
 
struct  ComponentResource
 
struct  ComponentPlatformInfo
 
struct  ComponentResourceExtension
 
struct  ComponentPlatformInfoArray
 
struct  ExtComponentResource
 
struct  ComponentAliasResource
 
struct  ComponentParameters
 
struct  ComponentRecord
 
struct  ComponentInstanceRecord
 
struct  RegisteredComponentRecord
 
struct  RegisteredComponentInstanceRecord
 
struct  ComponentMPWorkFunctionHeaderRecord
 

Macros

#define NewComponentFunctionUPP(userRoutine, procInfo)
 
#define DisposeComponentFunctionUPP(userUPP)   (DisposeRoutineDescriptor(userUPP))
 
#define ComponentCallNow(callNumber, paramSize)   );
 
#define CallComponentFunctionWithStorageProcInfo(storage, params, func, funcProcInfo)    CallComponentFunctionWithStorage(storage, params, func)
 
#define NewComponentMPWorkFunctionUPP(userRoutine)
 
#define NewComponentRoutineUPP(userRoutine)
 
#define NewGetMissingComponentResourceUPP(userRoutine)
 
#define DisposeComponentMPWorkFunctionUPP(userUPP)    DisposeRoutineDescriptor(userUPP)
 
#define DisposeComponentRoutineUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeGetMissingComponentResourceUPP(userUPP)    DisposeRoutineDescriptor(userUPP)
 
#define InvokeComponentMPWorkFunctionUPP(globalRefCon, header, userUPP)
 
#define InvokeComponentRoutineUPP(cp, componentStorage, userUPP)
 
#define InvokeGetMissingComponentResourceUPP(c, resType, resID, refCon, resource, userUPP)
 
#define NewComponentMPWorkFunctionProc(userRoutine)    NewComponentMPWorkFunctionUPP(userRoutine)
 
#define NewComponentRoutineProc(userRoutine)   NewComponentRoutineUPP(userRoutine)
 
#define NewGetMissingComponentResourceProc(userRoutine)    NewGetMissingComponentResourceUPP(userRoutine)
 
#define CallComponentMPWorkFunctionProc(userRoutine, globalRefCon, header)    InvokeComponentMPWorkFunctionUPP(globalRefCon, header, userRoutine)
 
#define CallComponentRoutineProc(userRoutine, cp, componentStorage)    InvokeComponentRoutineUPP(cp, componentStorage, userRoutine)
 
#define CallGetMissingComponentResourceProc(userRoutine, c, resType, resID, refCon, resource)
 

Typedefs

typedef struct ComponentDescription ComponentDescription
 
typedef struct ResourceSpec ResourceSpec
 
typedef struct ComponentResource ComponentResource
 
typedef ComponentResource * ComponentResourcePtr
 
typedef ComponentResourcePtr * ComponentResourceHandle
 
typedef struct ComponentPlatformInfo ComponentPlatformInfo
 
typedef struct ComponentResourceExtension ComponentResourceExtension
 
typedef struct ComponentPlatformInfoArray ComponentPlatformInfoArray
 
typedef struct ExtComponentResource ExtComponentResource
 
typedef ExtComponentResource * ExtComponentResourcePtr
 
typedef ExtComponentResourcePtr * ExtComponentResourceHandle
 
typedef struct ComponentAliasResource ComponentAliasResource
 
typedef struct ComponentParameters ComponentParameters
 
typedef struct ComponentRecord ComponentRecord
 
typedef ComponentRecord * Component
 
typedef struct ComponentInstanceRecord ComponentInstanceRecord
 
typedef ComponentInstanceRecord * ComponentInstance
 
typedef struct RegisteredComponentRecord RegisteredComponentRecord
 
typedef RegisteredComponentRecord * RegisteredComponentRecordPtr
 
typedef struct RegisteredComponentInstanceRecord RegisteredComponentInstanceRecord
 
typedef RegisteredComponentInstanceRecord * RegisteredComponentInstanceRecordPtr
 
typedef long ComponentResult
 
typedef struct ComponentMPWorkFunctionHeaderRecord ComponentMPWorkFunctionHeaderRecord
 
typedef ComponentMPWorkFunctionHeaderRecord * ComponentMPWorkFunctionHeaderRecordPtr
 
typedef ComponentMPWorkFunctionHeaderRecordPtr header
 
typedef Handle componentStorage
 
typedef OSType resType
 
typedef OSType short resID
 
typedef OSType short void * refCon
 
typedef OSType short void Handle * resource
 
typedef UniversalProcPtr ComponentFunctionUPP
 

Enumerations

enum  { kAppleManufacturer = FOUR_CHAR_CODE('appl') , kComponentResourceType , kComponentAliasResourceType }
 
enum  { kAnyComponentType = 0 , kAnyComponentSubType = 0 , kAnyComponentManufacturer = 0 , kAnyComponentFlagsMask = 0 }
 
enum  { cmpIsMissing = 1L << 29 , cmpWantsRegisterMessage = 1L << 31 }
 
enum  {
  kComponentOpenSelect = -1 , kComponentCloseSelect = -2 , kComponentCanDoSelect = -3 , kComponentVersionSelect = -4 ,
  kComponentRegisterSelect = -5 , kComponentTargetSelect = -6 , kComponentUnregisterSelect = -7 , kComponentGetMPWorkFunctionSelect = -8 ,
  kComponentExecuteWiredActionSelect , kComponentGetPublicResourceSelect
}
 
enum  {
  componentDoAutoVersion = (1 << 0) , componentWantsUnregister = (1 << 1) , componentAutoVersionIncludeFlags = (1 << 2) , componentHasMultiplePlatforms = (1 << 3) ,
  componentLoadResident = (1 << 4)
}
 
enum  {
  defaultComponentIdentical = 0 , defaultComponentAnyFlags = 1 , defaultComponentAnyManufacturer = 2 , defaultComponentAnySubType = 4 ,
  defaultComponentAnyFlagsAnyManufacturer , defaultComponentAnyFlagsAnyManufacturerAnySubType
}
 
enum  { registerComponentGlobal = 1 , registerComponentNoDuplicates = 2 , registerComponentAfterExisting = 4 , registerComponentAliasesOnly = 8 }
 
enum  {
  platform68k = 1 , platformPowerPC , platformInterpreted = 3 , platformWin32 = 4 ,
  platformPowerPCNativeEntryPoint = 5
}
 
enum  {
  mpWorkFlagDoWork = (1 << 0) , mpWorkFlagDoCompletion = (1 << 1) , mpWorkFlagCopyWorkBlock = (1 << 2) , mpWorkFlagDontBlock = (1 << 3) ,
  mpWorkFlagGetProcessorCount = (1 << 4) , mpWorkFlagGetIsRunning = (1 << 6)
}
 
enum  { cmpAliasNoFlags = 0 , cmpAliasOnlyThisFile = 1 }
 
enum  { uppComponentMPWorkFunctionProcInfo = 0x000003F0 }
 
enum  { uppComponentRoutineProcInfo = 0x000003F0 }
 
enum  { uppGetMissingComponentResourceProcInfo = 0x0000FBE0 }
 
enum  {
  uppComponentFunctionImplementedProcInfo = 0x000002F0 , uppGetComponentVersionProcInfo = 0x000000F0 , uppComponentSetTargetProcInfo = 0x000003F0 , uppCallComponentOpenProcInfo = 0x000003F0 ,
  uppCallComponentCloseProcInfo = 0x000003F0 , uppCallComponentCanDoProcInfo = 0x000002F0 , uppCallComponentVersionProcInfo = 0x000000F0 , uppCallComponentRegisterProcInfo = 0x000000F0 ,
  uppCallComponentTargetProcInfo = 0x000003F0 , uppCallComponentUnregisterProcInfo = 0x000000F0 , uppCallComponentGetMPWorkFunctionProcInfo = 0x00000FF0 , uppCallComponentGetPublicResourceProcInfo = 0x00003BF0
}
 

Functions

typedef CALLBACK_API (ComponentResult, ComponentMPWorkFunctionProcPtr)(void *globalRefCon
 
typedef CALLBACK_API (ComponentResult, ComponentRoutineProcPtr)(ComponentParameters *cp
 
typedef CALLBACK_API (OSErr, GetMissingComponentResourceProcPtr)(Component c
 
typedef STACK_UPP_TYPE (ComponentMPWorkFunctionProcPtr) ComponentMPWorkFunctionUPP
 
typedef STACK_UPP_TYPE (ComponentRoutineProcPtr) ComponentRoutineUPP
 
typedef STACK_UPP_TYPE (GetMissingComponentResourceProcPtr) GetMissingComponentResourceUPP
 
ComponentFunctionUPP NewComponentFunctionUPP (ProcPtr userRoutine, ProcInfoType procInfo)
 
void DisposeComponentFunctionUPP (ComponentFunctionUPP userUPP)
 
Component RegisterComponentResource (ComponentResourceHandle cr, short global)
 
OSErr UnregisterComponent (Component aComponent)
 
Component FindNextComponent (Component aComponent, ComponentDescription *looking)
 
long CountComponents (ComponentDescription *looking)
 
OSErr GetComponentInfo (Component aComponent, ComponentDescription *cd, Handle componentName, Handle componentInfo, Handle componentIcon)
 
long GetComponentListModSeed (void)
 
long GetComponentTypeModSeed (OSType componentType)
 
OSErr OpenAComponent (Component aComponent, ComponentInstance *ci)
 
ComponentInstance OpenComponent (Component aComponent)
 
OSErr CloseComponent (ComponentInstance aComponentInstance)
 
OSErr GetComponentInstanceError (ComponentInstance aComponentInstance)
 
Component ResolveComponentAlias (Component aComponent)
 
OSErr GetComponentPublicResource (Component aComponent, OSType resourceType, short resourceID, Handle *theResource)
 
OSErr GetComponentPublicResourceList (OSType resourceType, short resourceID, long flags, ComponentDescription *cd, GetMissingComponentResourceUPP missingProc, void *refCon, void *atomContainerPtr)
 
OSErr GetComponentPublicIndString (Component aComponent, Str255 theString, short strListID, short index)
 
void SetComponentInstanceError (ComponentInstance aComponentInstance, OSErr theError)
 
long GetComponentRefcon (Component aComponent)
 
void SetComponentRefcon (Component aComponent, long theRefcon)
 
short OpenComponentResFile (Component aComponent)
 
OSErr OpenAComponentResFile (Component aComponent, short *resRef)
 
OSErr CloseComponentResFile (short refnum)
 
OSErr GetComponentResource (Component aComponent, OSType resType, short resID, Handle *theResource)
 
OSErr GetComponentIndString (Component aComponent, Str255 theString, short strListID, short index)
 
Handle GetComponentInstanceStorage (ComponentInstance aComponentInstance)
 
void SetComponentInstanceStorage (ComponentInstance aComponentInstance, Handle theStorage)
 
long GetComponentInstanceA5 (ComponentInstance aComponentInstance)
 
void SetComponentInstanceA5 (ComponentInstance aComponentInstance, long theA5)
 
long CountComponentInstances (Component aComponent)
 
long CallComponentFunction (ComponentParameters *params, ComponentFunctionUPP func)
 
long CallComponentFunctionWithStorage (Handle storage, ComponentParameters *params, ComponentFunctionUPP func)
 
long DelegateComponentCall (ComponentParameters *originalParams, ComponentInstance ci)
 
OSErr SetDefaultComponent (Component aComponent, short flags)
 
ComponentInstance OpenDefaultComponent (OSType componentType, OSType componentSubType)
 
OSErr OpenADefaultComponent (OSType componentType, OSType componentSubType, ComponentInstance *ci)
 
Component CaptureComponent (Component capturedComponent, Component capturingComponent)
 
OSErr UncaptureComponent (Component aComponent)
 
long RegisterComponentResourceFile (short resRefNum, short global)
 
OSErr GetComponentIconSuite (Component aComponent, Handle *iconSuite)
 
long ComponentFunctionImplemented (ComponentInstance ci, short ftnNumber)
 
long GetComponentVersion (ComponentInstance ci)
 
long ComponentSetTarget (ComponentInstance ci, ComponentInstance target)
 
ComponentResult CallComponentOpen (ComponentInstance ci, ComponentInstance self)
 
ComponentResult CallComponentClose (ComponentInstance ci, ComponentInstance self)
 
ComponentResult CallComponentCanDo (ComponentInstance ci, short ftnNumber)
 
ComponentResult CallComponentVersion (ComponentInstance ci)
 
ComponentResult CallComponentRegister (ComponentInstance ci)
 
ComponentResult CallComponentTarget (ComponentInstance ci, ComponentInstance target)
 
ComponentResult CallComponentUnregister (ComponentInstance ci)
 
ComponentResult CallComponentGetMPWorkFunction (ComponentInstance ci, ComponentMPWorkFunctionUPP *workFunction, void **refCon)
 
ComponentResult CallComponentGetPublicResource (ComponentInstance ci, OSType resourceType, short resourceID, Handle *resource)
 
ComponentResult CallComponent (ComponentInstance ci, ComponentParameters *cp)
 
ComponentResult CallComponentDispatch (ComponentParameters *cp)
 
ComponentMPWorkFunctionUPP NewComponentMPWorkFunctionUPP (ComponentMPWorkFunctionProcPtr userRoutine)
 
ComponentRoutineUPP NewComponentRoutineUPP (ComponentRoutineProcPtr userRoutine)
 
GetMissingComponentResourceUPP NewGetMissingComponentResourceUPP (GetMissingComponentResourceProcPtr userRoutine)
 
void DisposeComponentMPWorkFunctionUPP (ComponentMPWorkFunctionUPP userUPP)
 
void DisposeComponentRoutineUPP (ComponentRoutineUPP userUPP)
 
void DisposeGetMissingComponentResourceUPP (GetMissingComponentResourceUPP userUPP)
 
ComponentResult InvokeComponentMPWorkFunctionUPP (void *globalRefCon, ComponentMPWorkFunctionHeaderRecordPtr header, ComponentMPWorkFunctionUPP userUPP)
 
ComponentResult InvokeComponentRoutineUPP (ComponentParameters *cp, Handle componentStorage, ComponentRoutineUPP userUPP)
 
OSErr InvokeGetMissingComponentResourceUPP (Component c, OSType resType, short resID, void *refCon, Handle *resource, GetMissingComponentResourceUPP userUPP)
 

Detailed Description

Component Manager Interfaces.

Introduced In: QuickTime 5.0
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1991-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

◆ CallGetMissingComponentResourceProc

#define CallGetMissingComponentResourceProc (   userRoutine,
  c,
  resType,
  resID,
  refCon,
  resource 
)
Value:
InvokeGetMissingComponentResourceUPP(c, resType, resID, refCon, resource, \
userRoutine)
InvokeGetMissingComponentResourceUPP
OSErr InvokeGetMissingComponentResourceUPP(Component c, OSType resType, short resID, void *refCon, Handle *resource, GetMissingComponentResourceUPP userUPP)

◆ InvokeComponentMPWorkFunctionUPP

#define InvokeComponentMPWorkFunctionUPP (   globalRefCon,
  header,
  userUPP 
)
Value:
(ComponentResult) CALL_TWO_PARAMETER_UPP( \
(userUPP), uppComponentMPWorkFunctionProcInfo, (globalRefCon), (header))
ComponentMPWorkFunctionHeaderRecord
Definition: Components.h:266

◆ InvokeComponentRoutineUPP

#define InvokeComponentRoutineUPP (   cp,
  componentStorage,
  userUPP 
)
Value:
(ComponentResult) CALL_TWO_PARAMETER_UPP( \
(userUPP), uppComponentRoutineProcInfo, (cp), (componentStorage))

◆ InvokeGetMissingComponentResourceUPP

#define InvokeGetMissingComponentResourceUPP (   c,
  resType,
  resID,
  refCon,
  resource,
  userUPP 
)
Value:
(OSErr) CALL_FIVE_PARAMETER_UPP((userUPP), \
uppGetMissingComponentResourceProcInfo, (c), \
(resType), (resID), (refCon), (resource))

◆ NewComponentFunctionUPP

#define NewComponentFunctionUPP (   userRoutine,
  procInfo 
)
Value:
((ComponentFunctionUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), \
(ProcInfoType)procInfo, \
GetCurrentArchitecture()))
ComponentFunctionUPP
UniversalProcPtr ComponentFunctionUPP
Definition: Components.h:295
ProcInfoType
unsigned long ProcInfoType
Definition: MixedMode.h:151
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

◆ NewComponentMPWorkFunctionProc

#define NewComponentMPWorkFunctionProc (   userRoutine)     NewComponentMPWorkFunctionUPP(userRoutine)

support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewComponentMPWorkFunctionUPP

#define NewComponentMPWorkFunctionUPP (   userRoutine)
Value:
(ComponentMPWorkFunctionUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppComponentMPWorkFunctionProcInfo, \
GetCurrentArchitecture())

pascal 4_bytes Func(4_bytes, 4_bytes)

◆ NewComponentRoutineUPP

#define NewComponentRoutineUPP (   userRoutine)
Value:
(ComponentRoutineUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), \
uppComponentRoutineProcInfo, \
GetCurrentArchitecture())

pascal 4_bytes Func(4_bytes, 4_bytes)

◆ NewGetMissingComponentResourceUPP

#define NewGetMissingComponentResourceUPP (   userRoutine)
Value:
(GetMissingComponentResourceUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppGetMissingComponentResourceProcInfo, \
GetCurrentArchitecture())

pascal 2_bytes Func(4_bytes, 4_bytes, 2_bytes, 4_bytes, 4_bytes)

Typedef Documentation

◆ ComponentFunctionUPP

typedef UniversalProcPtr ComponentFunctionUPP

The parameter list for each ComponentFunction is unique. It is therefore up to users to create the appropriate procInfo for their own ComponentFunctions where necessary.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
kComponentResourceType 

Apple supplied components

kComponentAliasResourceType 

a components resource type

◆ anonymous enum

anonymous enum
Enumerator
kComponentCloseSelect 

ComponentInstance for this open

kComponentCanDoSelect 

ComponentInstance for this close

kComponentVersionSelect 

selector # being queried

kComponentRegisterSelect 

no params

kComponentTargetSelect 

no params

kComponentUnregisterSelect 

ComponentInstance for top of call chain

kComponentGetMPWorkFunctionSelect 

no params

kComponentExecuteWiredActionSelect 

some params

kComponentGetPublicResourceSelect 

QTAtomContainer actionContainer, QTAtom actionAtom, QTCustomActionTargetPtr target, QTEventRecordPtr event

◆ anonymous enum

anonymous enum

Component Resource Extension flags

◆ anonymous enum

anonymous enum

Set Default Component flags

◆ anonymous enum

anonymous enum

RegisterComponentResource flags

◆ anonymous enum

anonymous enum
Enumerator
platformPowerPC 

platform type (response from gestaltComponentPlatform)

platformInterpreted 

(when gestaltComponentPlatform is not implemented, use

platformWin32 

gestaltSysArchitecture)

◆ anonymous enum

anonymous enum

CALL_NOT_IN_CARBON ProcInfos MixedMode ProcInfo constants for component calls

Function Documentation

◆ CallComponent()

ComponentResult CallComponent ( ComponentInstance  ci,
ComponentParameters *  cp 
) 
 CallComponent is used by ComponentGlue routines to manually call a

component function. CallComponent()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentCanDo()

ComponentResult CallComponentCanDo ( ComponentInstance  ci,
short  ftnNumber 
)

CallComponentCanDo()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentClose()

ComponentResult CallComponentClose ( ComponentInstance  ci,
ComponentInstance  self 
)

CallComponentClose()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentDispatch()

ComponentResult CallComponentDispatch ( ComponentParameters *  cp)

CALL_NOT_IN_CARBON !TARGET_OS_MAC CallComponentDispatch is a CarbonLib routine that replaces CallComponent inline glue to call a component function. CallComponentDispatch()

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

◆ CallComponentFunction()

long CallComponentFunction ( ComponentParameters *  params,
ComponentFunctionUPP  func 
)

useful helper routines for convenient method dispatching CallComponentFunction()

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

◆ CallComponentFunctionWithStorage()

long CallComponentFunctionWithStorage ( Handle  storage,
ComponentParameters *  params,
ComponentFunctionUPP  func 
)

CallComponentFunctionWithStorage()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentGetMPWorkFunction()

ComponentResult CallComponentGetMPWorkFunction ( ComponentInstance  ci,
ComponentMPWorkFunctionUPP *  workFunction,
void **  refCon 
)

CallComponentGetMPWorkFunction()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentGetPublicResource()

ComponentResult CallComponentGetPublicResource ( ComponentInstance  ci,
OSType  resourceType,
short  resourceID,
Handle *  resource 
)

CallComponentGetPublicResource()

Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ CallComponentOpen()

ComponentResult CallComponentOpen ( ComponentInstance  ci,
ComponentInstance  self 
)

New style names CallComponentOpen()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentRegister()

ComponentResult CallComponentRegister ( ComponentInstance  ci)

CallComponentRegister()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentTarget()

ComponentResult CallComponentTarget ( ComponentInstance  ci,
ComponentInstance  target 
)

CallComponentTarget()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentUnregister()

ComponentResult CallComponentUnregister ( ComponentInstance  ci)

CallComponentUnregister()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CallComponentVersion()

ComponentResult CallComponentVersion ( ComponentInstance  ci)

CallComponentVersion()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CaptureComponent()

Component CaptureComponent ( Component  capturedComponent,
Component  capturingComponent 
)

CaptureComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CloseComponent()

OSErr CloseComponent ( ComponentInstance  aComponentInstance)

CloseComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CloseComponentResFile()

OSErr CloseComponentResFile ( short  refnum)

CloseComponentResFile()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ ComponentFunctionImplemented()

long ComponentFunctionImplemented ( ComponentInstance  ci,
short  ftnNumber 
)

Old style names ComponentFunctionImplemented()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ ComponentSetTarget()

long ComponentSetTarget ( ComponentInstance  ci,
ComponentInstance  target 
)

ComponentSetTarget()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CountComponentInstances()

long CountComponentInstances ( Component  aComponent)

CALL_NOT_IN_CARBON CountComponentInstances()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ CountComponents()

long CountComponents ( ComponentDescription *  looking)

CountComponents()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ DelegateComponentCall()

long DelegateComponentCall ( ComponentParameters *  originalParams,
ComponentInstance  ci 
)

TARGET_CPU_PPC && TARGET_OS_MAC DelegateComponentCall()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ DisposeComponentFunctionUPP()

void DisposeComponentFunctionUPP ( ComponentFunctionUPP  userUPP)

DisposeComponentFunctionUPP()

Discussion: For use in writing a Carbon compliant Component. It is used to dispose of a ComponentFunctionUPP created by NewComponentFunctionUPP.

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeComponentMPWorkFunctionUPP()

void DisposeComponentMPWorkFunctionUPP ( ComponentMPWorkFunctionUPP  userUPP)

DisposeComponentMPWorkFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeComponentRoutineUPP()

void DisposeComponentRoutineUPP ( ComponentRoutineUPP  userUPP)

DisposeComponentRoutineUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeGetMissingComponentResourceUPP()

void DisposeGetMissingComponentResourceUPP ( GetMissingComponentResourceUPP  userUPP)

DisposeGetMissingComponentResourceUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ FindNextComponent()

Component FindNextComponent ( Component  aComponent,
ComponentDescription *  looking 
)

FindNextComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentIconSuite()

OSErr GetComponentIconSuite ( Component  aComponent,
Handle *  iconSuite 
)

GetComponentIconSuite()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentIndString()

OSErr GetComponentIndString ( Component  aComponent,
Str255  theString,
short  strListID,
short  index 
)

GetComponentIndString()

Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentInfo()

OSErr GetComponentInfo ( Component  aComponent,
ComponentDescription *  cd,
Handle  componentName,
Handle  componentInfo,
Handle  componentIcon 
)

GetComponentInfo()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentInstanceA5()

long GetComponentInstanceA5 ( ComponentInstance  aComponentInstance)

GetComponentInstanceA5()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentInstanceError()

OSErr GetComponentInstanceError ( ComponentInstance  aComponentInstance)

GetComponentInstanceError()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentInstanceStorage()

Handle GetComponentInstanceStorage ( ComponentInstance  aComponentInstance)

GetComponentInstanceStorage()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentListModSeed()

long GetComponentListModSeed ( void  )

GetComponentListModSeed()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentPublicIndString()

OSErr GetComponentPublicIndString ( Component  aComponent,
Str255  theString,
short  strListID,
short  index 
)

GetComponentPublicIndString()

Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
Carbon Lib: in CarbonLib 1.3 and later
Mac OS X: in version 10.0 and later

◆ GetComponentPublicResource()

OSErr GetComponentPublicResource ( Component  aComponent,
OSType  resourceType,
short  resourceID,
Handle *  theResource 
)

Note: GetComponentPublicResource returns a Handle, not a resource. The caller must dispose it with DisposeHandle. GetComponentPublicResource()

Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ GetComponentPublicResourceList()

OSErr GetComponentPublicResourceList ( OSType  resourceType,
short  resourceID,
long  flags,
ComponentDescription *  cd,
GetMissingComponentResourceUPP  missingProc,
void *  refCon,
void *  atomContainerPtr 
)

GetComponentPublicResourceList()

Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ GetComponentRefcon()

long GetComponentRefcon ( Component  aComponent)

GetComponentRefcon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentResource()

OSErr GetComponentResource ( Component  aComponent,
OSType  resType,
short  resID,
Handle *  theResource 
)

Note: GetComponentResource returns a Handle, not a resource. The caller must dispose it with DisposeHandle. GetComponentResource()

Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentTypeModSeed()

long GetComponentTypeModSeed ( OSType  componentType)

GetComponentTypeModSeed()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ GetComponentVersion()

long GetComponentVersion ( ComponentInstance  ci)

GetComponentVersion()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ InvokeComponentMPWorkFunctionUPP()

ComponentResult InvokeComponentMPWorkFunctionUPP ( void *  globalRefCon,
ComponentMPWorkFunctionHeaderRecordPtr  header,
ComponentMPWorkFunctionUPP  userUPP 
)

InvokeComponentMPWorkFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ InvokeComponentRoutineUPP()

ComponentResult InvokeComponentRoutineUPP ( ComponentParameters *  cp,
Handle  componentStorage,
ComponentRoutineUPP  userUPP 
)

InvokeComponentRoutineUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ InvokeGetMissingComponentResourceUPP()

OSErr InvokeGetMissingComponentResourceUPP ( Component  c,
OSType  resType,
short  resID,
void *  refCon,
Handle *  resource,
GetMissingComponentResourceUPP  userUPP 
)

InvokeGetMissingComponentResourceUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewComponentFunctionUPP()

ComponentFunctionUPP NewComponentFunctionUPP ( ProcPtr  userRoutine,
ProcInfoType  procInfo 
)

NewComponentFunctionUPP()

Discussion: For use in writing a Carbon compliant Component. It is used to create a ComponentFunctionUPP needed to call CallComponentFunction in the Components dispatch routine.

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewComponentMPWorkFunctionUPP()

ComponentMPWorkFunctionUPP NewComponentMPWorkFunctionUPP ( ComponentMPWorkFunctionProcPtr  userRoutine)

UPP call backs NewComponentMPWorkFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewComponentRoutineUPP()

ComponentRoutineUPP NewComponentRoutineUPP ( ComponentRoutineProcPtr  userRoutine)

NewComponentRoutineUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewGetMissingComponentResourceUPP()

GetMissingComponentResourceUPP NewGetMissingComponentResourceUPP ( GetMissingComponentResourceProcPtr  userRoutine)

NewGetMissingComponentResourceUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OpenAComponent()

OSErr OpenAComponent ( Component  aComponent,
ComponentInstance *  ci 
)

OpenAComponent()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ OpenAComponentResFile()

OSErr OpenAComponentResFile ( Component  aComponent,
short *  resRef 
)

OpenAComponentResFile()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ OpenADefaultComponent()

OSErr OpenADefaultComponent ( OSType  componentType,
OSType  componentSubType,
ComponentInstance *  ci 
)

OpenADefaultComponent()

Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ OpenComponent()

ComponentInstance OpenComponent ( Component  aComponent)

OpenComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ OpenComponentResFile()

short OpenComponentResFile ( Component  aComponent)

OpenComponentResFile()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ OpenDefaultComponent()

ComponentInstance OpenDefaultComponent ( OSType  componentType,
OSType  componentSubType 
)

OpenDefaultComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ RegisterComponentResource()

Component RegisterComponentResource ( ComponentResourceHandle  cr,
short  global 
)

RegisterComponentResource()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ RegisterComponentResourceFile()

long RegisterComponentResourceFile ( short  resRefNum,
short  global 
)

RegisterComponentResourceFile()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ ResolveComponentAlias()

Component ResolveComponentAlias ( Component  aComponent)

ResolveComponentAlias()

Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ SetComponentInstanceA5()

void SetComponentInstanceA5 ( ComponentInstance  aComponentInstance,
long  theA5 
)

SetComponentInstanceA5()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available
Windows: in qtmlClient.lib 3.0 and later

◆ SetComponentInstanceError()

void SetComponentInstanceError ( ComponentInstance  aComponentInstance,
OSErr  theError 
)

SetComponentInstanceError()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ SetComponentInstanceStorage()

void SetComponentInstanceStorage ( ComponentInstance  aComponentInstance,
Handle  theStorage 
)

SetComponentInstanceStorage()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ SetComponentRefcon()

void SetComponentRefcon ( Component  aComponent,
long  theRefcon 
)

SetComponentRefcon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ SetDefaultComponent()

OSErr SetDefaultComponent ( Component  aComponent,
short  flags 
)

SetDefaultComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ UncaptureComponent()

OSErr UncaptureComponent ( Component  aComponent)

UncaptureComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later

◆ UnregisterComponent()

OSErr UnregisterComponent ( Component  aComponent)

UnregisterComponent()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later
Windows: in qtmlClient.lib 3.0 and later