Dump the records of the specified table.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function dump( _ ByVal tblName As String, _ ByVal l As NetricsLock _ ) As NetricsTable |
| C# |
|---|
| public NetricsTable dump( string tblName, NetricsLock l ) |
| C++ |
|---|
| public: NetricsTable dump( String tblName, NetricsLock l ) sealed |
| J# |
|---|
| public NetricsTable dump( string tblName, NetricsLock l ) |
| JScript |
|---|
| public
function dump( tblName : String, l : NetricsLock ) : NetricsTable |
Parameters
- tblName
- The name of the table to dump
- l
- A NetricsLock object which will pass the lock key to the table. If the table is locked with a lock key and this parameter is not passed with the matchine key, the operation will fail.
Return Value
A NetricsTable object representing the table. The returned table object does not include any index information, so it can't be used to recreate the table.
Exceptions
| Exception Type | Condition |
|---|---|
| NetricsException | If the server indicates that an error has occured (Possible errors - TBLLOCKED, TBLNOTFOUND, EXPECTTBLDESC, NOTBLDESC, PARAMVAL, SHUTDOWN) |
Remarks
The tables record's can be accessed through the NetricsTable's NetricsTableRecSrc object. The NetricsTable can be loaded into another server using the tblload command.
Note: This method will NOT delete the table.