CBaseStreamControl::StopAt

Microsoft DirectShow 9.0

The StopAt method informs the pin when to stop delivering data. This method implements the IAMStreamControl::StopAt method.

Syntax

  HRESULT StopAt(
    const REFERENCE_TIME *ptStop = NULL,
    BOOL bSendExtra = FALSE,
    DWORD dwCookie = 0
);

Parameters

ptStop

Pointer to a REFERENCE_TIME value that specifies when the pin should stop delivering data.

bSendExtra

Specifies a Boolean value that indicates whether to send an extra sample after the scheduled stop time. If TRUE, the pin sends one extra sample.

dwCookie

Specifies a value to send along with the start notification.

Return Values

Returns S_OK.

Requirements

** Header:** Declared in Strmctl.h; include Streams.h.

** Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also

Additional resources