CAMSchedule::AddAdvisePacket

 
Microsoft DirectShow 9.0

CAMSchedule::AddAdvisePacket

The AddAvisePacket method adds an advise request to the list of pending requests.

Syntax

  DWORD_PTR AddAdvisePacket(
    const REFERENCE_TIME& time1,
    const REFERENCE_TIME& time2,
    HANDLE hNotify,
    BOOL bPeriodic
);

Parameters

time1

Requested time for the advise.

time2

For periodic advise requests, the time between notifications. This parameter is ignored if bPeriodic is FALSE.

hNotify

Handle to a semaphore if bPeriodic is TRUE, or handle to an event if bPeriodic is FALSE.

bPeriodic

Boolean value that specifies whether to add a periodic notification or a one-shot notification. If TRUE, the notification is periodic; the time2 parameter specifies the time between notifications. If FALSE, the notification occurs only once.

Return Value

Returns an identifier for the advise request (the "cookie"). If the method fails, the return value is zero.

Requirements

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

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

See Also