Details
struct xmlSecPtrList
struct xmlSecPtrList {
    xmlSecPtrListId             id;
    xmlSecPtr*                  data;
    xmlSecSize                  use;
    xmlSecSize                  max;
    xmlSecAllocMode             allocMode;
};
The pointers list.
 
xmlSecPtrListSetDefaultAllocMode ()
void                xmlSecPtrListSetDefaultAllocMode    (xmlSecAllocMode defAllocMode,
                                                         xmlSecSize defInitialSize);
Sets new default allocation mode and minimal initial list size.
 
xmlSecPtrListInitialize ()
int                 xmlSecPtrListInitialize             (xmlSecPtrListPtr list,
                                                         xmlSecPtrListId id);
Initializes the list of given klass. Caller is responsible
for cleaning up by calling xmlSecPtrListFinalize function.
| list: |                the pointer to list. | 
| id: |                  the list klass. | 
| Returns : |  0 on success or a negative value if an error occurs. | 
 
xmlSecPtrListCreate ()
xmlSecPtrListPtr    xmlSecPtrListCreate                 (xmlSecPtrListId id);
Creates new list object. Caller is responsible for freeing returned list
by calling xmlSecPtrListDestroy function.
| id: |                  the list klass. | 
| Returns : |  pointer to newly allocated list or NULL if an error occurs. | 
 
xmlSecPtrListEmpty ()
void                xmlSecPtrListEmpty                  (xmlSecPtrListPtr list);
Remove all items from list (if any).
 
xmlSecPtrListCopy ()
int                 xmlSecPtrListCopy                   (xmlSecPtrListPtr dst,
                                                         xmlSecPtrListPtr src);
Copies src list items to dst list using duplicateItem method
of the list klass. If duplicateItem method is NULL then
we jsut copy pointers to items.
| dst: |                 the pointer to destination list. | 
| src: |                 the pointer to source list. | 
| Returns : |  0 on success or a negative value if an error occurs. | 
 
xmlSecPtrListDuplicate ()
xmlSecPtrListPtr    xmlSecPtrListDuplicate              (xmlSecPtrListPtr list);
Creates a new copy of list and all its items.
| list: |                the pointer to list. | 
| Returns : |  pointer to newly allocated list or NULL if an error occurs. | 
 
xmlSecPtrListGetItem ()
xmlSecPtr           xmlSecPtrListGetItem                (xmlSecPtrListPtr list,
                                                         xmlSecSize pos);
Gets item from the list.
| list: |                the pointer to list. | 
| pos: |                 the item position. | 
| Returns : |  the list item at position posor NULL ifposis greater
than the number of items in the list or an error occurs. | 
 
xmlSecPtrListAdd ()
int                 xmlSecPtrListAdd                    (xmlSecPtrListPtr list,
                                                         xmlSecPtr item);
Adds item to the end of the list.
| list: |                the pointer to list. | 
| item: |                the item. | 
| Returns : |  0 on success or a negative value if an error occurs. | 
 
xmlSecPtrListSet ()
int                 xmlSecPtrListSet                    (xmlSecPtrListPtr list,
                                                         xmlSecPtr item,
                                                         xmlSecSize pos);
Sets the value of list item at position pos. The old value
is destroyed.
 
xmlSecPtrListRemove ()
int                 xmlSecPtrListRemove                 (xmlSecPtrListPtr list,
                                                         xmlSecSize pos);
Destroys list item at the position pos and sets it value to NULL.
| list: |                the pointer to list. | 
| pos: |                 the position. | 
| Returns : |  0 on success or a negative value if an error occurs. | 
 
xmlSecPtrListDebugDump ()
void                xmlSecPtrListDebugDump              (xmlSecPtrListPtr list,
                                                         FILE *output);
Prints debug information about list to the output.
 
xmlSecPtrListDebugXmlDump ()
void                xmlSecPtrListDebugXmlDump           (xmlSecPtrListPtr list,
                                                         FILE *output);
Prints debug information about list to the output in XML format.
 
xmlSecPtrListGetName()
#define             xmlSecPtrListGetName(list)
Macro. Returns lists's name.
 
xmlSecPtrListIsValid()
#define             xmlSecPtrListIsValid(list)
Macro. Returns 1 if list is not NULL and list->id is not NULL
or 0 otherwise.
 
xmlSecPtrListCheckId()
#define             xmlSecPtrListCheckId(list, dataId)
Macro. Returns 1 if list is valid and list's id is equal to dataId.
 
xmlSecPtrListIdUnknown
#define xmlSecPtrListIdUnknown                  NULL
The "unknown" id.
 
xmlSecPtrDuplicateItemMethod ()
xmlSecPtr           (*xmlSecPtrDuplicateItemMethod)     (xmlSecPtr ptr);
Duplicates item ptr.
| ptr: |                 the poinetr to list item. | 
| Returns : |  pointer to new item copy or NULL if an error occurs. | 
 
xmlSecPtrDestroyItemMethod ()
void                (*xmlSecPtrDestroyItemMethod)       (xmlSecPtr ptr);
Destroys list item ptr.
| ptr: |                 the poinetr to list item. | 
 
xmlSecPtrDebugDumpItemMethod ()
void                (*xmlSecPtrDebugDumpItemMethod)     (xmlSecPtr ptr,
                                                         FILE *output);
Prints debug information about item to output.
 
struct xmlSecPtrListKlass
struct xmlSecPtrListKlass {
    const xmlChar*                      name;
    xmlSecPtrDuplicateItemMethod        duplicateItem;
    xmlSecPtrDestroyItemMethod          destroyItem;
    xmlSecPtrDebugDumpItemMethod        debugDumpItem;
    xmlSecPtrDebugDumpItemMethod        debugXmlDumpItem;
};
List klass.
 
xmlSecPtrListKlassGetName()
#define             xmlSecPtrListKlassGetName(klass)
Macro. Returns the list klass name.
 
xmlSecStringListId
#define             xmlSecStringListId
Strings list klass.
 
xmlSecStringListGetKlass ()
xmlSecPtrListId     xmlSecStringListGetKlass            (void);
The strins list class.