Mac Dev Center Mac OS X Reference Library Apple Applications: Final Cut Pro/Final Cut Express FxPlug Reference

Introduction

Defines the functions the application provides to retrieve parameter values.

Discussion

This is version 2 of the Pararameter Retrieval API. This version 2 protocol is a superset of version 1.

NOTE: A plug-in that doesn't need the new functionality found in version 2 should simply conform to the version 1 protocol. This will ensure compatibility with older plug-in hosts that might not support version 2.

Methods

-getStringParameterValue:fromParm:

Gets a string value from a string parameter.

Gets a string value from a string parameter.

- (BOOL)getStringParameterValue:(NSString **)string fromParm:(UInt32)parmId;

Parameters

string

Pointer to the NSString object pointer to receive the string value.

parmId

Unique identifier for the parameter.

Return Value

Returns YES if the value is retrieved successfully; NO otherwise.