Click or drag to resize

GetDestinationIncrement

Gets the current setting for how many elements by which the destination offset is incremented after every OutXX or MoveOutXX transfer.

virtual HRESULT GetDestinationIncrement(long* plIncrement) abstract;
Parameters
plIncrement

[in] Number of elements by which the destination offset is incremented.

Return Value

Returns S_OK if successful, otherwise a failure HRESULT.

Remarks

The default value increment is 1 -- that is, the destination address will be incremented by 1 after each transfer, and the MoveOutXX operations move into consecutive elements. If this attribute is set to 0, the MoveOutXX operations will always write to the same element, essentially treating the destination as a FIFO register.

Example

The following example demonstrates use of the GetSourceIncrement function.

C++
// CoAcme4321.cpp
STDMETHODIMP Acme4321::IAcme4321_Write(SAFEARRAY* psaData)
{
  long lIncrement;  
  hr = io.GetDestinationIncrement(&lIncrement);

  hr = io.Memory.MoveOut16(VisaA16Space, 0x10, psaData);

  return hr;
}
See Also

Download a complete CHM version of this documentation here.