Community articleC API Index
Added by IBM contributorIBM on August 16, 2011
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

This is the index for C API.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


A
API
initializing the API (1)
initializing the API with locale (1)
Authenticated Clickwrap
validating Authenticated Clickwrap signatures (1) (2)
algorithm, looking up a hash algorithm (1)
attachments
attaching a file (1)
extracting an attachment (1)
removing an attachment (1)
attributes
getting a list of attributes and values (1)
getting the value of an attribute (1)
removing an attribute (1)
setting an attribute (1)
Back to top

B
Back to top

C
Certificate functions (1)
Certificate_GetBlob function (1)
Certificate_GetDataByPath function (1)
Certificate_GetIssuer function (1)
cell item
locating a cell in a particular group (1)
cells, creating cells (1)
certificates
getting a Blob of the certificate (1)
getting specific certificate data (1)
getting the issuer certificate (1)
getting the signing certificate from a signature (1)
certificates, getting a list of available certificates (1) (2)
children
locating a child node (1)
closing a form (1)
computes
deactivating the compute system (1)
setting a compute (1)
cp_free (1)
cp_malloc (1)
cp_realloc (1)
cp_strcat (1)
cp_strcmp (1)
cp_strcpy (1)
cp_strdup (1)
cp_strlen (1)
cp_strncmp (1)
cp_strrchr (1)
cp_strstr (1)
creating
creating cells (1)
creating forms (1)
creating nodes (1)
Back to top

D
data item
locating a particular data item in a datagroup (1)
data model, updating the XML data model (1)
data types - C API
r_byte (1)
r_charP (1)
r_long (1)
r_short (1)
r_u_long (1)
r_u_short (1)
r_voidP (1)
rc_char (1)
rc_charP (1)
rc_long (1)
rc_longlong (1)
rc_short (1)
rc_u_long (1)
rc_u_longlong (1)
rc_u_short (1)
datagroup
locating a particular data item in a datagroup (1)
deleting
deleting a form from memory (1)
deregistering a function call from the IFX Manager (1) (2)
digital certificates, getting a list of available cetificates (1) (2)
Back to top

E
enclosures
enclosing a file (1)
extracting an enclosure (1)
removing an enclosure (1)
error messages
getting default language of in C API (1)
getting language of in C API (1) (2)
setting default language of in C API (1)
setting language of in C API (1) (2)
extensions
about (1)
Back to top

