sieve_get_type_of_arg

March 26, 2020 Contributors

Name

sieve_get_type_of_arg — Return the type of a Sieve argument

Synopsis

#include "sieve/ecsieve.h"

| enum sieve_arg_type **sieve_get_type_of_arg** ( | arg); |   |

SIEVEARGS * <var class="pdparam">arg</var>;

Description

Return the type of a Sieve argument.

The type of a Sieve argument may not be known at compile time. Use this function to find out the type of argument returned by sieve_parse_args and its "%", "@" or "*" placeholders. Use this function with caution during compile callbacks in extensions.

Parameters

arg

The argument list.

Return Values

This function returns one of the SIEVEARG_* constants. These constants are:

/* accessors for sieve args */
enum sieve_arg_type {
  SIEVEARG_BOGUS = 0,
  SIEVEARG_IS_STRING,
  SIEVEARG_IS_NUMBER,
  SIEVEARG_IS_STRINGLIST,
  SIEVEARG_IS_HASH,
  SIEVEARG_IS_TAG
};

Threading

It is legal to call this function in any thread.

See Also

Section 68.76, “SIEVEARGS (sieve_ast)” and sieve_get_arg_type