Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Application::Service::IApplicationService Class Referenceabstract

This service provides "Adobe Animate CC" application-level services. More...

#include <IApplicationService.h>

Inheritance diagram for Application::Service::IApplicationService:

Public Member Functions

virtual FCM::Result _FCMCALL GetActiveFLADocument (DOM::PIFLADocument &pDocument)=0
 This function returns the active FLA document. More...
 
virtual FCM::Result _FCMCALL GetVersion (FCM::U_Int32 &version)=0
 This function returns the application version. More...
 
virtual FCM::Result _FCMCALL GetLanguageCode (StringRep8 *ppLanguageCode)=0
 This function returns the locale of the application user interface. More...
 

Detailed Description

This service provides "Adobe Animate CC" application-level services.

Note
This interface is supported for CPSDK version 1.3 and above (or for 'Adobe Animate CC').

Member Function Documentation

virtual FCM::Result _FCMCALL Application::Service::IApplicationService::GetActiveFLADocument ( DOM::PIFLADocument &  pDocument)
pure virtual

This function returns the active FLA document.

Parameters
pDocument(OUT) Active FLA document
Returns
On success, FCM_SUCCESS is returned; else an error code is returned.
virtual FCM::Result _FCMCALL Application::Service::IApplicationService::GetLanguageCode ( StringRep8 *  ppLanguageCode)
pure virtual

This function returns the locale of the application user interface.

Parameters
ppLanguageCode(OUT) Five character code identifying the locale/language of the applications user interface. Following language codes are supported: "en_US", "ja_JP", "zh_CN", "zh_TW", "ko_KR", "nl_NL", "fr_FR", "de_DE", "it_IT", "es_ES", "sv_SE", "pt_BR", "cs_CZ", "pl_PL", "ru_RU", "tr_TR"
Returns
On success, FCM_SUCCESS is returned; else an error code is returned.
Note
The caller of this function must release the memory for 'ppLanguageCode' using IFCMCalloc::Free().
virtual FCM::Result _FCMCALL Application::Service::IApplicationService::GetVersion ( FCM::U_Int32 &  version)
pure virtual

This function returns the application version.

Parameters
version(OUT) Application Version
Note
"version" is a 32-bit integer. Version can be converted into form Major.Minor.Maintenance.Build, by doing the following:

((version >> 24) & 0xFF) gives the Major number. ((version >> 16) & 0xFF) gives the Minor number. ((version >> 8) & 0xFF) gives the Maintenance number. ((version ) & 0xFF) gives the Build number.

Returns
On success, FCM_SUCCESS is returned; else an error code is returned.
The documentation for this class was generated from the following file: