Begin

Returns the location of the first interface from a list.

Syntax

Copied!

adlx_uint    Begin ()

Parameters

N/A

Return Value

If the list is not empty it returns the location of the first interface in the list.

If the list is empty the returned location is same as the location returned by End .

Remarks

The returned location is valid if it is less than the location returned by End . The Begin is used in combination with End for parsing the list sequentially from the beginning to the end.

If the list is empty, Begin and End return the same location.

_images/list.png

Copied!

ADLX_RESULT  res;
IADLXListPrt adlxList;                      // Get ADLXList interface
...

adlx_uint it = adlxList->Begin();
for (; it != adlxList->End(); it++)         // Iterate ADLXList and get the elements in the list
{
    res = adlxList->At(it, ...);
    ...

}

Requirements

Header

include “ADLXDefines.h”

Minimum version

1.0