Skip to main content
Version: 20 R7 BETA

METHOD Get path

METHOD Get path ( methodType {; aTable}{; objectName{; formObjectName}}{; *} ) : Text

ParameterTypeDescription
methodTypeIntegerDesign object type selector
aTableTableTable reference
objectNameTextName of form or method
formObjectNameTextName of form object
*OperatorIf passed = command applies to host database when executed from a component (parameter ignored outside of this context)
Function resultTextFull path of object

Description

The METHOD Get path command returns the full internal pathname of a method.

In the methodType parameter, you pass the type of method whose path you want to get. You can use the following constants, found in the Design Object Access theme:

ConstantTypeValueComment
Path database methodInteger2Path of database methods specified. List of these methods:
[databaseMethod]/onStartup
[databaseMethod]/onExit
[databaseMethod]/onDrop
[databaseMethod]/onBackupStartup
[databaseMethod]/onBackupShutdown
[databaseMethod]/onWebConnection
[databaseMethod]/onWebAuthentication
[databaseMethod]/onWebSessionSuspend
[databaseMethod]/onServerStartup
[databaseMethod]/onServerShutdown
[databaseMethod]/onServerOpenConnection
[databaseMethod]/onServerCloseConnection
[databaseMethod]/onSystemEvent
[databaseMethod]/onSqlAuthentication
[databaseMethod]/ onHostDatabaseEvent
[databaseMethod]/ onRESTAuthentication
[databaseMethod]/ onMobileAppAuthentication
[databaseMethod]/ onMobileAppAction
Path project formInteger4Path of project form methods and all their object methods. Examples:
[projectForm]/myForm/{formMethod}
[projectForm]/myForm/button1
[projectForm]/myForm/mylist
[projectForm]/myForm/button1
Path project methodInteger1Name of method.
Example: MyProjectMethod
Path table formInteger16Path of table form methods and all their object methods. Example:
[tableForm]/table_1/Form1/{formMethod}
[tableForm]/table_1/Form1/button1
[tableForm]/table_1/Form1/mylist
[tableForm]/table_2/Form1/mylist
Path triggerInteger8Path of database triggers. Example:
[trigger]/table_1
[trigger]/table_2

Pass values in the aTable, objectName and formObjectName parameters according to the type of object for which you want to get the method pathname:

Type of objectaTableobjectNameformObjectName
Path Project formXX (optional)
Path Table formXXX (optional)
Path Database methodX
Path Project methodX
Path TriggerX

Note: The command does not check if the method actually exists in the database. An error is generated only when an invalid database method name is passed with the Path database method selector.

If the command is executed from a component, it returns by default the paths of the component methods. If you pass the * parameter, the array contains the paths of the methods of the host database.

Example

  //Retrieval of the pathname of the "On Startup" database method:
 $path:=METHOD Get path(Path database method;"onStartup")
 
  //Retrieval of the pathname of the trigger for the [Employees] table:
 $path:=METHOD Get path(Path trigger;[Employees])
 
  //Retrieval of the pathname of the "OK" object method of the "input" form for the [Employees] table:
 $path:=METHOD Get path(Path table form;[Employees];"input";"OK")

See also

Current method path
METHOD OPEN PATH
METHOD RESOLVE PATH

Properties

Command number1164
Thread safe