Connection Class (clsConnection)

fdmAPI.API.DataWindow.Connection.API Call

Table 7-6 API.DataWindow.Connection

API Call Method/Property/Object Reference Description
GlngErrNo Property Contains the error number in the event of an error.
GstrError Property Contains the error number in the event of an error.
PblnEncodingUnicode Property Returns "True" if set to UTF-8, but "false" for all others.
PblnUseTrans Property This property defaults to "False." If it is set to "True," the query executed in ExecuteDML is executed as a transaction.
PobjApp Object Reference Reference to the clsAPP class
PstrConnection Property Returns the connection string to Oracle Hyperion Financial Data Quality Management, Enterprise Edition.
PstrDatabase Property Connection string database catalog name
PstrDatabaseUserID Property Contains the database user ID.
PstrDirData Property Returns the path to the Data directory.
PstrDirInbox Property Returns the path to the Inbox directory.
PstrDirOutbox Property Returns the Outbox directory based on LoadID.
PstrDirReport Property Returns blank. Needs to point to where the "templates" directory is installed.
PstrDirScripts Property Returns Scripts directory for LoadID.
PstrLanguageCode Property Returns FDMEE API language code. Returns "en" (for English) only. This property cannot be changed in the user interface.
PstrProvider Property Returns the provider used by FDMEE API.
PstrQueryDateMask Property Get/Set Query Date mask which is used through the API for queries involving date fields. The default is "yyyMMdd."
PstrResourceFileDirectory Property Points to the FDM API localization files directory path.
PstrServer Property Prints the database server name.
fGenerateRnd Method Returns the random number (short type).
fGetOSUserID Method Returns the OS user of the current process.