Retrieve compound records from a cursor.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function compoundNext( _ ByVal cursor As NetricsTableCursor _ ) As NetricsCompoundRecord() |
| C# |
|---|
| public NetricsCompoundRecord[] compoundNext( NetricsTableCursor cursor ) |
| C++ |
|---|
| public: array<NetricsCompoundRecord>^ compoundNext( NetricsTableCursor cursor ) sealed |
| J# |
|---|
| public NetricsCompoundRecord[] compoundNext( NetricsTableCursor cursor ) |
| JScript |
|---|
| public
function compoundNext( cursor : NetricsTableCursor ) : NetricsCompoundRecord[] |
Parameters
- cursor
- The cursor being used to scan the table.
Return Value
An array of NetricsCompoundRecords, the next batch from the cursor. The cursor position is updated.
Exceptions
| Exception Type | Condition |
|---|---|
| NetricsException | If the server indicates that an error has occured (Possible errors - TBLNOTFOUND) |
| IOException | If an I/O error occurs |
| ArgumentException | if parent_table is not a parent table, of if any child table is not a child of parent_table, or if a duplicate name exists in the child_tables list. |
Remarks
This method is used to retrieve compound records from a table cursor. A compound record consists of a parent record and all child records linked to that parent record. The cursor scans the parent table, and fetches all child records of the parent records returned to produce the compound records returned.