< Previous PageNext Page > Hide TOC

Deprecated Component Manager Functions

A function identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in Mac OS X v10.5

ComponentFunctionImplemented

Allows your application to determine whether a component supports a specified request. (Deprecated in Mac OS X v10.5.)

ComponentResult ComponentFunctionImplemented (
   ComponentInstance ci,
   SInt16 ftnNumber
);

Parameters
ci

The component instance of which you wish to make a request. Your application obtains the component instance from the OpenDefaultComponent function or the OpenComponent function. You can use a component identifier here, but you must coerce the data type appropriately.

ftnNumber

A request code value. See the documentation supplied with the component for request code values.

Return Value

Indicates whether the component supports the specified request. You can interpret this number as if it were a Boolean value. If the returned value is TRUE, the component supports the specified request. If the returned value is FALSE, the component does not support the request. Your application can use this function to determine a component’s capabilities.

Availability
Declared In
Components.h

ComponentSetTarget

Calls a component’s target request function and informs a component that it has been targeted by another component. (Deprecated in Mac OS X v10.5.)

ComponentResult ComponentSetTarget (
   ComponentInstance ci,
   ComponentInstance target
);

Parameters
ci

The component instance to which to send a target request (the component that has been targeted). You can use a component identifier here, but you must coerce the data type appropriately.

target

The component instance issuing the target request.

Return Value

The value that the targeted component instance returns in response to the target request, or badComponentSelector if the targeted component does not support the target request.

Discussion

Your component can target a component instance without capturing the component or your component can first capture the component and then target a specific instance of the component.

You should not target a component instance if the component does not support the target request. Before calling this function, you should issue a can do request to the component instance you want to target to verify that the component supports the target request. After receiving a target request, the targeted component instance should call the component instance that targeted it whenever the targeted component instance would normally call one of its defined functions.

Availability
Declared In
Components.h

GetComponentVersion

Returns the version number of a component to your application. (Deprecated in Mac OS X v10.5.)

ComponentResult GetComponentVersion (
   ComponentInstance ci
);

Parameters
ci

The component instance from which you want to retrieve version information. Your application obtains the component instance from the OpenDefaultComponent function or the OpenComponent function.

Return Value

The version number of the component you specify. The high-order 16 bits represent the major version, and the low-order 16 bits represent the minor version. The major version specifies the component specification level the minor version specifies a particular implementation’s version number.

Availability
Declared In
Components.h

RegisterComponentFile

(Deprecated in Mac OS X v10.5.)

OSErr RegisterComponentFile (
   const FSSpec *spec,
   short global
);

Parameters
spec
Return Value

A result code. See “Component Manager Result Codes.”

Availability
Declared In
Components.h

RegisterComponentFileEntries

(Deprecated in Mac OS X v10.5.)

OSErr RegisterComponentFileEntries (
   const FSSpec *spec,
   short global,
   const ComponentDescription *toRegister,
   UInt32 registerCount
);

Parameters
spec
toRegister
registerCount
Return Value

A result code. See “Component Manager Result Codes.”

Availability
Declared In
Components.h

< Previous PageNext Page > Hide TOC


© 2001, 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-07-17)


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.