Write an entire variable. More...

Collaboration diagram for ioda_variable_write_full:

Macros
#define	IODA_VARIABLE_WRITE_FULL_TEMPLATE(funcnamestr, Type) IODA_DL bool funcnamestr(struct ioda_variable* var, size_t sz, const Type* vals);
	See ioda_variable_write_full . More...

Functions
	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_write_full, IODA_VARIABLE_WRITE_FULL_TEMPLATE)

IODA_DL bool	ioda_variable_write_full_str (struct ioda_variable var, size_t sz, const char const *vals)
	Write a sequence of strings to a variable. More...

Detailed Description

Write an entire variable.

This is documentation for a series of functions in C that attempt to emulate C++ templates using macro magic. The template parameter SUFFIX is written into the function name. Ex:, to write an integer variable, call ioda_variable_write_full_int. To write a float variable, try ioda_variable_write_full_float.

Template Parameters

SUFFIX is the type (int, long, int64_t) that is appended to this function name in the C interface.

Parameters

var	is the variable.

Returns: true on success, false on failure.

Macro Definition Documentation

◆ IODA_VARIABLE_WRITE_FULL_TEMPLATE

#define IODA_VARIABLE_WRITE_FULL_TEMPLATE	(	funcnamestr,
		Type
	)	IODA_DL bool funcnamestr(struct ioda_variable* var, size_t sz, const Type* vals);

See ioda_variable_write_full .

See also: ioda_variable_write_full

Definition at line 205 of file Variable_c.h.

Function Documentation

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR()

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_variable_write_full	,
		IODA_VARIABLE_WRITE_FULL_TEMPLATE
	)

◆ ioda_variable_write_full_str()

IODA_DL bool ioda_variable_write_full_str	(	struct ioda_variable *	var,
		size_t	sz,
		const char const	vals
	)

Write a sequence of strings to a variable.

Parameters

[in]	var	is the variable.
	sz	is the number of strings to write. For ioda_variable_write_full_str, this must match var's current number of elements.
[in]	vals	is a sequence of sz NULL-terminated strings.

Returns: true on success.; false on failure.

Precondition: var must be a valid string-typed variable.; sz must equal the variable's current number of elements.; vals must be valid and have at least length sz.; Each val in vals must be a NULL-terminated string. Each val must not be NULL itself.

Definition at line 157 of file Variable_c.cpp.

Here is the call graph for this function: