|
AIRuntimeSuite Struct Reference
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Public Attributes | |
| AIAPI AIErr(* | GetAppName )(AIAppName *name) |
| Retrieves the name of the host application running the plug-in. | |
| AIAPI AIErr(* | GetAppFileSpecification )(ai::FilePath &file) |
| Retrieves the file specification of the host application running the plug-in. | |
| AIAPI AIErr(* | GetUserName )(AIUserName *name) |
| Retrieves the user name, as registered with the application when it was installed. | |
| AIAPI AIErr(* | GetUserOrganization )(AIUserOrganization *organization) |
| Retrieves the user organization, as registered with the application when it was installed. | |
| AIAPI AIErr(* | GetUserSerialNumber )(AIUserSerialNumber *serialNumber) |
| Retrieves the user serial number, as registered with the application when it was installed. | |
| AIAPI AIErr(* | GetAppNameSpace )(AINameSpace **space) |
| Retrieves a reference to the namespace of the host application running the plug-in. | |
| AIAPI AIErr(* | GetAppStringPool )(AIStringPool **pool) |
| Retrieves a reference to the string pool of the host application running the plug-in. | |
| AIAPI size_t(* | GetAppFreeMem )(void) |
| Gets the amount of physical RAM on the computer, which you can use as an estimate of free application memory available. | |
| AIAPI AIErr(* | ShowAppAboutBox )(void) |
| Shows the about box for the application. | |
| AIAPI ai::int32(* | GetSystemVersion )(void) |
| Retrieves the version of the operating system the application is running on. | |
| AIAPI AIBoolean(* | GetIsSystemMacOSX )(void) |
| Reports whether the operating system is Mac OS X. | |
| AIAPI ai::int32(* | GetAppMajorVersion )(void) |
| Retrieves the major version number of the application (X where the version number is X.Y.Z). | |
| AIAPI ai::int32(* | GetAppMinorVersion )(void) |
| Retrieves the minor version number of the application (Y where the version number is X.Y.Z). | |
| AIAPI ai::int32(* | GetAppRevisionVersion )(void) |
| Retrieves the revision number of the application (Z where the version number is X.Y.Z). | |
| AIAPI AIErr(* | GetAppNameUS )(ai::UnicodeString &name) |
| Retrieves the Unicode name of the host application running the plug-in. | |
| AIAPI AIErr(* | GetUserNameUS )(ai::UnicodeString &name) |
| Retrieves the Unicode user name, as registered with the application when it was installed. | |
| AIAPI AIErr(* | GetUserOrganizationUS )(ai::UnicodeString &organization) |
| Retrieves the Unicode organization name, as registered with the application when it was installed. | |
| AIAPI AIErr(* | GetDefaultScript )(AIFaceScript *script) |
| Retrieves the default script for the application. | |
| AIAPI AIBoolean(* | GetIsHonestyBuild )(void) |
| Used internally. | |
| AIAPI AIBoolean(* | GetIsProductTryAndDie )(void) |
| Used internally. | |
| AIAPI AIBoolean(* | GetIsExeBuild )(void) |
| Used internally. | |
| AIAPI AIErr(* | ShowAdobeHelp )(const char *pageID) |
| Launches the Adobe Help Viewer and shows an Illustrator help page. | |
| AIAPI ai::int32(* | GetAppBuildNumber )(AIBoolean *isDebug) |
| Retrieves the application build number. | |
| AIAPI ai::int32(* | GetUserAdobeID )(const char **userGUID, const char **userAdobeID) |
| Retrieves Adobe user's GUID and AdobeID. | |
This suite provide functions that allow you to obtain information about the name and version number of the plug-in host application.
You can access application instances of the name space and string pool data structures, and the user name, organization, and serial number registered for the application.
The following notifiers are associated with the runtime suite:
kAIApplicationStartedNotifier
kAIApplicationShutdownNotifier
SPBasicSuite::AcquireSuite() with the constants kAIRuntimeSuite and kAIRuntimeVersion. | AIAPI ai::int32(* AIRuntimeSuite::GetAppBuildNumber)(AIBoolean *isDebug) |
Retrieves the application build number.
| isDebug | [out] A buffer in which to return a flag, or NULL if flag is not needed. Returns true if this is a debug build, false if this is a release build. |
| AIAPI AIErr(* AIRuntimeSuite::GetAppFileSpecification)(ai::FilePath &file) |
Retrieves the file specification of the host application running the plug-in.
| name | [out] A buffer in which to return the file specification. |
| AIAPI size_t(* AIRuntimeSuite::GetAppFreeMem)(void) |
Gets the amount of physical RAM on the computer, which you can use as an estimate of free application memory available.
(Note that this function returns a numeric value, not an error code.)
| AIAPI ai::int32(* AIRuntimeSuite::GetAppMajorVersion)(void) |
Retrieves the major version number of the application (X where the version number is X.Y.Z).
(Note that this function returns a numeric value, not an error code.)
| AIAPI ai::int32(* AIRuntimeSuite::GetAppMinorVersion)(void) |
Retrieves the minor version number of the application (Y where the version number is X.Y.Z).
(Note that this function returns a numeric value, not an error code.)
| AIAPI AIErr(* AIRuntimeSuite::GetAppName)(AIAppName *name) |
Retrieves the name of the host application running the plug-in.
You can use the name to verify that your plug-in is running in a supported host application. You can also use the name and serial number to key your plug-in to an installed application.
| name | [out] A buffer in which to return the name, as a C-string from the application string pool. Do not modify the returned string. |
| AIAPI AIErr(* AIRuntimeSuite::GetAppNameSpace)(AINameSpace **space) |
Retrieves a reference to the namespace of the host application running the plug-in.
A plug-in can create its own namespace in which to store arbitrary data, but it can also use this function to access the application�s namespace. The application preferences (among other things) are stored in the application namespace.
Your plug-in should not modify the application�s existing namespace data directly, but it can create new data within the application namespace.
| space | [out] A buffer in which to return the namespace reference. |
| AIAPI AIErr(* AIRuntimeSuite::GetAppNameUS)(ai::UnicodeString &name) |
Retrieves the Unicode name of the host application running the plug-in.
| name | [out] A buffer in which to return the name, as a Unicode string. |
| AIAPI ai::int32(* AIRuntimeSuite::GetAppRevisionVersion)(void) |
Retrieves the revision number of the application (Z where the version number is X.Y.Z).
(Note that this function returns a numeric value, not an error code.)
| AIAPI AIErr(* AIRuntimeSuite::GetAppStringPool)(AIStringPool **pool) |
Retrieves a reference to the string pool of the host application running the plug-in.
Illustrator maintains a string pool which any plug-in can access. Runtime data for a host is stored in this string pool, and the strings returned by functions in this suite belong to the application string pool. These references point to the C-string data in the pool, and should not be modified. If you need to modify such a string, copy it to local storage. See AIStringPoolSuite.
| pool | [out] A buffer in which to return the string-pool reference. |
| AIAPI AIErr(* AIRuntimeSuite::GetDefaultScript)(AIFaceScript *script) |
Retrieves the default script for the application.
| script | [out] A buffer in which to return the script reference. |
| AIAPI AIBoolean(* AIRuntimeSuite::GetIsExeBuild)(void) |
Used internally.
Reports whether this is an executable build.
| AIAPI AIBoolean(* AIRuntimeSuite::GetIsHonestyBuild)(void) |
Used internally.
| AIAPI AIBoolean(* AIRuntimeSuite::GetIsProductTryAndDie)(void) |
Used internally.
| AIAPI AIBoolean(* AIRuntimeSuite::GetIsSystemMacOSX)(void) |
Reports whether the operating system is Mac OS X.
| AIAPI ai::int32(* AIRuntimeSuite::GetSystemVersion)(void) |
Retrieves the version of the operating system the application is running on.
(Note that this function returns a constant value, not an error code.)
| AIAPI ai::int32(* AIRuntimeSuite::GetUserAdobeID)(const char **userGUID, const char **userAdobeID) |
Retrieves Adobe user's GUID and AdobeID.
| AIAPI AIErr(* AIRuntimeSuite::GetUserName)(AIUserName *name) |
Retrieves the user name, as registered with the application when it was installed.
| name | [out] A buffer in which to return the name, as a C-string from the application string pool. Do not modify the returned string. |
| AIAPI AIErr(* AIRuntimeSuite::GetUserNameUS)(ai::UnicodeString &name) |
Retrieves the Unicode user name, as registered with the application when it was installed.
| name | [out] A buffer in which to return the name, as a Unicode string. |
| AIAPI AIErr(* AIRuntimeSuite::GetUserOrganization)(AIUserOrganization *organization) |
Retrieves the user organization, as registered with the application when it was installed.
| organization | [out] A buffer in which to return the organization, as a C-string from the application string pool. Do not modify the returned string. |
| AIAPI AIErr(* AIRuntimeSuite::GetUserOrganizationUS)(ai::UnicodeString &organization) |
Retrieves the Unicode organization name, as registered with the application when it was installed.
| organization | [out] A buffer in which to return the name, as a Unicode string. |
| AIAPI AIErr(* AIRuntimeSuite::GetUserSerialNumber)(AIUserSerialNumber *serialNumber) |
Retrieves the user serial number, as registered with the application when it was installed.
| serialNumber | [out] A buffer in which to return the serial number, as a C-string from the application string pool. Do not modify the returned string. |
| AIAPI AIErr(* AIRuntimeSuite::ShowAdobeHelp)(const char *pageID) |
Launches the Adobe Help Viewer and shows an Illustrator help page.
| pageID | A null terminated UTF-8 string for the help page ID, or a NULL pointer to bring up the default help page. |
| AIAPI AIErr(* AIRuntimeSuite::ShowAppAboutBox)(void) |
Shows the about box for the application.
| Contents | Suites | Classes | Class Index | Member Index |
 |
||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
