This interface provides methods for modification of lists that contain DMA Identifiers.
This interface offers all the methods of the IdmaEditList interface, as well as those listed below.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaEditListOfId::InsertId (
DmaIndex32 iIndex,
pDmaId pIdValue)
Parameters
Name | Mode | Description |
iIndex | input | The ordinal position in the list where the value will be placed. |
pIdValue | input | The Id value that will be inserted into the list. |
This function inserts a DMA identifier value into the list given on an ordinal position provided by the caller. All list elements that have indexes greater then iIndex at the time of the call will have their index in the list incremented by one. Permitted values for iIndex are 0 through n, where n is the number of elements in the list at the time of the call. A value of n appends a new value to the end of the list.
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_BAD_VALUE | The value given for a property or list element lies outside the permitted range or value set, or exceeds the maximum length allowed. |
DMARC_OK | (S_OK) Success. |
DMARC_READ_ONLY | Method failed because an object or property is read-only. |
Deferred Return Values
Name | Description |
DMARC_CONSTRAINT_VIOLATED | The operation violates a constraint of the implementation. |
DMARC_LIST_BOUNDS_ERROR | The number of elements in a list is outside the permitted range. |
DMARC_NOT_UNIQUE | A uniqueness requirement has been violated. |
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaEditListOfId::ReplaceId (
DmaIndex32 iIndex,
pDmaId pIdValue)
Parameters
Name | Mode | Description |
iIndex | input | The ordinal position in the list where the value will be replaced. |
pIdValue | input | The new Id value that will replace the value in the list. |
Replaces a DMA identifier value in a list with the supplied Id value given an ordinal position value as input. 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.
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_BAD_VALUE | The value given for a property or list element lies outside the permitted range or value set, or exceeds the maximum length allowed. |
DMARC_OK | (S_OK) Success. |
DMARC_READ_ONLY | Method failed because an object or property is read-only. |
Deferred Return Values
Name | Description |
DMARC_CONSTRAINT_VIOLATED | The operation violates a constraint of the implementation. |
DMARC_NOT_UNIQUE | A uniqueness requirement has been violated. |