kzu_array_property.h File Reference

Specifies property that holds multiple properties. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Macros
#define	KZU_ARRAY_PROPERTY_TYPE_UNLIMITED_SIZE
	Unlimited size for array property. More...

Functions
kzsError	kzuArrayPropertyTypeCreate (const struct KzcMemoryManager *memoryManager, kzString name, const struct KzuPropertyType *childPropertyType, kzInt elementCount, struct KzuArrayPropertyType **out_arrayPropertyType)
	Creates a new array property type. More...
kzsError	kzuArrayPropertyTypeDelete (struct KzuArrayPropertyType *arrayPropertyType)
	Deletes array property type. More...
kzsError	kzuArrayPropertyTypeLoadFromKzb (struct KzuArrayPropertyType *arrayPropertyType, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads string property type from KZB. More...
struct KzuArrayPropertyType *	kzuArrayPropertyTypeFromPropertyType (const struct KzuPropertyType *propertyType)
	Returns array property type from property type. More...
struct KzuPropertyType *	kzuArrayPropertyTypeToPropertyType (const struct KzuArrayPropertyType *arrayPropertyType)
	Converts array property type to property type. More...
struct KzuPropertyType *	kzuArrayPropertyTypeGetChildPropertyType (const struct KzuArrayPropertyType *arrayPropertyType)
	Gets the child property type from array property type. More...
void	kzuArrayPropertyTypeSetChildPropertyType (struct KzuArrayPropertyType *arrayPropertyType, const struct KzuPropertyType *childPropertyType)
	Sets child property type for array property type. More...
kzInt	kzuArrayPropertyTypeGetElementCount (const struct KzuArrayPropertyType *arrayPropertyType)
	Gets the number of elements from array property type, or -1 for unlimited. More...

Detailed Description

Specifies property that holds multiple properties.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_ARRAY_PROPERTY_TYPE_UNLIMITED_SIZE

Unlimited size for array property.

This can be used as the elementCount for kzuArrayPropertyTypeCreate().

Function Documentation

kzsError kzuArrayPropertyTypeCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		const struct KzuPropertyType *	childPropertyType,
		kzInt	elementCount,
		struct KzuArrayPropertyType **	out_arrayPropertyType
	)

Creates a new array property type.

Parameters

elementCount

Number of elements in the array or KZU_ARRAY_PROPERTY_TYPE_UNLIMITED_SIZE for unlimited.

kzsError kzuArrayPropertyTypeDelete

(

struct KzuArrayPropertyType *

arrayPropertyType)

Deletes array property type.

kzsError kzuArrayPropertyTypeLoadFromKzb	(	struct KzuArrayPropertyType *	arrayPropertyType,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads string property type from KZB.

struct KzuArrayPropertyType* kzuArrayPropertyTypeFromPropertyType

(

const struct KzuPropertyType *

propertyType)

Returns array property type from property type.

struct KzuPropertyType* kzuArrayPropertyTypeToPropertyType

(

const struct KzuArrayPropertyType *

arrayPropertyType)

Converts array property type to property type.

struct KzuPropertyType* kzuArrayPropertyTypeGetChildPropertyType

(

const struct KzuArrayPropertyType *

arrayPropertyType)

Gets the child property type from array property type.

void kzuArrayPropertyTypeSetChildPropertyType	(	struct KzuArrayPropertyType *	arrayPropertyType,
		const struct KzuPropertyType *	childPropertyType
	)

Sets child property type for array property type.

kzInt kzuArrayPropertyTypeGetElementCount

(

const struct KzuArrayPropertyType *

arrayPropertyType)

Gets the number of elements from array property type, or -1 for unlimited.