acp_data.c File : acp_data.c
Description : Active C Page Name/void * Data Structure
Category : ACP Scripting
Author : Charles Yates
This structure is used to propogate collections of name/void * pairs around
the system.
ACPDATA_Init ACPDATA DLLEXP ACPDATA_Init()
Function : ACPDATA_Init
Description : Creates an active c page data environment
Input : void
Output : void
Returns : ACPDATA - an empty acp data environment
ACPDATA_Set int DLLEXP ACPDATA_Set( ACPDATA env, char *name, void *value )
Function : ACPDATA_Set
Description : Appends or updates the name=value pair in the environment
Input : ACPDATA env - environment to update
char *name - property name
void *value - property value
Output : void
Returns : int - 0 is success, <> 0 is failure
ACPDATA_Count int DLLEXP ACPDATA_Count( ACPDATA env )
Function : ACPDATA_Count
Description : Returns the number of name/value pairs in the environment
Input : ACPDATA env - environment to query
Output : void
Returns : int - number of name value pairs
ACPDATA_Get void * DLLEXP ACPDATA_Get( ACPDATA env, char *name )
Function : ACPDATA_Get
Description : Returns value associated to name
Input : ACPDATA env - environment to query
char *name - name of property
Output : void
Returns : char * - address of value
ACPDATA_GetName char * DLLEXP ACPDATA_GetName( ACPDATA env, int index )
Function : ACPDATA_GetName
Description : Gets name at index
Input : ACPDATA env - environment to query
int index - index to query
Output : void
Returns : char * - address of name at index [or NULL if not found]
ACPDATA_GetValue void * DLLEXP ACPDATA_GetValue( ACPDATA env, int index )
Function : ACPDATA_GetValue
Description : Gets value at index
Input : ACPDATA env - environment to query
int index - index to query
Output : void
Returns : char * - address of value at index [or NULL if not found]
ACPDATA_Find int DLLEXP ACPDATA_Find( ACPDATA env, char *name )
Function : ACPDATA_Find
Description : Retrns the index containing name
Input : ACPDATA env - environment to query
char *name - name to find
Output : void
Returns : int - location of name in the environment
ACPDATA_Close void DLLEXP ACPDATA_Close( ACPDATA env )
Function : ACPDATA_Close
Description : Closes the environment
Input : ACPDATA env - environment to close
Output : env is closed
Returns : void
|