Function Summary

The C-language functions can be divided into several categories as identified in the table below.

C-language functions

Function Description
Initialization and housekeeping
aciInit Initializes the ACI API.
aciInitEncryption Initializes the encryption keys to use for subsequent ACI connections.
aciShutdown Cleans up at the end of an ACI client session.
aciObjectCreate Creates an ACI object.
aciObjectDestroy Destroys an ACI object.
aciObjectIsAlive Determines whether the object is alive.
aciObjectDeleteObject Deletes a single ACI object.
aciObjectGetVersion Returns the version string of ACI client.
aciClientFreeMemory Frees memory allocated with ACI client.
acioGetErrorDescription Returns an error description.
Execution
aciObjectExecute Executes an action.
aciObjectExecuteToString Executes an action to a string buffer.
aciObjectCheckForSuccess Determines whether the execution was successful.
Access
aciObjectParamSetString Sets a string parameter in an object.
aciOjbectParamSetStringN Sets a string parameter with a length.
aciObjectParamSetStringB Sets a binary data parameter with a length.
aciObjectParamSetFile Sets a file parameter in an object.
acioParamGetString Gets a string parameter in an object.
acioParamGetStringMoveOriginal Gets a string parameter in, and removes it from, an object.
aciObjectParamSetInt Sets an integer parameter in an object.
acioParamGetInt Gets an integer parameter in an object.
aciObjectParamSetUnsignedInt Sets an unsigned integer parameter in an object.
acioParamGetUnsignedInt Gets an unsigned integer parameter in an object.
aciObjectParamSetLong Sets a long parameter in an object.
acioParamGetLong Gets a long parameter in an object.
aciObjectParamSetBool Sets a boolean parameter in an object.
acioParamGetBool Gets a boolean parameter in an object.
aciObjectParamSetDouble Sets a double parameter in an object.
acioParamGetDouble Gets a double parameter in an object.
aciErrorStatusCreate Creates an error status structure.
aciErrorStatusDestroy Destroys an error status structure.
aciErrorStatusReset Resets an error status structure.
aciResponseGetErrorStatus Extracts error status information.
acioGetFirstVariable Accesses the parameter list of an ACI object.
acioGetNextVariable Accesses the next variable (parameter) in the list after the one passed in.
acioGetVariableName Accesses the name of an ACI object variable.
acioGetVariableValue Accesses the value of an ACI object variable.
Search and iteration
aciObjectFirstEntry Locates the first child entry of a result.
aciObjectNextEntry Locates the next child entry of a result.
acioNextNamedEntry Locates the next child entry of a result that matches the name.
aciObjectParentEntry Returns a pointer to the parent entry of the object.
acioFindFirstOccurrence Locates the first occurrence of a tag.
acioFindFirstOccurrenceFromRoot Locates the first occurrence of a tag.
acioFindFirstEnclosedOccurrence
FromRoot
Locates the first occurrence of a tag from the object's immediate children.
aciObjectToString Prints an ACI object.
acioGetTagValue Obtains the value of a tag.
aciObjectGetTagValueWithDefault Obtains the value of a tag.
acioGetValue Obtains the content from an ACI object.
acioGetName Obtains the name of an ACI object.
aciObjectToXMLString Converts an ACI object to XML format.
aciObjectToXMLStringNoFormat Converts an ACI object to XML without any formatting.
aciObjectAddAttribute Adds an aciObjectVariable to the object's attribute linked list.
aciObjectAttributeGetNames Populates an array of strings with the names of all the attributes of the XML tag represented by the object.
aciObjectAttributeGetNamesAnd
ValuesNoCopy
Retrieves an array of attribute names and values of an ACI object.
acioAttributeGetValue Gets the value of an attribute.
aciObjectResponseToStringArray Returns all values of a tag in an ACI response object.
Security
aciObjectSetSecurityKeys Sets the security keys.
aciObjectSetUserSecurityInfo Sets the user-level security for documents.