IPin::EndOfStream method

The EndOfStream method notifies the pin that no additional data is expected, until a new run command is issued to the filter.

Applications should not call this method. This method is called by other filters to signal the end of the stream.

Syntax


HRESULT EndOfStream();

Parameters

This method has no parameters.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
S_OK

Success.

E_UNEXPECTED

The pin is an output pin.

 

Remarks

Call this method only on input pins. Output pins return E_UNEXPECTED.

This method sends an end-of-stream notification to the pin. The pin delivers the notification downstream. It must serialize end-of-stream notifications with IMemInputPin::Receive calls. If the pin queues media samples for delivery, it should queue end-of-stream notifications as well. The IPin::BeginFlush method flushes any queued end-of-stream notifications.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Data Flow in the Filter Graph
Error and Success Codes
IPin Interface

 

 

Community Additions

ADD
Show:
© 2015 Microsoft