IdmaList

Lists are a fundamental feature in managing documents, so there are several operations available for manipulating them and the objects contained within them. Items within a list are kept in inserted order and can be identified by an index (ordinal position).

The methods used to access a DMA List are segmented into two groups of interfaces, the methods that allow readonly access to the list (IdmaList), and the methods that allow modification of the list (IdmaEditList). The IdmaEditList interface is only available on list objects that are editable. For each list datatype, there is a specific interface that offers methods particular to that datatype, as well as all the methods of IdmaList, (e.g., IdmaListOfString).

IdmaList::GetElementCount

This method must be supported in every implementation of this interface.

Syntax
DmaRC IdmaList::GetElementCount (
pDmaIndex32 piCount)

Parameters

Name

Mode

Description

piCount

output

A pointer to the Count location.

Description

Determines the number of elements in a list object, which can be used to iterate through the list for processing. The number returned is only valid at the time for inquiry, since any inserts or deletes will change the underlying list and render the count inaccurate.

Return Values

Name

Description

DMARC_BAD_PARAMETER

(E_INVALIDARG) Invalid input parameter.

DMARC_OK

(S_OK) Success.