Method 

Description 

AddBackupDevice 

Add a backup device.
Type: Tape/Disk/Pipe
DevName: Device name
Path: Path to device 

AttachDB 

Attaches a database to a server
DBName: Database name
FileList: Database files 

AttachDBSingleFile 

Attaches a database having only one data file to the current server.
DBName: Database name
FileName: Path to database file 

BackupDBFiles 

Backs up an entire database, transaction log, or one or more files or filegroups
BackupInfo: Pointer to a TDBBackupInfo class
This function uses DBName, DBFileList, DeviceName, DiskFile members of the TDBBackupInfo class
 

ChangeAppRolePassword 

Changes the password of an application role in the current database.
AppRoleInfos: Array of TLoginInfo
Count: Number of elements
This function uses Role and Password member of TLoginInfo 

ChangeDBOwner 

Changes the owner of the current database
NewOwner: New owner
RemapAlias: Is the value true or false, which indicates whether existing aliases to the old database owner (dbo) are mapped to the new owner of the current database or dropped 

ChangeObjectOwner 

Change object's owner 

ChangePasswords 

Change logins passwords
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array element
This function uses OldPassword, Password, and LoginName members of TLoginInfo Structure 

ChangeUsersLogins 

Changes the relationship between a Microsoft® SQL Server™ login and a SQL Server user in the current database.
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array elements
This function uses UserName, LoginName members of TLoginInfo
UserName: Database user name
LoginName: SQL Server's login account name 

CreateAppRoles 

Create an application role for current database
AppRoleInfos: Pointer to array of TLoginInfo
Count: Number of array elements
This function uses Role, Password members of TLoginInfo
Role: Application role to create
Password: Application role password 

CreateDatabases 

Create one or more databases
DatabaseName: List of databases to create 

CreateDBRoles 

Creates a new Microsoft® SQL Server™ role in the current database.
AccountInfos: Pointer to array of TLoginInfo
Count: Number of array elements
This function uses Role, LoginName members of TLoginInfo
Role: Database role to create
LoginName: New role owner. 

CreateLogins 

Creates new Microsoft® SQL Server™ logins that allows a user to connect to an instance of SQL Server using SQL Server Authentication.
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array elements
This function uses LoginName, Password, DefaulDatabase, Role members of TLoginInfo
LoginName: SQL Server's login account name
Password: Password
DefaultDatabase: Default database for the login
Role: Server role of the new login 

CreateUsers 

Adds security accounts in the current database for Microsoft® SQL Server™ logins or Microsoft Windows NT® users or groups, and enables accounts to be granted permissions to perform activities in the database
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array elements
This function uses LoginName, UserName, Role members of TLoginInfo
LoginName: SQL Server's login account name
UserName: Database user name
Role: Database role of the new user 

DeleteAppRoles 

Removes application roles from the current database.
AppRoles: Application role list 

DeleteBackupDevice 

Drops a database device or backup device from Microsoft® SQL Server™, deleting the entry from master.dbo.sysdevices.
DevName: Backup device name
DeleteFile: Is whether or not the physical backup device file should be deleted. delfile is varchar(7). If true, the physical backup device disk file is deleted 

DeleteDatabases 

Removes one or more databases from Microsoft® SQL Server™. Removing a database deletes the database and the disk files used by the database.
DatabaseName: Database name list 

DeleteDBRoles 

Removes Microsoft® SQL Server™ roles from the current database.
DBRoles: Database role list 

DeleteLogins 

Removes Microsoft® SQL Server™ logins, preventing access to SQL Server using those login names
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array element
This function uses LoginName member of TLoginInfo
LoginName: Login account to be removed 

DeleteUsers 

Removes security accounts from the current database.
LoginInfos: Pointer to array of TLoginInfo
Count: Number of array element
This function uses UserName member of TLoginInfo
UserName: Is the name of the account to be removed. UserName can be the name of a Microsoft® SQL Server™ user, or Microsoft Windows NT® user or group, and must exist in the current database. When specifying a Windows NT user or group, specify the name the Windows NT user or group is known by in the database 

DetachDB 

Detaches a database from a server and, optionally, runs UPDATE STATISTICS on all tables before detaching
DBName: Database name
SkipCheck: If true, UPDATE STATISTICS is skipped. If false, UPDATE STATISTICS is run. This option is useful for databases that are to be moved to read-only media. 

