steam_ugc_query_set_return_total_only(ugc_query_handle , total_only);
| Argument | Description |
|---|---|
| ugc_query_handle | The query handle to use. |
| total_only | Whether to have the query return only the total number of hits or not. |
Returns: Boolean
This function can be used to further filter any given UGC query,
specifically to request only the number of results without any
other information (meaning that the DS map generated by the send
function will contain the key "num_results" without any further map
data). The query handle is the value returned when you created the
query (using, for example, steam_ugc_create_query_user())
and the second argument is either true or false.
The function will return true if the query filter was
correctly set, or false otherwise.
var query_handle =
steam_ugc_create_query_all(ugc_query_RankedByVote, ugc_match_Items,
1);
steam_ugc_query_set_return_total_only(query_handle, true);
steam_ugc_query_set_allow_cached_response(query_handle, true);
query_ID = steam_ugc_send_query(query_handle);
The above code creates a query request and stores it's handle in
a local variable for future use in the rest of the functions which
further define the query request before sending the query.