Skip to content
Troy Davisson edited this page Mar 5, 2016 · 2 revisions

Note: This page documents capabilities available in the older 1.x version. Please see this repository's README file for the new 2.x version documentation.

TotalRecordsFound

TotalRecordsFound ( [ string $pointer_id ] )

Returns number of records server says matches query from previous SearchQuery(). If your SearchQuery() request included Count=1, this number may just be the number of records returned in the response or may be the total number of records that match your query (caused by an ambiguity in the RETS specification and dependant on server implementor). SearchQuery() with Count=0 will not return this value. SearchQuery() with Count=2 will return a value representing all matching records with no records.

Parameters

$pointer_id - The returned value from SearchQuery(). If not given, defaults to last SearchQuery() pointer

Return Value

Integer

Represents 'Count' reported by server. See description above for ambiguity.

Changelog

1.0rc2 - Made $pointer_id a parameter that can be passed

Usage Examples
<?php
if ($rets->TotalRecordsFound() > 1000) {
        // server reports more than 1000
}
Related To

SearchQuery, IsMaxrowsReached, NumRows