F
FCICOMMAND_DEREGISTER constant (1)
FCICOMMAND_INSTANCEDEREGISTER constant (1)
FCICOMMAND_INSTANCEREGISTER constant (1)
FCICOMMAND_REGISTER constant (1)
FCMDeregisterFunctionCall function (1)
FCMGetDefaultListener function (1)
FCMGetFunctionCallHelp function (1)
FCMGetFunctionCallList function (1)
FCMGetFunctionCallPackageList function (1)
FCMRegisterFunctionCall function (1)
Form Library
initializing the Form Library (1)
FormNodeP constants
FormNodeP.UFL_SIGS_NOTOK (1) (2)
FormNodeP.UFL_SIGS_OK (1) (2)
FormNodeP.UFL_SIGS_UNVERIFIED (1) (2)
FormNodeP.UFL_SIGS_VERIFIEDBUTNOTAUTHENTICATED (1)
FormNodeP.UFL_SIGS_NOTOK (1) (2)
FormNodeP.UFL_SIGS_OK (1) (2)
FormNodeP.UFL_SIGS_UNVERIFIED (1) (2)
FormNodeP.UFL_SIGS_VERIFIEDBUTNOTAUTHENTICATED (1)
Function Call Evaluate Template (1)
Function Call Manager
about (1)
getting a list of registered packages (1)
registering a function call (1)
FunctionCall constants
FCICOMMAND_DEREGISTER (1)
FCICOMMAND_INSTANCEDEREGISTER (1)
FCICOMMAND_INSTANCEREGISTER (1)
FCICOMMAND_REGISTER (1)
FunctionCall functions (1)
FunctionCall structure (1)
FunctionCall structures
FunctionCallHelp template (1)
creating a FunctionCall structure (1)
defining the services provided by a FunctionCall structure (1)
deregistering a FunctionCall (1)
determining which FunctionCall implements a function (1)
getting a list of registered FunctionCall structures (1)
registering with the IFX Manager (1)
FunctionCallHelp template (1)
FunctionCall_SetObjectProc function (1)
files
enclosing files (1)
extracting files (1)
removing attached files (1)
form
determining the version of a form (1)
formNodeP
creating a formNodeP (1)
formNodeP constants
UFL_APPEND_CHILD (1)
UFL_BEFORE_SIBLING (1)
UFL_NEXT (1)
UFL_SAVE_ALLOW (1)
formatting
determining whether a node is correctly formatted (1)
determining whether all the nodes in a form ares correctly formatted (1)
forms
creating a form (1)
duplicating forms (1)
loading a form (1)
writing a form to disk (1)
formulas
setting a formula (1)
freeing memory (1)
functions
Certificate functions (1)
Certificate_GetBlob (1)
Certificate_GetDataByPath (1)
Certificate_GetIssuer (1)
FCMDeregisterFunctionCall (1)
FCMGetDefaultListener (1)
FCMGetFunctionCallHelp (1)
FCMGetFunctionCallPackageList (1)
FCMRegisterFunctionCall (1)
FunctionCall functions (1)
FunctionCall_SetObjectProc (1)
GCMGetFunctionCallList (1)
GetCurrentThreadLocale (1)
GetCurrentThreadStringValue (1)
GetDefaultLocale (1)
Hash functions (1)
Hash_Hash (1)
IFSGetGlobalIFX (1)
IFSInitialize (1)
IFSInitializeWithLocale (1)
IFSObject_AllocateObject (1)
IFXDeregisterInterface (1)
IFXGetInterfaceInstances (1)
IFXRegisterInterface (1)
LocalizationManager functions (1)
LocalizationManager_GetCurrentThreadLocale (1)
LocalizationManager_GetCurrentThreadStringValue (1)
LocalizationManager_GetDefaultLocale (1)
LocalizationManager_SetCurrentThreadLocale (1)
LocalizationManager_SetCurrentThreadStringValue (1)
LocalizationManager_SetDefaultLocale (1)
MUGetThreadSafeFlag (1)
SecurityManager functions (1)
SecurityManager_GetSingleton (1)
SecurityManager_LookupHashAlgorithm (1)
SetCurrentThreadLocale (1)
SetCurrentThreadStringValue (1)
SetDefaultLocale (1)
Signature functions (1)
Signature_GetDataByPath (1)
Signature_GetSigningCert (1)
UFLAddNamespace (1)
UFLAttachPage (1)
UFLCheckDataValidity (1)
UFLCheckValidFormats (1)
UFLCreate (1)
UFLCreateCell (1)
UFLDeleteSignature (1)
UFLDereferenceEx (1)
UFLDestroy (1)
UFLDuplicate (1)
UFLEncloseFile (1)
UFLEncloseInstance (1)
UFLExtractFile (1)
UFLExtractInstance (1)
UFLExtractXFormsInstance (1)
UFLGetAttribute (1)
UFLGetAttributeList (1)
UFLGetCertificateList (1)
UFLGetChildren (1)
UFLGetEngineCertificateList (1)
UFLGetFormVersion (1)
UFLGetInfoEx (1)
UFLGetLiteralByRefEx (1)
UFLGetLiteralEx (1)
UFLGetLocalName (1)
UFLGetNamespaceURI (1)
UFLGetNamespaceURIFromPrefix (1)
UFLGetNext (1)
UFLGetNodeType (1)
UFLGetParent (1)
UFLGetPrefix (1)
UFLGetPrefixFromNamespaceURI (1)
UFLGetPrevious (1)
UFLGetReferenceEx (1)
UFLGetSecurityEngineName (1)
UFLGetSignature (1)
UFLGetSignatureVerificationStatus (1)
UFLIsDigitalSignaturesAvailable (1)
UFLIsSigned (1)
UFLIsValidFormat (1)
UFLIsXFDL (1)
UFLReadForm (1)
UFLRemoveAttribute (1)
UFLRemoveEnclosure (1)
UFLSetActiveForComputationalSystem (1)
UFLSetAttribute (1)
UFLSetFormula (1)
UFLSetLiteralByRefEx (1)
UFLSetLiteralEx (1)
UFLSignForm (1)
UFLUpdateXFormsInstance (1)
UFLValidateHMACWithHashedSecret (1)
UFLValidateHMACWithSecret (1)
UFLVerifyAllSignatures (1)
UFLVerifySignature (1)
UFLWriteForm (1)
UFLXMLModelUpdate (1)
XFDL functions (1)
about the Function Call Manager (1)
defining a version number for custom functions (1)
deregistering a function call (1)
deregistering a function call from the IFX Manager (1)
executing custom functions (1)
getting a list of functions in a package (1)
registering a fuction call with the Function Call Manager (1)
utility functions (1)
Back to top

G
GetCurrentThreadLocale function (1)
GetCurrentThreadStringValue function (1)
GetDefaultLocale function (1)
getXFormsModels (1)
group
locating a cell in a particular group (1)
Back to top

