Skip to content

Navigation Menu

Sign in
Sign up

A2S_RULES

Binary edited this page Dec 1, 2024 · 3 revisions

Synopsis

Emitting A2S_RULES server queries.

Example

#include <ssq/a2s.h>
// See the `SSQ_SERVER' wiki page.
SSQ_SERVER *server;
uint16_t rule_count;
A2S_RULES *rules = ssq_rules(server, &rule_count);
/* Success */
if (ssq_server_eok(server)) {
 printf("There are %hu rules:\n", rule_count);
 for (uint16_t i = 0; i < rule_count; ++i)
 printf("%s = %s\n", rules[i].name, rules[i].value);
 /* Cleanup */
 ssq_rules_free(rules, rule_count);
}
/* Failure */
if (!ssq_server_eok(server)) {
 fprintf(stderr, "ssq_rules: %s\n", ssq_server_emsg(server));
 /* Cleanup */
 ssq_server_eclr(server);
}

Fields

Identifier Type Description
name char * Name of the rule
name_len size_t Length of the name string
value char * Value of the rule
value_len size_t Length of the value field

Functions

ssq_rules

Retrieves server rules, or configuration variables in name/value pairs.

Parameters

Name Type Nullable Description
server SSQ_SERVER * Source server instance to query
rule_count uint16_t * Number of rules in the response

Return value

Returns an A2S_RULES response array of length *rule_count which must be freed using ssq_rules_free.

⚠️ In case there are no rules in the response, returns NULL.

⚠️ In case of an error, returns NULL and updates the last error of server.

ssq_rules_free

Frees an A2S_RULES response array returned by ssq_rules.

Parameters

Name Type Nullable Description
rules A2S_RULES * A2S_RULES response array to free
rule_count uint16_t Number of rules in the array

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /