StringArray Struct Reference

An array of string data. More...

#include <aida_pva_types.h>

Data Fields
int	count
	The number of items in this array. More...
char **	items
	The items in this array - pointers to the strings you allocate. More...

Detailed Description

An array of string data.

This is used to return an array of string data to the client.

When you are implementing an API that returns an array of strings you need to fill an StringArray structure appropriately. Fill the count member with the number of elements in the array. Allocate memory for those items and set the items member to that pointer. The items will be a char ** meaning that it will be an array of character pointers, and each of the strings MUST be allocated as well. This is because the framework will automatically free up strings for you as well as the items pointer itself.

Definition at line 193 of file aida_pva_types.h.

Field Documentation

count

int count

The number of items in this array.

Definition at line 195 of file aida_pva_types.h.

Referenced by aidaRequestStringArray(), releaseStringArray(), and toStringArray().

items

char** items

The items in this array - pointers to the strings you allocate.

Definition at line 196 of file aida_pva_types.h.

Referenced by aidaRequestStringArray(), releaseStringArray(), and toStringArray().

---

The documentation for this struct was generated from the following file:

• root/cpp/include/aida_pva_types.h