Disconnect 

Disconnect 

GetAllDatabases 

Reports information about all databases.
DatabaseList: Pointer to a TTntStringList
Status: If true, report databases' status
After return, DatabaseList will contain XML data in the following format

• <Databases>
  • <Database>
    • <Name>master</Name>
    • <Size>4.50 MB</Size>
    • <Owner>sa</Owner>
    • <DateCreated>Apr 8 2003</DateCreated>
    • <Level>90</Level>
    • <Status></Status>
  • </Database>
• </Databases>

 

GetAllLoginPassword 

Get all login's encrypted passwords
After return, Logins will contain XML data in the following format

• <Logins>
  • <Login>
    • <Name>sa</Name>
    • <Paswword>PASSWORD</Password>
  • </Login>
• </Logins>

 

GetBackupDevices 

Get all backup devices
After return, DeviceList will contain XML data in the following format

• <BackupDevices>
  • <Device>
    • <Name></Name>
    • <Size></Size>
    • <Status></Status>
    • <ControlType></ControlType>
    • <PhysicalName></PhysicalName>
  • </Device>
• </BackupDevices>

 

GetBackupFiles 

Returns a result set with a list of the database and log files contained in the backup set
Files: File list
DevName: Device name
DiskFile: Device is a disk file
BackupSet: Backup set number
After return, Files will contain XML data in the following format:

• <BackupFiles>
  • <BackupFile>
    • <Name></Name>
    • <Path></Path>
    • <Type></Type>
    • <FileGroup></FileGroup>
    • <Size></Size>
    • <MaxSize></MaxSize>
  • </BackupFile>
• </BackupFiles>

 

GetConnections 

Provides information about current Microsoft® SQL Server™ users and processes.
Connections: Connection list
UserOnly: List only user connections
After return, Connections will contain XML data in the following format:

• <Connections>
  • <Connection>
    • <ProcessID></ProcessID>
    • <ContextID></ContextID>
    • <Status></Status>
    • <Login></Login>
    • <Hostname></Hostname>
    • <BlockingProcess></BlockingProcess>
    • <Database></Database>
    • <Command></Command>
  • </Connection>
• </Connections>

 

GetDBProperties 

Reports information about a specified database.
DBProperties: Database property list
DBName: Database name
DBFiles: If true, report database's files
After return, DBProperties will contain XML data in the following format:

• <DBProperties>
  • <Name></Name>
  • <Size></Size>
  • <Owner></Owner>
  • <DateCreated></DateCreated>
  • <Level></Level>
  • <Status></Status>
  • <DBFiles>
    • <File>
    • <Name></Name>
    • <FileGroup></FileGroup>
    • <Size></Size>
    • <Path></Path>
    • <MaxSize></MaxSize>
    • <Growth></Growth>
    • <Usage></Usage>
    • </File>
  • </DBFiles>
• </DBProperties>

 

GetDBRoleMembers 

Returns information about the members of a role in the current database.
DBRole: Database role name
Members: Member list
After return, Members will contain XML data in the following format:

• <Members>
  • <Name></Name>
• </Members>

 

GetDBRoles 

Returns information about the roles in the current database.
After return, DBRoles will contain XML data in the following format:

• <DBRoles>
  • <Role>
    • <Name></Name>
    • <RoleID></RoleID>
    • <AppRole></AppRole>
  • </Role>
• </DBRoles>

 

GetLoginPassword 

Return encrypted password
Name: Login name 

GetLoginProperties 

Provides information about login and the associated users in each database.
LoginProperties: Login property list
LoginName: Login name
DBAccess: If true, report users and aliases associated with login name in each database
After return, LoginProperties will contain XML data in the following format:

• <Login>
  • <Name>
  • <DefaultDatabase>
  • <DefLangName></DefLangName>
  • <IsUser></IsUser>
  • <IsRemote></IsRemote>
  • <Databases>
    • <DATABASENAME>
      • <DBRole></DBRole> or
      • <UserName></UserName>
    • </DATABASENAME>
  • </Databases>
• </Login>

 

GetLogins 

Provides information about logins
LoginList: Login list
After return, LoginList will contain XML data in the following format:

