Share via


RecordsToRetrieve Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Gets or sets the number of records to return from the search.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Property RecordsToRetrieve As Integer
'Usage
Dim instance As CommonSearchOptions
Dim value As Integer

value = instance.RecordsToRetrieve

instance.RecordsToRetrieve = value
public int RecordsToRetrieve { get; set; }
public:
property int RecordsToRetrieve {
    int get ();
    void set (int value);
}
public function get RecordsToRetrieve () : int
public function set RecordsToRetrieve (value : int)

Property Value

Type: System..::.Int32
The number of records to retrieve.

Exceptions

Exception Condition
ArgumentOutOfRangeException

The supplied value is less than -1.

Remarks

A value of -1 indicates that RecordsToRetrieve should get or set all records. The first record is record number one (1). You can set this property to page through the search results.

Permissions

See Also

Reference

CommonSearchOptions Class

CommonSearchOptions Members

Microsoft.CommerceServer.Catalog Namespace