FeedConsumer.ConsumeFeed Method

Consumes the specified feed and imports the items into the provider that is contained in this object.

Namespace:  Microsoft.Synchronization.FeedSync
Assembly:  Microsoft.Synchronization (in Microsoft.Synchronization.dll)

Syntax

'Declaration
Public Function ConsumeFeed ( _
    feedStream As Stream _
) As EndpointState
'Usage
Dim instance As FeedConsumer
Dim feedStream As Stream
Dim returnValue As EndpointState

returnValue = instance.ConsumeFeed(feedStream)

public EndpointState ConsumeFeed(
    Stream feedStream
)

public:
EndpointState^ ConsumeFeed(
    Stream^ feedStream
)

member ConsumeFeed : 
        feedStream:Stream -> EndpointState 

public function ConsumeFeed(
    feedStream : Stream
) : EndpointState

Parameters

• feedStream
  Type: System.IO.Stream
  A stream that contains the FeedSync feed to be consumed. Sync Framework must have read access to the stream.

Return Value

Type: Microsoft.Synchronization.FeedSync.EndpointState
The endpoint state of the feed. A null reference (Nothing in Visual Basic) when the feed is empty.

Exceptions

Exception	Condition
ArgumentNullException	feedStream is a null reference (Nothing in Visual Basic).
ArgumentException	feedStream cannot be read or contains no feed items.

Remarks

When the returned endpoint state is set as the IncrementalFeedBaseline value for a FeedProducer object, the object will produce an incremental feed that is based on feedStream.

See Also

Reference

FeedConsumer Class

Microsoft.Synchronization.FeedSync Namespace