- AppeonGetAppeonUserName function
- AppeonGetBrowserVersion function
- AppeonGetCacheDir function
- AppeonGetClientID function
- AppeonGetClientIP function
- AppeonGetClientType function
- AppeonGetClientVersion function
- AppeonGetHttpInfo function
- AppeonGetIEHandle function
- AppeonGetIEURL function
- AppeonGetOSType function
- AppeonGetRemainingdays function
- AppeonGetServerType function
- AppeonGetSessionCount function
- appeonisin64browser function
- AppeonLDAPLogon function
- AppeonNetworkTest function
- AppeonPopMenu function
- AppeonPopMenuOn function
- AppeonPrint2File function
- AppeonPrint2PDF function (Obsolete)
- AppeonSetHintText function
- AppeonSetLongPressInterval function
- AppeonSwitchRealTimeCalc function
Appeon client functions are PowerBuilder global functions which perform identical functionalities to the function of AppeonExtFuncs object. However, heavy use of global functions are not recommended due to their poor extensibility and performance compared to object functions, therefore, whenever it is feasible, Appeon client function should be replaced with the equivalent function of AppeonExtFuncs object.
Description
Gets the user name that you type into the Appeon Login dialog box.
Syntax
AppeonGetAppeonUserName ( )
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the Internet Explorer version of the Web client.
Supported in the browser-based Web application only.
Syntax
AppeonGetBrowserVersion ( )
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the cache directory that is used by the current application.
For the Web application, the cache directory can be customized in AEM. For details, refer to the section called “Client Storage Location” in PowerServer Configuration Guide for .NET or in PowerServer Configuration Guide for J2EE.
For the iOS mobile application, the cache directory is /$Appeon_Mobile_folder$/Documents/$your_application_folder$, for example, /var/mobile/Applications/144F5F33-A33F-480D-A3D9-01BBA5410EB2/Documents/4c001b05.
For the Android mobile application, the cache directory is /data/data/$Appeon_Mobile_folder$/files/$your_application_folder$, for example, /data/data/com.appeon.mobile/files/21746870.
Syntax
AppeonGetCacheDir ( )
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the unique session identifier for the Web or mobile client.
Syntax
AppeonGetClientID ( )
Return value
String.
Description
Gets the IP address of the Web or mobile client.
Syntax
AppeonGetClientIP ( )
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the type of an application.
Syntax
AppeonGetClientType ( )
Return value
|
String |
Returns "WEB" if the application runs in the Web browser or on the desktop as an IWA (installable Web app). Returns "PB" if the application runs in PowerBuilder. Returns "MOBILE" if the application runs on a mobile device. |
Description
Supported in the mobile application only.
Gets the version of the Appeon client that runs your application.
Syntax
AppeonGetClientVersion ( )
Return value
String.
Description
Gets the HTTP header information from a particular request.
Syntax
AppeonGetHttpInfo ( string
attribute )
|
Argument |
Description |
|
|
The required HTTP information. For example, "Host", "Cookie", etc. |
Return value
String
Description
Gets the Internet Explorer handle for the Web application.
Supported in the browser-based Web application only.
Syntax
AppeonGetIEHandle ( )
Return value
Long.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the URL of the Web application.
For the mobile application, use of_getappinfo to get the URL of the mobile application.
Syntax
AppeonGetIEURL ( )
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Gets the type of OS that runs your application (the PowerServer Web application, the PowerServer mobile application, or the PowerBuilder client application).
Syntax
AppeonGetOSType ( )
Return value
|
String. |
Returns the type of OS that runs the PowerServer Web application, the PowerServer mobile application, or the PowerBuilder client application. |
Description
Gets the remaining day(s) of license or technical support.
This function is unsupported in the PowerServer PB Edition.
Syntax
AppeonGetRemainingdays ( String
as_type, ref string
as_error )
|
Argument |
Description |
|
|
License or technical support that you want to get the remaining day(s). "license" indicates to get remaining day(s) of license. "support" indicates to get remaining day(s) of technical support. |
|
|
An empty string or error messages. |
Return value
|
Long. |
Returns a number >0 if the license or technical support has remaining day(s). Returns 0 if there is no expiration date. Returns -1 if license or technical support has expired, PowerServer has an exception, or parameter is invalid. |
Description
Gets the PowerServer type where the application runs.
Syntax
AppeonGetServerType ( )
Return value
|
Integer. |
Returns 1 if the application runs on a PowerServer that is installed to a Java Server (such as JBoss). Returns 2 if the application runs on a PowerServer that is installed to a .NET IIS server. |
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
This function is obsolete since Appeon PowerServer 2013. Replace it with the getSessionCount function in PowerServer open interfaces.
Description
Detects if the IE browser where the application runs is 64-bit.
Syntax
appeonisin64browser ( )
Return value
|
Boolean. |
Returns "true" if the application runs on a 64-bit IE browser. Returns "false" if the application runs on a 32-bit IE browser. |
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application.
Description
Logs in to the LDAP server with the specified user name and password.
Syntax
AppeonLDAPLogon ( string
as_username, string
as_password )
|
Argument |
Description |
|
|
User name for logging into the LDAP server. |
|
|
Password for logging into the LDAP server. |
Return value
String.
Usage
This function takes effect in the deployed PowerServer application, not in the PowerBuilder application. To make this function work in the deployed application, you should set the System Security to ON in AEM, and make sure the LDAP server is correctly set up. For detailed instructions, refer to the section called “System Security” in PowerServer Configuration Guide for .NET or PowerServer Configuration Guide for J2EE.
Description
Calculates the elapsed time for the client to call the server over the network. The returned value can help the developer find out the network state, and then determine whether to do data retrieval or update, especially for a large amount of data. This improves the end user experience, to avoid hanging up the application for a long time when data retrieval or update is performed on a poor network connection.
This function is supported on both the Web and mobile clients.
This function works with the .NET IIS server only, not with the J2EE application server.
Syntax
AppeonNetworkTest ( long
lcount )
|
Argument |
Description |
|
|
The times to call the server. It should be a number between 1 and 9999. |
Return value
Returns the elapsed time (in milliseconds) for the call when the function succeeds, and returns -1 when failing to connect to PowerServer, and -2 for timeout (timeout is 1 second and is not configurable).
Description
Pops up Appeon DataWindow menu at a specified position in a specified DataWindow control.
Appeon DataWindow Menu is available in PowerServer Web only. For more information about the menu items, refer to the section called “Appeon DataWindow menu” in PowerServer Toolkit User Guide.
Supported on the Web client only.
Syntax
AppeonPopMenu ( datawindow
adw_dw , Integer nx ,
Integer ny )
|
Argument |
Description |
|---|---|
|
adw_dw |
The DataWindow control on which you want to pop up the Appeon DataWindow menu. |
|
nx |
The instance from the left edge of the popup menu. |
|
ny |
The instance from the top edge of the popup menu. |
Return value
None.
Usage
-
The user customized RMB menu has a higher priority than the Appeon customized menu.
-
The AppeonPopMenu function has a higher priority than the AppeonPopMenuOn function.
-
Defining your RMB menu in RButtonDown event is not recommended because this will cause confusion in the system. To work around this, define your RMB menu in the RButtonUp event.
Description
Pops up Appeon DataWindow menu in a specified window when you right click the mouse button.
Appeon DataWindow Menu is available in PowerServer Web only. For more information about the menu items, refer to the section called “Appeon DataWindow menu” in PowerServer Toolkit User Guide.
Supported on the Web client only.
Syntax
AppeonPopMenuOn ( datawindow
adw_dw, Boolean
ab_show )
|
Argument |
Description |
|---|---|
|
adw_dw |
The DataWindow control on which you want to show the Appeon DataWindow menu. |
|
ab_show |
Gives an option whether to display or not display the Appeon DataWindow menu. True - Enables the display of the Appeon DataWindow menu. False - Disables the display of the Appeon DataWindow menu. |
Return value
None.
Usage
-
The user customized RMB menu has a higher priority than the Appeon customized menu.
-
The AppeonPopMenu function has a higher priority than the AppeonPopMenuOn function.
-
Defining your RMB menu in RButtonDown event is not recommended because this will cause the confusion of the system. To work around this, define your RMB menu in the RButtonUp event.
Description
Saves the specified DataWindow as image files of BMP, JPG or GIF format.
Supported on the Web client only.
Syntax
AppeonPrint2File ( datawindow
adw, string asoutpath,
string asoutname, long
alouttype )
|
Argument |
Description |
|---|---|
|
|
The DataWindow object to be saved as image files |
|
|
The path of image files |
|
|
The specified name of image files |
|
|
The format type of files: 1-BMP; 2-JPG; 3-GIF |
Return value
|
Integer. |
Returns 1 if it succeeds in saving the specified DataWindow as image files. Returns -1 if an unknown error occurs. Returns -2 if alouttype is an unsupported image format. Returns -3 if adw is an invalid DataWindow object, DataStore object or DataWindowChild object. Returns -4 if it fails in creating a file, e.g., the specified path does not exist or without access rights. Returns -5 if it fails in creating device context, e.g., user sets a large size when customizing page property. Returns -6~-12 if an internal error occurs. |
Usage
-
This function is used to execute saving DataWindow as image files.
-
If the page size is large enough, a DataWindow is saved as one file; if the size of a DataWindow surpasses the page size, the DataWindow is saved as several files.
-
The asoutname is the file name specified by user, for example, the function is appeonprint2file(adw, "c:\", "appeon", 1), if a DataWindow is saved as one file, the file is like C:\appeon.bmp; if a DataWindow is saved as several files, the files are like C:\appeon1.bmp, C:\appeon2.bmp, ..., C:\appeonN.bmp. Another example, the function is appeonprint2file(adw, "c:\", "test.bmp", 1), if a DataWindow is saved as one file, the file is like C:\ test.bmp.bmp; if a DataWindow is saved as several files, the files are like C:\test.bmp1.bmp, C:\test.bmp2.bmp, ..., C:\test.bmpN.bmp.
-
The upper limit of page size is restrained by the type of operating system. For instance, in Windows Vista, the upper limit of customized page size is 5500*5500 around. However, the page size can also be 1024*10000 by reducing page width and increasing page height.
Obsolete function
AppeonPrint2PDF is an obsolete function and will be discontinued in a future release. Please replace it with the SaveAs function of the DataWindow or Child DataWindow and set the saveas file type to PDF format. For details, refer to the section called “Functions of DataWindow control” in Supported PB Features for PowerServer Web or Supported PB Features for PowerServer Mobile.
Supported on the Web client only.
Description
Sets the HintText property of the SingleLineEdit control. The HintText property is not available in PowerBuilder SingleLineEdit control. It is specially designed for the PowerServer mobile application.
Note: This function is obsolete since version 2017.
appeonsethinttext ( singlelineedit
sle_target, string
as_hinttext )
|
Argument |
Description |
|---|---|
|
|
The SingleLineEdit control. |
|
|
The text that will be displayed as hint text in the SingleLineEdit control. |
Return value
| Integer. |
1 - Success. -1 - It is called in PowerBuilder or PowerServer Web, or there is an error. -2 - The -3 - The |
Description
Sets the duration (in milliseconds) for a press before it is recognized as a long press. Once this duration is reached, the keyboard will be brought up to display. By default, the keyboard pops up when the user taps twice in the field of the DataWindow, or when the user presses the DataWindow field for as long as 1500 milliseconds.
Supported on mobile client only.
Syntax
appeonsetlongpressinterval ( long
al_interval )
|
Argument |
Description |
|---|---|
|
|
Sets the duration in milliseconds. If it is set to a value smaller than 500 milliseconds, then 550 milliseconds will be used, because 500 milliseconds is already used as the duration for the DataWindow drag & drop event. |
Return value
| Long. |
1 - Success. -1 - It is called in PowerBuilder or PowerServer Web, or there is an error. |
Description
Performs the DataWindow real-time expression calculation in time or performs the calculation for only 1 time in the whole life-cycle.
Syntax
AppeonSwitchRealTimeCalc ( powerobject
adw, integer para
)
|
Argument |
Description |
|---|---|
|
|
The DataWindow/DataStore/DataWindowChild object. |
|
|
0 - Default value, performs the real-time calculation; 1 - No need to perform the real-time calculation, and performs the calculation for only one time in the whole life-cycle. |
Return value
| Integer. |
0 - Success. -1 - Failure. |
