Skip to content

Latest commit

 

History

History
114 lines (75 loc) · 3.63 KB

ns-portcls-pcevent_item.md

File metadata and controls

114 lines (75 loc) · 3.63 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NS:portcls.PCEVENT_ITEM
PCEVENT_ITEM (portcls.h)
The PCEVENT_ITEM structure is used to describe an event that is supported by a particular filter, pin, or node.
audio\pcevent_item.htm
audio
05/08/2018
PCEVENT_ITEM structure
*PPCEVENT_ITEM, PCEVENT_ITEM, PCEVENT_ITEM structure [Audio Devices], PPCEVENT_ITEM, PPCEVENT_ITEM structure pointer [Audio Devices], audio.pcevent_item, audpc-struct_54e5d50f-6902-47d3-8170-3ee459b8dfb8.xml, portcls/PCEVENT_ITEM, portcls/PPCEVENT_ITEM
portcls.h
Portcls.h
Windows
Windows
PCEVENT_ITEM, *PPCEVENT_ITEM
PPCEVENT_ITEM
portcls/PPCEVENT_ITEM
PCEVENT_ITEM
portcls/PCEVENT_ITEM
APIRef
kbSyntax
HeaderDef
portcls.h
PPCEVENT_ITEM
PCEVENT_ITEM

PCEVENT_ITEM structure

-description

The PCEVENT_ITEM structure is used to describe an event that is supported by a particular filter, pin, or node.

-struct-fields

-field Set

Specifies the event set. This member is a pointer to a GUID that uniquely identifies the event set. See the list of event-set GUIDs in Audio Drivers Event Sets.

-field Id

Specifies the event ID. This member identifies an event item within the event set. If the event set contains N items, valid event IDs are integers in the range 0 to N-1.

-field Flags

Specifies the type of event. This member is set to one of the following values:

PCEVENT_ITEM_FLAG_ENABLE

Indicates the event notification should be enabled for this event type. The driver should continue event notification until the client explicitly disables it.

PCEVENT_ITEM_FLAG_ONESHOT

Indicates that the event notification should be enabled for the next occurrence of this event only. The client does not (and should not) disable the event once it has occurred.

PCEVENT_ITEM_FLAG_BASICSUPPORT

If the client specifies this flag, the driver returns STATUS_SUCCESS if it supports the event and an error code if it does not.

-field Handler

Pointer to the miniport driver's event-handler routine. This member is a function pointer of type PCPFNEVENT_HANDLER, which is defined as follows:

  typedef NTSTATUS (*PCPFNEVENT_HANDLER)
  (
      IN PPCEVENT_REQUEST  EventRequest
  );

When calling the Handler routine, the caller passes in a single call parameter, which is a pointer to a caller-allocated PCEVENT_REQUEST structure.

-remarks

The PCEVENT_ITEM structure specifies a particular event item in an automation table. The PCAUTOMATION_TABLE structure points to an array of PCEVENT_ITEM structures.

In WDM audio, the target for an event request is either a pin instance or a node on a pin. A filter instance cannot be the target of an event request.

-see-also

PCAUTOMATION_TABLE

PCEVENT_REQUEST