1 << 0 is reserved for virDomainModificationImpact 1 << 1 is reserved for virDomainModificationImpact Older servers lacked the ability to handle string typed parameters. Attempts to set a string parameter with an older server will fail at the client, but attempts to retrieve parameters must not return strings from a new server to an older client, so this flag exists to identify newer clients to newer servers. This flag is automatically set when needed, so the user does not have to worry about it; however, manually setting the flag can be used to reject servers that cannot return typed strings, even if no strings would be returned.

Type for a callback cleanup function to be paired with a callback. This function will be called as a final chance to clean up the @opaque registered with the primary callback, at the time when the primary callback is deregistered.

It is forbidden to call any other libvirt APIs from an implementation of this callback, since it can be invoked from a context which is not re-entrant safe. Failure to abide by this requirement may lead to application deadlocks or crashes.

Adds new parameter called @name with boolean type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with double type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with the requested @type and parses its value from the @value string. If the requested type is string, the function creates its own copy of the @value string, which needs to be freed using virTypedParamsFree or virTypedParamsClear. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with long long int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with char * type and sets its value to @value. The function creates its own copy of @value string, which needs to be freed using virTypedParamsFree or virTypedParamsClear. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with unsigned int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Adds new parameter called @name with unsigned long long type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with VIR_ERR_INVALID_ARG error if the parameter already exists in @params.

params

pointer to the array of typed parameters

nparams

number of parameters in the @params array

maxparams

maximum number of parameters that can be stored in @params array without allocating more memory

Finds typed parameter called @name and store its boolean value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its double value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its int value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its long long int value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its char * value in @value. The function does not create a copy of the string and the caller must not free the string @value points to. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its unsigned int value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.

Finds typed parameter called @name and store its unsigned long long int value in @value. The function fails with VIR_ERR_INVALID_ARG error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.

params

array of typed parameters

nparams

number of parameters in the @params array

name

name of the parameter to find

value

where to store the parameter's value

Returns

1 on success, 0 when the parameter does not exist in @params, or -1 on error.