Constants

The constants that are used in the C language SDK are outlined in the following table.

Constants used in C-language functions

Constant Description
ACI_COMMAND Indicates that you want to create an ACI_COMMAND type ACI object. This constant is used by only the aciObjectCreate function.
ACI_COM_COMMAND Indicates that the specified parameter is an action command. This constant is used by only the aciObjectParamSetString function on an ACI_COMMAND type ACI object.
ACI_COM_USE_POST Indicates whether to use GET or POST when sending data to the server. This constant is used by only the aciObjectParamSetBool function on an ACI_COMMAND type ACI object.
ACI_CONNECTION Indicates that you want to create an ACI_CONNECTION type ACI object. This constant is used by only the aciObjectCreate function.
ACI_CONN_ENCRYPTION Indicates whether to encrypt communications with the ACI server. This constant is used by only the aciObjectParamSetBool function on an ACI_CONNECTION type ACI object. (You must also specify an encryption type if you want to encrypt communications.)
ACI_CONN_ENCRYPTION_TYPE Indicates that the specified parameter is the encryption type to use for communications with the ACI server. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object.
ACI_CONN_ENCRYPTION_TYPE_GSS Sets the GSS encryption type with which to encrypt communications with the ACI server. This constant is used by only the aciObjectParamSetString function that sets the ACI_CONN_ENCRYPTION_TYPE on an ACI_CONNECTION type ACI object.
ACI_CONN_ENCRYPTION_TYPE_TEA Sets the TEA encryption type with which to encrypt communications with the ACI server. This constant is used by only the aciObjectParamSetString function that sets the ACI_CONN_ENCRYPTION_TYPE on an ACI_CONNECTION type ACI object.
ACI_CONNECTION_REALM_KEY Sets the realm key of GSS encryption with which to encrypt communications with the ACI server. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object with ACI_CONN_ENCRYPTION_TYPE_GSS encryption type.
ACI_CONNECTION_SERVICE_KEY Sets the service key of GSS encryption with which to encrypt communications with the ACI server. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object with ACI_CONN_ENCRYPTION_TYPE_GSS encryption type.
ACI_CONN_HTTPHEADER_XFORWARDEDFOR Sets the X-Forwarded-For HTTP header.
ACI_CONN_RETRIES Indicates that the specified parameter is the number of times a connection is retried. This constant is used by only the aciObjectParamSetInt function on an ACI_CONNECTION type ACI object.
ACI_CONN_TCP_RCVBUF Sets the size of the socket receive buffer SO_RCVBUF.
ACI_CONN_USE_DEFLATE Indicates that the specified parameter specifies whether to use deflate compression in HTTP requests. This constant is used by only the aciObjectParamSetBool function on an ACI_CONNECTION type ACI object.
ACI_CONN_TIMEOUT Indicates that the specified parameter is the timeout used in the connection. This constant is used by only the aciObjectParamSetInt function on an ACI_CONNECTION type ACI object.
ACI_CONN_TIMEOUT_READ Indicates that the specified parameter is the timeout for how long the connection waits to read data. If you do not set this constant, the connection uses the ACI_CONN_TIMEOUT value as the timeout for both the initial connect or send request phase and the retrieving data phase of the ACI request. This constant is used by only the aciObjectParamSetInt function on an ACI_CONNECTION type ACI object.
ACI_CONN_TIMEOUT_READ_ERROR Indicates that the specified parameter specifies whether to use a separate error for connection timeouts at the read stage. You can use this parameter to return separate ACICONTENT_ERRORTIMEOUTREAD and ACICONTENT_ERRORTIMEOUT return codes. This constant is used by only the aciObjectParamSetBool function on an ACI_CONNECTION type ACI object.
ACI_CONN_USE_SSL Indicates that the specified parameter specifies whether to use HTTPS requests. This constant is used by only the aciObjectParamSetBool function on an ACI_CONNECTION type ACI object.
ACI_CONN_SSL_CERTIFICATE Indicates that the specified parameter gives the location on disk of the SSL certificate to be used for HTTPS requests. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object.
ACI_CONN_SSL_PRIVATEKEY Indicates that the specified parameter gives the location on disk of the SSL private key file matching the SSL certificate to be used for HTTPS requests. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object.
ACI_CONN_SSL_CHECKCOMMONNAME Indicates that the specified parameter specifies whether to check that the CommonName (CN) attribute of the SSL certificate returned by the peer resolves to the same IP address of the hostname. This constant is used by only the aciObjectParamSetBool function on an ACI_CONNECTION type ACI object.
ACI_CONN_SSL_CACERTIFICATE Indicates that the specified parameter gives the location on disk of the SSL Certificate Authority (CA) certificate of a trusted authority to be used for HTTPS requests. Communication with a peer is only trusted if it provides a certificate signed by the specified CAs. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object.
ACI_DATA Indicates that you want to create an ACI_DATA type ACI object. This constant is used by only the aciObjectCreate function.
ACI_DATA_DATA Indicates that the specified parameter is all data that the server has returned. This constant is used by only the aciObjectParamGetString function on an ACI_DATA type ACI object.
ACI_DATA_NODE_NAME Indicates that the specified parameter is the node name. This constant is used by only the aciObjectParamGetString function on an ACI_DATA type ACI object.
ACI_DATA_NODE_VALUE Indicates that the specified parameter is the node value. This constant is used by only the aciObjectParamGetString function on an ACI_DATA type ACI object.
ACI_HOSTNAME Indicates that the specified parameter is the IP address (or name) of the ACI server. This constant is used by only the aciObjectParamSetString function on an ACI_CONNECTION type ACI object.
ACI_PORTNUMBER Indicates that the specified parameter is the port number that is used to communicate with the ACI server. This constant is only used by the aciObjectParamSetInt function on an ACI_CONNECTION type ACI object.
ACI_SECURITY_DOMAIN Indicates that the specified value is a domain name. This constant is used by only the aciObjectSetUserSecurityInfo function on an ACI_COMMAND type ACI object.
ACI_SECURITY_EXTENDED Indicates that the specified value is the value for an additional field used for security in this repository. This constant is used by only the aciObjectSetUserSecurityInfo function on an ACI_COMMAND type ACI object.
ACI_SECURITY_GROUP Indicates that the specified value is a user group name. This constant is used by only the aciObjectSetUserSecurityInfo function on an ACI_COMMAND type ACI object.
ACI_SECURITY_PASSWORD Indicates that the specified value is a password. This constant is used by only the aciObjectSetUserSecurityInfo function on an ACI_COMMAND type ACI object.
ACI_SECURITY_USERNAME Indicates that the specified value is a user name. This constant is used by only the aciObjectSetUserSecurityInfo function on an ACI_COMMAND type ACI object.