You are here: NI Home > Support > Product Reference > Manuals > LabVIEW Datalogging and Supervisory Control Module 8.2 Help

Programmatically creates a Citadel database with the name specified by database name in the directory specified by database path on the computer specified by computer name. If the specified database name already exists at the specified database path, the VI does nothing. If detached Citadel database files exist at the specified database path, they are attached as the specified database name. You might need to attach a database that was previously detached or a database that was manually copied to that location for National Instruments software to the database. If a database with the specified database name already exists in a different directory or a database of a different name exists at the specified database path, the VI returns an error.

Refer to the Measurement & Automation Explorer Help for Historical Data Viewer, available in the Help»Help Topics menu in MAX, for more information about creating, attaching, and detaching Citadel databases.

	timeout limits the time that the VI waits for data to be returned from the database. The default is 30 seconds. A timeout value of less than or equal to 0 indicates no timeout, which means that the VI waits indefinitely until the data is returned.
	computer name specifies the computer on which to create the database. If you do not wire this parameter, computer name defaults to the local computer.
	database name is the name of the database the VI creates. If you do not wire this parameter, the VI uses the database path to generate a database name, replacing all non-alphanumeric characters with underscores. For example, a database path of C:\data1\data2\database generates the database name C__data1_data2_database.
	database path is the file path to the directory in which to create the database.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	database URL out is the computer name and database name.
	created returns TRUE if the VI created a new database and returns FALSE if the VI did not create a new database.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.