• <Logins>
  • <Login>
    • <Name>
    • <DefaultDatabase>
    • <DefLangName></DefLangName>
    • <IsUser></IsUser>
    • <IsRemote></IsRemote>
  • </Login>
• </Logins>

 

GetPermissions 

Report information about user permissions for an object, in the current database.
Object: Object name
User: Database user name
Permissions: Permission list
After return, Permissions will contain XML data in the following format:

• <Permissions>
  • <Permission>
    • <Owner></Owner>
    • <Object></Object>
    • <Grantee></Grantee>
    • <Grantor></Grantor>
    • <Type></Type>
    • <Action></Action>
    • <Column></Column>
  • </Permission>
• <Permissions>

 

GetServerOS 

Return SQL Server™ version information. In addition to version information regarding the actual build number of the server, various environment information is also returned 

GetServerRoleMembers 

Returns information about the members of a Microsoft® SQL Server™ fixed server role. 

GetServerRoles 

Returns a list of the Microsoft® SQL Server™ fixed server roles. 

GetUsers 

Reports information about Microsoft® SQL Server™ users, Microsoft Windows NT® users, and database roles in the current database. 

GrantWindowLogins 

Allow or Deny a Microsoft® Windows NT® user or group account to connect to Microsoft SQL Server™ using Windows Authentication.
AccountInfos: Pointer to Array of TLoginInfo
Count: Number of array elements
This function uses LoginName, Option, Role members of TLoginInfo structure
LoginName: Windows User or group
Option: if true, deny access.
Role: If not empty, add login to Server role
 

HasAccessDatabases 

Lists the name and owner of all the databases to which the user has access. 

IsDeviceExist 

Check if backup device exists
DevName: Device name to check 

ListDatabases 

Lists databases that reside in an instance of Microsoft® SQL Server™ or are accessible through a database gateway
After return DatabaseList will contains XML data in the following format:

• <Databases>
  • <Database>
    • <Name></Name>
    • <Size></Size>
  • </Database>
• </Databases>

 

LoginPrompt 

Show login screen
If user click OK button to login: Create a Connection string and return mrOK 

RemoveWindowLogins 

Removes the login entries from Microsoft® SQL Server™ for a Microsoft Windows NT® user or group 

RestoreDBFiles 

Restore database files
DBName
DBFileList
DeviceName
DiskFile
BackupSetNumber
NewPathList 

RestoreDBLog 

Restore database log
DBName
DeviceName
DiskFile
BackupSetNumber
LogFileName
NewLogPath 

ServerInfo 

Report SQL server properties 

SetAppRole 

Activates the permissions associated with an application role in the current database.
AppRoleInfo: Pointer to TLoginInfo
Role: Application role
Password: Password
Option: If true, encrypt password before sending to Server 

SetDBRoleMembers 

Add/Remove security accounts as members of existing Microsoft® SQL Server™ database roles in the current database.
AccountInfos: Pointer to array of TLoginInfo
Role: Database role
Option: If true, remove user from database role
UserName: Database user name 

SetPermissions 

Creates an entry in the security system that allows a user in the current database to work with data in the current database
PermissionInfos: Pointer to array of TPermissionInfo
Count: Number of array elements
Permissions="INSERT, DELETE...
 

SetServerRoleMembers 

Add/Remove login as member of fixed server roles
AccountInfos: Pointer to array of TLoginInfo
Role: Database role
Option: If true, remove user from database role
UserName: Database user name 

ShrinkDBs 

Shrinks the size of the data files in the specified databases
DBNames: Database names
Percents: Pointer to array of int;
Is the desired percentage of free space left in the database file after the database has been shrunk 

Shutdown 

Shut down SQL server 

TerminateConnections 

Terminate connections 

TruncateDBLogs 

Truncate the transaction log 

UpdateProcessInfo 

Update ConnectionID, LoginName, DBUser, DBName, ServerName properties 

Property 

Description 

ComputerName 

Windows computer name 

ConnectionID 

PID number 

DatabaseName 

Current database name 

DBUser 

Database user name 

DisplayError 

Display error message 

LastError 

Last error message 

LoginName 

Login name or Windows account name 

ServerName 

SQL server name 

WindowsUserName 

Window user name 

 

Property 

 

read only 

 

Method