rifImageFilterSetParameterString

Used to set string parameter value for a specified parameter of the filter.

rif_int rifImageFilterSetParameterString(

rif_image_filter image_filter,

rif_char const * name,

rif_char const * val);

Parameters

Parameter

Input/Output

Description

image_filter

input

A valid image filter object.

name

input

The name of the filter parameter for which the value will be changed.

val

input

A string value.

Return

Returns RIF_SUCCESS in case of success, or RIF_ERROR code if a problem was encountered.

Errors

Possible error codes:

  • RIF_ERROR_INVALID_FILTER — image_filter is not a valid image filter object.

  • RIF_ERROR_INVALID_FILTER_ARGUMENT_NAME — a parameter with the specified name is not associated with this type of filter.

  • RIF_ERROR_INVALID_PARAMETER_TYPE — the specified filter parameter is not of type four-component float vector.