Click or drag to resize

GetSourceIncrement

Gets the current setting for how many elements by which the source offset is incremented after every InXX or MoveXX transfer.

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

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

Return Value

Returns S_OK if successful, otherwise a failure HRESULT.

Remarks

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

Example

The following example demonstrates use of the GetSourceIncrement function.

C++
// CoAcme4321.cpp
STDMETHODIMP Acme4321::IAcme4321_Read(SAFEARRAY** ppsaData)
{
  long lIncrement;  
  hr = io.GetSourceIncrement(&lIncrement);

  hr = io.Memory.MoveIn16(VisaA16Space, 0x10, ppsaData);

  return hr;
}
See Also

Other Resources

Download a complete CHM version of this documentation here.