RegisterSchemaRepoFromFile

Description

Creates a new database set (also known as a connection in HCL Compass Maintenance Tool) using the file path argument. Returns an error message if an error occurred. The file path argument is the path name of a connection profile file created by HCL Compass Maintenance Tool.
Note: Session does not need to be logged in.
The required file format is Name=Value pairs. The names that can be used are, DbSetName, Name, Info, Database, Server, IsVisible, Vendor, Info2, IsMaster, ConnectOptions, and Description. For example:
DbSetName=mydbset 
Vendor=2 
Server= 
Database=C:\my_dir\488498\mydbset.mdb 
Info= 
ConnectOptions= 
Name=MASTR
Note: This method does not currently work with versions of HCL Compass Maintenance Tool that support multiple database sets in a profile file.

Syntax

VBScript


adminSession.RegisterSchemaRepoFromFile filePath 

Perl


$adminSession->RegisterSchemaRepoFromFile(filePath); 
Identifier
Description
adminSession
The AdminSession object representing the current schema repository access session.
filePath
A String containing the file path to the connection information.
Return value
A Boolean whose value is True if the operation was successful, otherwise False.