CAMSchedule::Unadvise (Compact 2013)

3/26/2014

Removes a previously established advise link.

Syntax

HRESULT Unadvise(
  DWORD dwAdviseToken
);

Parameters

• dwAdviseToken
  Identifier (cookie) of the link that is being reset. This is the value returned by CAMSchedule::AddAdvisePacket.

Return Value

Returns S_OK if successful; otherwise, returns S_FALSE.

Remarks

This member function is modeled after the IReferenceClock::Unadvise method. Call Unadvise to remove the previously established clock advise links.

Unadvise should be called for unexpired single-shot advise requests.

Calling Unadvise with the token of an already expired event causes no problems, so applications can choose to always call Unadvise on their single-shot events without fear of problems.

Requirements

See Also

Reference

CAMSchedule Class