Important: The information in this document is obsolete and should not be used for new development.
OSARealToGenericID
You can use theOSARealToGenericID
function to convert a component-specific script ID to the corresponding generic script ID.
FUNCTION OSARealToGenericID (genericScriptingComponent: ComponentInstance; VAR theScriptID: OSAID; theExactComponent: ComponentInstance) : OSAError;
genericScriptingComponent
- A component instance for the generic scripting component, created by a prior call to the Component Manager function
OpenDefaultComponent
orOpenComponent
(see page 10-4).theScriptID
- The component-specific script ID that you want to convert. You must have obtained this script ID from the scripting component instance passed in the
theExactComponent
parameter. TheOSARealToGenericID
function returns, in this parameter, the generic script ID that corresponds to the component-specific script ID that you pass in this parameter.theExactComponent
- A scripting component instance returned by a generic scripting component routine.
DESCRIPTION
TheOSARealToGenericID
function performs the reverse of the task performed byOSAGenericToRealID
. Given a component-specific script ID and an exact scripting component instance (that is, the component instance that created the component-specific script ID), theOSARealToGenericID
function returns the corresponding generic script ID. TheOSARealToGenericID
function modifies the script ID in place, changing the component-specific script ID passed in thetheScriptID
parameter to the corresponding generic script ID.You'll need to do this if you have obtained a component-specific script ID using an exact scripting component instance and you want to refer to the same script in calls that use an instance of the generic scripting component. You can't use a component-specific script ID with the generic scripting component.
The script ID you pass in the
theScriptID
parameter must be a component-specific script ID obtained from a scripting component instance known to the generic scripting component. You can obtain such an instance by calling eitherOSAGetScriptingComponent
orOSAGenericToRealID
.RESULT CODES