Read an entire variable. More...

Collaboration diagram for ioda_variable_read_full:

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

Functions
	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_read_full, IODA_VARIABLE_READ_FULL_TEMPLATE)

IODA_DL struct ioda_string_ret_t *	ioda_variable_read_full_str (const struct ioda_variable *var)
	Read strings from a variable. More...

Detailed Description

Read 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 read an integer variable, call ioda_variable_read_full_int. To read a float variable, try ioda_variable_read_full_float.

Template Parameters

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

Parameters

[in]	var	is the variable.
	sz	is the size of the output buffer vals. Must match the number of elements in var.
[out]	vals	is the output buffer.

Returns: true on success, false on failure.

Precondition: sz must match the current number of elements in the variable.; var and vals must be valid.

Macro Definition Documentation

◆ IODA_VARIABLE_READ_FULL_TEMPLATE

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

See ioda_variable_read_full .

See also: ioda_variable_read_full

Definition at line 247 of file Variable_c.h.

Function Documentation

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR()

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_variable_read_full	,
		IODA_VARIABLE_READ_FULL_TEMPLATE
	)

◆ ioda_variable_read_full_str()

IODA_DL struct ioda_string_ret_t* ioda_variable_read_full_str ( const struct ioda_variable * var )

Read strings from a variable.