sieve_arg_as_string

March 26, 2020 Contributors

Name

sieve_arg_as_string — Get the specified argument as a string

Synopsis

#include "sieve/ecsieve.h"

| int **sieve_arg_as_string** ( | args, |   |
|   | str, |   |
|   | len); |   |

SIEVEARGS * <var class="pdparam">args</var>;
char ** <var class="pdparam">str</var>;
int * <var class="pdparam">len</var>;

Description

Get the specified argument as a ‘string’. Note: This returns a character array and not an ec_string.

Parameters

args

The Sieve argument(s). For a definiton of this data type see structs.sieve_ast.

str

The character array.

len

The length of the string.

Return Values

This function returns 1 on success and 0 on failure.

Threading

It is legal to call this function in any thread.