Input object passed to sakeGetRandomRecord.

typedef struct 

{

char * mTableId;

char ** mFieldNames;

int mNumFields;

char * mFilter;

} SAKEGetRandomRecordInput;

Members

mTableId

Points to the tableid of the table to be searched.

mFieldNames

Points to an array of strings, each of which contains the name of a field for which to return values. This list controls the values which will be returned as part of the response. The array can contain just one field name, the names of all the fields in the table, or any subset of the field names.

mNumFields

Stores the number of strings in the mFieldNames array.

mFilter

SQL-like filter string which is used to filter which records are to be looked at when choosing a random record. Note that if the search criteria is too specific and no records are found, then the output will return no random record. Note that a field can be used in the filter string even if it is not listed in the mFieldNames array, and that file metadata fields can be used in a filter string.

Remarks

In addition to the fields which the developer defines, you can also request values for the “recordid” field, “ownerid” field (if the table has an owner type of profile), and “num_ratings” and “average_rating” fields (if the table has its ratings option set to true).

See Appendix II in the Overview for more information on special fields used in Sake.

Section Reference: Gamespy Sake SDK

See Also: sakeGetRandomRecord