sieve_get_arg_as_string

March 26, 2020 Contributors

Name

sieve_get_arg_as_string — Return the specified argument as a string

Synopsis

#include "sieve/ecsieve.h"

| int **sieve_get_arg_as_string** ( | args, |   |
|   | n, |   |
|   | str, |   |
|   | len); |   |

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

Description

Return the argument at the specified zero-based index as a string.

Parameters

args

The argument list.

n

Which argument to examine, indexed from 0.

str

The pointer to the returned string.

len

The length of the string.

Return Values

On success this function returns 1; on failure 0.

Threading

It is legal to call this function in any thread.

See Also

Section 68.76, “SIEVEARGS (sieve_ast)”