ArrayType.h File Reference

Defines array types. More...

#include "Export.h"
#include "Version.h"

Include dependency graph for ArrayType.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	VPIArrayType
	Array element formats. More...

Functions
const char *	vpiArrayTypeGetName (VPIArrayType type)
	Returns a string representation of the array type. More...
int	vpiArrayTypeGetSize (VPIArrayType type)
	Returns the size in bytes of each array element with the given type. More...

Detailed Description

Defines array types.

Definition in file ArrayType.h.

Function Documentation

vpiArrayTypeGetName()

const char* vpiArrayTypeGetName

(

VPIArrayType

type

)

Returns a string representation of the array type.

Parameters

[in]

type

Array type whose name is to be returned.

Returns

The string representation of the image type. Returned string is valid until next call of this function from the same calling thread. Returned pointer must not be freed.

vpiArrayTypeGetSize()

int vpiArrayTypeGetSize

(

VPIArrayType

type

)

Returns the size in bytes of each array element with the given type.

Parameters

[in]

type

The array type to be queried. The array type must be valid.

Returns

The size in bytes of the array type.

Return values

0	An invalid array type was given.