Connection Class (clsConnection)

fdmAPI.API.DataWindow.Connection.API Call

Table 47. API.DataWindow.Connection

API CallMethod/Property/Object ReferenceDescription
GlngErrNoPropertyContains the error number in the event of an error.
GstrErrorPropertyContains the error number in the event of an error.
PblnEncodingUnicodePropertyReturns “True” when set to UTF-8, but “false” for all others.
PblnUseTransPropertyThis property defaults to “False.” If it is set to “True,” the query executed in ExecuteDML is executed as a transaction.
PobjAppObject ReferenceReference to the clsAPP class
PstrConnectionPropertyReturns the connection string to FDMEE.
PstrDatabasePropertyConnection string database catalog name
PstrDatabaseUserIDPropertyContains the database user ID.
PstrDirDataPropertyReturns the path to the Data directory.
PstrDirInboxPropertyReturns the path to the Inbox directory.
PstrDirOutboxPropertyReturns Outbox directory based on LoadID.
PstrDirReportPropertyReturns blank. Needs to point to install the “templates” directory.
PstrDirScriptsPropertyReturns Scripts directory for LoadID.
PstrLanguageCodePropertyReturns FDMEE API language code. Returns “en” (for English) only. This property cannot be changed in the user interface.
PstrProviderPropertyReturns the provider used by FDMEE API.
PstrQueryDateMaskPropertyGet/Set Query Date mask which is used through the API for queries involving date fields. The default is "yyyMMdd".
PstrResourceFileDirectoryPropertyPoints to the FDM API localization files directory path.
PstrServerPropertyPrints the database server name.
fGenerateRndMethodReturns the random number (short type).
fGetOSUserIDMethodReturns the OS user of the current process.