steam_ugc_query_set_search_text(ugc_query_handle , search_text);
Argument | Description |
---|---|
ugc_query_handle | The query handle to use. |
search_text | The search text to use (a string) for the query. |
Returns: Boolean
This function can be used to further filter any given UGC query, specifically to search for the given string in the title and description of the UGC items. 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 a string you want to use as the search term. 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_search_text(query_handle, "texture");
steam_ugc_query_set_return_long_description(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.