Parameter Modification

Parameter modification methods. More...

Collaboration diagram for Parameter Modification:

Functions
void	Recognition::Magic::SetParameter (Parameters parameter, std::size_t value)
	Set a single parameter value.
bool	Recognition::Magic::SetParameter (Parameters parameter, std::size_t value, const std::nothrow_t &tag) noexcept
	Set a single parameter value (noexcept version).
void	Recognition::Magic::SetParameters (const ParameterValueMapT &parameters)
	Set multiple parameter values.
bool	Recognition::Magic::SetParameters (const ParameterValueMapT &parameters, const std::nothrow_t &tag) noexcept
	Set multiple parameter values (noexcept version).

Detailed Description

Parameter modification methods.

Methods for changing libmagic parameter values.

Function Documentation

SetParameter() [1/2]

void Recognition::Magic::SetParameter	(	Parameters	parameter,
		std::size_t	value )

Set a single parameter value.

Parameters

[in]	parameter	The parameter to modify.
[in]	value	The new value for the parameter.

Exceptions

MagicIsClosed	If the Magic instance is closed.
MagicSetParameterError	If setting the parameter fails.

// Limit file scanning to 1MB for performance
magic.SetParameter(Magic::Parameters::BytesMax, 1024 * 1024);

See also

Parameters

GetParameter()

Since

10.0.0

Examples

magic_examples.cpp.

SetParameter() [2/2]

bool Recognition::Magic::SetParameter ( Parameters parameter, std::size_t value, const std::nothrow_t & tag )

nodiscardnoexcept

Set a single parameter value (noexcept version).

Parameters

[in]	parameter	The parameter to modify.
[in]	value	The new value for the parameter.
[in]	tag	Pass std::nothrow to select this overload.

Returns

true on success, false on failure.

Since

10.0.0

SetParameters() [1/2]

void Recognition::Magic::SetParameters

(

const ParameterValueMapT &

parameters

)

Set multiple parameter values.

Parameters

[in]

parameters

Map of parameters to their new values.

Exceptions

MagicIsClosed	If the Magic instance is closed.
MagicSetParameterError	If setting any parameter fails.

magic.SetParameters({
    {Magic::Parameters::BytesMax, 1024 * 1024},
    {Magic::Parameters::RegexMax, 4096}
});

See also

ParameterValueMapT

GetParameters()

Since

10.0.0

Examples

magic_examples.cpp.

SetParameters() [2/2]

bool Recognition::Magic::SetParameters ( const ParameterValueMapT & parameters, const std::nothrow_t & tag )

nodiscardnoexcept

Set multiple parameter values (noexcept version).

Parameters

[in]	parameters	Map of parameters to their new values.
[in]	tag	Pass std::nothrow to select this overload.

Returns

true on success, false on failure.

Since

10.0.0