GetShortName

Description

Gets the short name for the current PowerBuilder execution context.

Applies to

ContextInformation objects

Syntax

servicereference.GetShortName ( shortname )

Argument

Description

servicereference

Reference to the ContextInformation service instance.

shortname

String into which the function places the short name. This argument is passed by reference.


Return value

Integer.

Returns 1 if the function succeeds and -1 if an error occurs.

Usage

Call this function to determine the current execution environment. The window plug-in and window ActiveX contexts are obsolete in the current version of PowerBuilder. For PowerBuilder 2017 and later applications, the only value passed for the shortname argument is "PBRun".

Examples

This example calls the GetShortName function. ci is an instance variable of type ContextInformation:

String ls_name
 
this.GetContextService("ContextInformation", ci)
ci.GetShortName(ls_name)
IF ls_name <> "PBRun" THEN
   cb_close.visible = FALSE
END IF

See also

GetCompanyName

GetContextService

GetFixesVersion

GetHostObject

GetMajorVersion

GetMinorVersion

GetName

GetVersionName