H
HMAC signatures
validating HMAC signatures (1) (2)
validating Signature Pad signatures (1) (2)
Hash functions (1)
Hash_Hash function (1)
hash algorithm, looking up an algorithm (1)
hashes
creating a hash (1)
header files (1) (2) (3) (4) (5) (6) (7) (8)
help
getting the help for a function (1)
providing help for your custom functions (1)
Back to top

I
IFSGetGlobalIFX function (1)
IFSInitialize function (1)
IFSInitializeWithLocale function (1)
IFSObject, creating (1)
IFSObject_AllocateObject function (1)
IFSUserData, creating (1)
IFX Manager
about (1)
deregistering a function call (1)
determining which FunctionCall implements a function (1)
getting a list of registered FunctionCall structures (1)
registering a FunctionCall structure (1)
retrieving the IFX Manager (1)
IFXDeregisterInterface function (1)
IFXGetInterfaceInstances function (1)
IFXRegisterInterface function (1)
Interlink signatures
validating (1) (2)
including xfdllib.h (1) (2) (3) (4) (5) (6)
initializing the Form Library (1) (2)
initializing the Form Library with locale (1)
instances, XForms
adding to an instance (1)
extracting an instance (1)
replacing an instance (1)
updating an instance (1)
instances, XML
enclosing an instance (1)
extracting an instance (1)
items
locating an item node (1)
Back to top

J
Back to top

K
Back to top

L
LocalizationManager functions (1)
LocalizationManager_GetCurrentThreadLocale function (1)
LocalizationManager_GetCurrentThreadStringValue function (1)
LocalizationManager_GetDefaultLocale function (1)
LocalizationManager_SetCurrentThreadLocale function (1)
LocalizationManager_SetCurrentThreadStringValue function (1)
LocalizationManager_SetDefaultLocale function (1)
language
getting default language of error messages in C API (1)
getting language of error messages in C API (1) (2)
setting default language of error messages in C API (1)
setting language of error messages in C API (1) (2)
literals
getting the literal of a node (1)
retrieving the literal of a node (1)
setting the literal of a node (1) (2)
loading a form (1)
local names
getting the local name of a node (1)
locale
initializing the API with locale (1)
locks, determining if a node is locked with a signature (1)
Back to top

M
MUGetThreadSafeFlag function (1)
Memory and string functions
cp_free (1)
cp_malloc (1)
cp_realloc (1)
cp_strcat (1)
cp_strcmp (1)
cp_strcpy (1)
cp_strdup (1)
cp_strlen (1)
cp_strncmp (1)
cp_strrchr (1)
cp_strstr (1)
pe_free (1)
pe_malloc (1)
pe_memcpy (1)
pe_realloc (1)
manager
about the Function Call Manager (1)
memory, freeing (1)
Back to top

N
names, getting the security engine name (1)
namespace
adding a namespace to a form (1)
determining if a node is in the XFDL namespace (1)
getting the local name of a node (1)
getting the namespace URI for a node (1)
getting the namespace URI from a prefix (1)
getting the namespace prefix for a namespace URI (1)
getting the namespace prefix for a node (1)
nodes
See also attributes (1)
See also local names (1)
See also namespace (1)
adding as child (1) (2)
adding as new form (1)
adding as sibling (1) (2)
creating nodes (1) (2)
determining if a node is signed (1)
duplicating nodes (1)
getting information about a node (1)
getting the literal of a node (1)
locating a child node (1)
locating a node (1)
locating the parent node (1)
reference, getting for a particular node (1)
retrieving the literal of a node (1)
setting the literal of a node (1) (2)
setting the value of signed nodes (1)
traversing sibling nodes (1) (2)
type, determining the node type (1)
Back to top

O
objects
Security Manager object (1)
getting a signature object (1)
hash object (1)
looking up a hash object (1)
option nodes
locating an option node (1)
Back to top

P
packages
getting a list of functions in a package (1)
getting a list of registered packages (1)
page nodes, locating a page node (1)
parent nodes, traversing parent nodes (1)
pe_free (1)
pe_malloc (1)
pe_memcpy (1)
pe_realloc (1)
prefix, namespace See namespace (1)
Back to top

Q
Back to top

R
references
getting a reference to a particular node (1)
syntax of a reference (1)
registering a FunctionCall structure (1)
removing
removing a form from memory (1)
Back to top

