DataRecordset.GetDataRowIDs Method

Gets an array of the IDs of all the rows in the data recordset.

Note
This Visio object or member is available only to licensed users of Microsoft Office Visio Professional 2007.

Version Information
 Version Added:  Visio 2007

Syntax

expression.GetDataRowIDs(CriteriaString)

expression   An expression that returns a DataRecordset object.

Parameters

Return Value
Long()

Remarks

You can use the GetDataRowIDs method to get an array of the IDs of all the rows in a data recordset, where each row represents a single data record. The GetDataRowIDs method takes as its parameter a criteria string, which is a string that conforms to the guidelines specified in the ADO API for setting the ADO.Filter property. By specifying appropriate criteria and using AND and OR operators to separate clauses, you can filter the information in the data recordset to return only certain data recordset rows selectively. To apply no filter (that is, to get all the rows), pass an empty string ("").

For more information about criteria strings, see Filter Property in the ADO 2.8 API Reference.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how you can use the GetDataRowIDs and GetRowData methods to return the row ID of each row and then get the data stored in each column in every row of the specified data recordset. The macro gets the count of all data recordsets associated with the current document and gets row data for the one most recently added. It iterates through all the rows in the data recordset and then, for each row, iterates through all the columns in that row. The code displays the information returned in the Immediate window.

Before running this macro, create at least one data recordset in the current document.

Note that the macro passes an empty string to the GetDataRowIDs method to bypass filtering and get all the rows in the recordset. After you run the macro, note that the first set of data shown (corresponding to the first data row) contains the headings for all the data columns in the data recordset.

  Public Sub GetDataRowIDs_Example()
Dim vsoDataRecordset As Visio.DataRecordset
Dim intCount As Integer
Dim lngRowIDs() As Long
Dim lngRow As Long
Dim lngColumn As Long
Dim varRowData As Variant

'Get the count of all data recordsets in the current document.
intCount = ThisDocument.DataRecordsets.Count

Set vsoDataRecordset = ThisDocument.DataRecordsets(intCount)

'Get the row IDs of all the rows in the data recordset
lngRowIDs = vsoDataRecordset.GetDataRowIDs("")

'Iterate through all the records in the data recordset.
For lngRow = LBound(lngRowIDs) To UBound(lngRowIDs) + 1
    varRowData = vsoDataRecordset.GetRowData(lngRow)

    'Print a separator between rows
    Debug.Print "------------------------------"

   'Print the data stored in each column of a particular data row.
    For lngColumn = LBound(varRowData) To UBound(varRowData)
        Debug.Print varRowData(lngColumn)
    Next lngColumn
Next lngRow

End Sub

See Also

• DataRecordset Object
• DataRecordset Object Members