Share via

ISBE2GlobalEvent::GetEvent method (sbe.h)

  • Article

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

Gets a global spanning event and its data from a Stream Buffer Source filter.

Syntax

HRESULT GetEvent(
  [in]      REFGUID idEvt,
  [in]      ULONG   param1,
  [in]      ULONG   param2,
  [in]      ULONG   param3,
  [in]      ULONG   param4,
  [out]     BOOL    *pSpanning,
  [in, out] DWORD   *pcb,
  [out]     BYTE    *pb
);

Parameters

[in] idEvt

GUID identifying the event.

[in] param1

First event-specific parameter.

[in] param2

Second event-specific parameter.

[in] param3

Third event-specific parameter.

[in] param4

Fourth event-specific parameter.

[out] pSpanning

Receives a flag indicating whether the event is a spanning event.

[in, out] pcb

Pointer to a value specifying the buffer size. If the pb parameter is NULL, this parameter returns the required buffer size.

[out] pb

Pointer to a buffer that receives the event data. If this parameter is NULL, the pcb parameter returns the required buffer size. The structure of the event data depends on the event type. For a list of event types, see the description of the ISBE2SpanningEvent::GetEvent method.

Return value

Returns an HRESULT value. Possible values include the following:

Return value Description
S_OK
 Success.
ERROR_INSUFFICIENT_BUFFER
 Buffer was too small to hold event data.
ERROR_CONTEXT_EXPIRED
 Too much time elapsed between the broadcast event and the call to retrieve it.

Requirements

Requirement Value
Minimum supported client Windows�7 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header sbe.h

See also

ISBE2GlobalEvent

ISBE2SpanningEvent::GetEvent

Stream Buffer Source Filter