S
Security Manger, getting the Security Manager (1)
SecurityManager functions (1)
SecurityManager_GetSingleton function (1)
SecurityManager_LookupHashAlgorithm function (1)
SetCurrentThreadLocale function (1)
SetCurrentThreadStringValue function (1)
SetDefaultLocale function (1)
Signature functions (1)
Signature_GetDataByPath function (1)
Signature_GetSigningCert function (1)
saving
saving a form (1)
secret, hashing a secret (1)
security engines, getting the name (1)
services, defining the services provided by a FunctionCall (1)
shared secret, hashing a shared secret (1)
siblings
traversing sibling nodes (1) (2)
signatures
creating signatures (1)
deleting signatures (1)
destroying signatures (1)
determining if a node is signed (1)
determining whether a node is signed (1)
determining whether digital signatures are available (1)
getting a signature object (1)
getting specific signature data (1)
getting the signing certificate from a signature (1)
setting the value of nodes that are already signed (1)
validating HMAC signatures (1) (2)
validating Interlink signatures (1) (2)
validating Topaz signatures (1) (2)
validating WinTab signatures (1) (2)
validating signatures (1)
verifying signatures (1) (2)
singletons
Security Manager object (1)
strings
hashing a string (1)
structures
FunctionCall structure (1)
IFX structure (1)
Back to top

T
Topaz signatures, validating (1) (2)
templates
Function Call Evaluate Template (1)
FunctionCallHelp template (1)
thread safety (1)
time zone
getting in C API (1)
setting in C API (1)
traversing nodes
traversing parent nodes (1)
traversing sibling nodes (1)
type
determining the node type (1)
Back to top

U
UFLAddNamespace function (1)
UFLAttachPage function (1)
UFLCheckDataValidity function (1)
UFLCheckValidFormats function (1)
UFLCreate function (1)
UFLCreateCell function (1)
UFLDeleteSignature function (1)
UFLDereferenceEx function (1)
UFLDestroy function (1)
UFLDuplicate function (1)
UFLEncloseFile function (1)
UFLEncloseInstance function (1)
UFLExtractFile function (1)
UFLExtractInstance function (1)
UFLExtractXFormsInstance function (1)
UFLGetAttribute function (1)
UFLGetAttributeList function (1)
UFLGetCertificateList function (1)
UFLGetChildren function (1)
UFLGetEngineCertificateList function (1)
UFLGetFormVersion function (1)
UFLGetInfoEx function (1)
UFLGetLiteralByRefEx function (1)
UFLGetLiteralEx function (1)
UFLGetLocalName function (1)
UFLGetNamespaceURI function (1)
UFLGetNamespaceURIFromPrefix function (1)
UFLGetNext function (1)
UFLGetNodeType function (1)
UFLGetParent function (1)
UFLGetPrefix function (1)
UFLGetPrefixFromNamespaceURI function (1)
UFLGetPrevious function (1)
UFLGetRererenceEx function (1)
UFLGetSecurityEngineName function (1)
UFLGetSignature function (1)
UFLGetSignatureVerificationStatus function (1)
UFLIsDigitalSignaturesAvailable function (1)
UFLIsSigned function (1)
UFLIsValidFormat function (1)
UFLIsXFDL function (1)
UFLReadForm function (1)
UFLRemoveAttribute function (1)
UFLRemoveEnclosure function (1)
UFLSetActiveForComputationalSystem function (1)
UFLSetAttribute function (1)
UFLSetFormula function (1)
UFLSetLiteralByRefEx function (1)
UFLSetLiteralEx function (1)
UFLSignForm function (1)
UFLUpdateXFormsInstance function (1)
UFLValidateHMACWithHashedSecret function (1)
UFLValidateHMACWithSecret function (1)
UFLVerifyAllSignatures function (1)
UFLVerifySignature function (1)
UFLWriteForm function (1)
UFLXMLModelUpdate function (1)
UFL_APPEND_CHILD constant (1)
UFL_BEFORE_SIBLING constant (1)
UFL_NEXT constant (1)
UFL_SAVE_ALLOW constant (1)
updating the XForms data model (1) (2)
utility functions (1)
Back to top

V
version
determining the version of a form (1)
version numbers for custom functions
defining a version number (1)
Back to top

W
WinTab signatures, validating (1) (2)
Back to top

X
XFDL constants
XFDL.UFL_XFORMS_UPDATE_REPLACE (1)
XFDL functions (1)
XFDL.UFL_XFORMS_UPDATE_REPLACE (1)
XForms Model update (1) (2)
XForms data model, updating (1) (2)
XForms instances
adding to an instance (1)
extracting an instance (1)
replacing an instance (1)
updating an instance (1)
XML data model, updating (1)
XML instances
enclosing an instance (1)
extracting an instance (1)
Back to top

Y
Back to top

Z
Back to top