FeedConsumer.ConsumeFeed Method

  • Article

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
)

public EndpointState ConsumeFeed (
    Stream feedStream
)

public function ConsumeFeed (
    feedStream : Stream
) : EndpointState

Parameters

  • feedStream
    A stream that contains the FeedSync feed to be consumed. Sync Services must have read access to the stream.

Return Value

The endpoint state of the feed. A null reference (Nothing in Visual Basic) when the feed is empty.

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
FeedConsumer Members
Microsoft.Synchronization.FeedSync Namespace