Specifications

MDR User Guide 45
8 MDR API Functions
To communicate with the MDR Server, the user has the possibility to use either the
MDR Shell or his own program linked with the MDR API library, the MDR Shell
program including the MDR API library.
The API functions are implemented as C++ functions that can be used in C++ programs.
Below is an alphabetic list of all the MDR API functions available:
Name Description
AddDisksToDiskGroup
Add a list of disks to a disk group
AllocateMemory
Allocate memory buffer
ClearDiskInfo
Clear the disk group information on a list of disks
ClearRecordingTable
Clear the recording table
ConnectToDiskGroup
Connect to a disk group
ConnectedToDiskGroup
Check a disk group connection
ConnectToServer
Set up an MDR client/server connection
ConnectedToServer
Check an MDR client/server connection
CopyRecording
Copy a recording
CreateDiskGroup
Create a new disk group
CreateNewRecording
Create a new recording
DeleteDiskGroup
Delete a disk group
DeleteRecording
Delete a recording
DisconnectFromDiskGroup
Disconnect from a disk group
DisconnectFromServer
Disconnect from the MDR server(s)
DiskSpeedTest
Test the MDR recording speed
FormatDisk
Format a disk
FreeMemory
Free memory buffer
GetDiskGroupName
Get the name of the current disk group
GetRecordingInfo
Get information from a recording
GetRecordingsInfo
Get information from all recordings
GetRecordingTableInfoString
Get the recording table information (as a string)
GetRecTableInfo
Get the recording table information
GetServerName
Get the server name
GetServerStatus
Get the server status
PrepareTransfer
Prepare a transfer
ReadRecorderBlock
Read block(s) from the storage device
ReadRecordingBlock
Read block(s) of a recording
RemoveDisksFromDiskGroup
Remove a list of disks from a disk group
ResetServer
Reset the MDR server(s)
Scan
Scan for fibre channel devices (disks and disk groups)
SelfTest
Test the MDR server system
SetRecordingInfo
Set information to a recording
SetRecTableInfo
Set the recording table information
StartTransfer
Start a transfer
StopTransfer
Stop a transfer
WaitTransfer
Wait for the current transfer to finish
WriteRecorderBlock
Write block(s) to the storage device
WriteRecordingBlock
Write block(s) of a recording
8.1 Header Files
In order to add the API functions into a C++ program, some MDR header files, located
in the
mdr-host-sw/include directory, have to be included. Some dependencies
already exist between these files. Therefore, it is not required to add all the MDR header
files but only those that are directly needed by the user’s program.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com