This interface provides the methods for handling lists that contain buffers of binary data.
This interface offers all the methods of the IdmaList interface, as well as those listed below.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaListOfBinary::GetBinary (
DmaIndex32 iIndex,
DmaBinaryValue* pBinaryValue)
Parameters
Name | Mode | Description |
iIndex | input | The ordinal position in the list to retrieve the binary value from. |
pBinaryValue | output | A pointer to the returned binary value. |
This function will return the binary value that resides in the iIndex-th position in the list.
Valid values for iIndex are 0 through n-1, where n is the number of elements in the list at the time of the call.
The caller is responsible for allocating and freeing the structure pointed to by the pBinaryValue parameter. The memory pointed to by the pBinaryValue->pbBytes field is allocated by the callee and must be freed by the caller. This field need not be pre-initialised to NULL by the caller, and must be set to NULL by the callee if any return code other than DMARC_OK is returned.
Return Values
Name | Description |
DMARC_BAD_INDEX | The index specified does not reference a valid property or list element. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_OK | (S_OK) Success. |