Functions to get and set metadata for a particular part.

Collaboration diagram for Functions to get and set metadata for a particular part.:

Modules
	Required Attribute Utililities
	These are a group of functions for attributes that are required to be in every part of every file.
	Attribute utilities for builtin types
	These are a group of functions for attributes that use the builtin types.

Typedefs
typedef enum exr_attr_list_access_mode	exr_attr_list_access_mode_t

Enumerations
enum	exr_attr_list_access_mode { EXR_ATTR_LIST_FILE_ORDER, EXR_ATTR_LIST_SORTED_ORDER }

Functions
EXR_EXPORT exr_result_t	exr_get_attribute_count (exr_const_context_t ctxt, int part_index, int32_t *count)
	Query the count of attributes in a part. More...
EXR_EXPORT exr_result_t	exr_get_attribute_by_index (exr_const_context_t ctxt, int part_index, exr_attr_list_access_mode_t mode, int32_t idx, const exr_attribute_t **outattr)
	Query a particular attribute by index. More...
EXR_EXPORT exr_result_t	exr_get_attribute_by_name (exr_const_context_t ctxt, int part_index, const char *name, const exr_attribute_t **outattr)
	Query a particular attribute by name. More...
EXR_EXPORT exr_result_t	exr_get_attribute_list (exr_const_context_t ctxt, int part_index, exr_attr_list_access_mode_t mode, int32_t *count, const exr_attribute_t **outlist)
	Query the list of attributes in a part. More...
EXR_EXPORT exr_result_t	exr_attr_declare_by_type (exr_context_t ctxt, int part_index, const char *name, const char *type, exr_attribute_t **newattr)
EXR_EXPORT exr_result_t	exr_attr_declare (exr_context_t ctxt, int part_index, const char *name, exr_attribute_type_t type, exr_attribute_t **newattr)
	Declare an attribute within the specified part. More...

Detailed Description

Typedef Documentation

typedef enum exr_attr_list_access_mode exr_attr_list_access_mode_t

Enumeration Type Documentation

enum exr_attr_list_access_mode

Enumerator
EXR_ATTR_LIST_FILE_ORDER	Order they appear in the file
EXR_ATTR_LIST_SORTED_ORDER	Alphabetically sorted

Definition at line 248 of file openexr_part.h.

Function Documentation

EXR_EXPORT exr_result_t exr_attr_declare	(	exr_context_t	ctxt,
		int	part_index,
		const char *	name,
		exr_attribute_type_t	type,
		exr_attribute_t **	newattr
	)

Declare an attribute within the specified part.

Only valid when a file is opened for write.

EXR_EXPORT exr_result_t exr_attr_declare_by_type	(	exr_context_t	ctxt,
		int	part_index,
		const char *	name,
		const char *	type,
		exr_attribute_t **	newattr
	)

Declare an attribute within the specified part.

Only valid when a file is opened for write.

EXR_EXPORT exr_result_t exr_get_attribute_by_index	(	exr_const_context_t	ctxt,
		int	part_index,
		exr_attr_list_access_mode_t	mode,
		int32_t	idx,
		const exr_attribute_t **	outattr
	)

Query a particular attribute by index.

EXR_EXPORT exr_result_t exr_get_attribute_by_name	(	exr_const_context_t	ctxt,
		int	part_index,
		const char *	name,
		const exr_attribute_t **	outattr
	)

Query a particular attribute by name.

EXR_EXPORT exr_result_t exr_get_attribute_count	(	exr_const_context_t	ctxt,
		int	part_index,
		int32_t *	count
	)

Query the count of attributes in a part.

EXR_EXPORT exr_result_t exr_get_attribute_list	(	exr_const_context_t	ctxt,
		int	part_index,
		exr_attr_list_access_mode_t	mode,
		int32_t *	count,
		const exr_attribute_t **	outlist
	)

Query the list of attributes in a part.

This retrieves a list of attributes currently defined in a part.

If outlist is NULL, this function still succeeds, filling only the count. In this manner, the user can allocate memory for the list of attributes, then re-call this function to get the full list.