Developer’s Guide

68 FileMaker Developer’s Guide
GetString message
The GetString message, kFMXT_GetString, is sent to the plug-in when
FileMaker Pro, FileMaker Developer, or FileMaker Server want to
retrieve one of the following strings from the plug-in. The plug-in
developer can decide where to store the strings.
Avoiding potential Mac OS X
resource conflicts
Problems can occur on Mac OS X machines if your plug-in has the
same ID for a resource that FileMaker
Pro, FileMaker Developer,
FileMaker Server, or another plug-in has for the same type of
resource.
To avoid potential resource ID conflicts with your plug-in and other
applications or plug-ins, follow these guidelines:
1 Use ID numbers between 23,000 and 24,999
Use hard-coded IDs from this range for your dialog boxes, sounds,
icons, and other resources to avoid conflicts with FileMaker
Pro,
FileMaker Developer, or FileMaker Server resources. FileMaker
does not use any of the IDs in this range for the application resources.
1 Set the current resource file to your plug-in
To avoid conflicts with other plug-ins that use the same resource IDs,
use the Mac OS X toolbox call in the Resource Manager to set the
current resource file to your plug-in before getting any resource
objects from the resource file.
Include the following line before any line that references or uses a
resource:
UseResFile (pb -> resourceID) ;
When FileMaker Pro, FileMaker Developer, or FileMaker Server
loads your plug-in, the application gives the resource ID. This is
located in the parameter block near the param2 and param3 variables
in the FMExtern.h file. For more information, see
“API code files”
on page 64.
Providing documentation for your plug-in
Your plug-in should include an example database file with any
special fields and scripts necessary to demonstrate the use of the
plug-in’s external functions. In addition, you should provide
documentation that describes each external function and its
parameters.
For ideas on how to document your plug-in, see other external
function plug-ins registered with FileMaker at www.filemaker.com.
Registering your plug-in
Register your external function plug-in with FileMaker to ensure that
it’s unique and not in use by any other plug-in. Registering also
allows you to make your plug-in visible to customers searching for a
plug-in to suit their needs.
Before registering your plug-in, you can search to see if the plug-in
name or option string ID you are requesting has already been
assigned.
You must register each plug-in separately. To register your plug-in,
go to the Support section of www.filemaker.com.
String Meaning
kFMXT_OptionsStr = 131 The option string
kFMXT_NameStr = 128 The plug-in name
kFMXT_AppConfigStr = 129 The help text to display in the Preferences
dialog box