nf-tapi3-itmspaddress-getevent.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	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	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:tapi3.ITMSPAddress.GetEvent	ITMSPAddress::GetEvent (tapi3.h)	The ITMSPAddress::GetEvent (tapi3.h) method retrieves event information.	GetEvent GetEvent method [TAPI 2.2] GetEvent method [TAPI 2.2] ITMSPAddress interface ITMSPAddress interface [TAPI 2.2] GetEvent method ITMSPAddress.GetEvent ITMSPAddress::GetEvent _tapi3_itmspaddress_getevent msp/ITMSPAddress::GetEvent tapi3.itmspaddress_getevent	tapi3\itmspaddress_getevent.htm	tapi3	df5263f2-9d76-472d-b7fc-724d36f0b58f	08/09/2022	GetEvent, GetEvent method [TAPI 2.2], GetEvent method [TAPI 2.2],ITMSPAddress interface, ITMSPAddress interface [TAPI 2.2],GetEvent method, ITMSPAddress.GetEvent, ITMSPAddress::GetEvent, _tapi3_itmspaddress_getevent, msp/ITMSPAddress::GetEvent, tapi3.itmspaddress_getevent	tapi3.h	Tapi3.h	Windows															Windows			19H1	ITMSPAddress::GetEvent tapi3/ITMSPAddress::GetEvent	c++	APIRef kbSyntax	COM	msp.h	ITMSPAddress.GetEvent

ITMSPAddress::GetEvent

-description

The GetEvent method retrieves event information.

-parameters

-param pdwSize [in, out]

A pointer to a DWORD that contains the size, in bytes, of pEventBuffer. On success, pdwSize returns the actual number of bytes in pEventBuffer. If pEventBuffer is not large enough, the method returns TAPI_E_NOTENOUGHMEMORY and this parameter returns the number, in bytes, required.

-param pEventBuffer

[in, out, size_is(*pdwSize)] A pointer to buffer that contains MSP event_info information.

-returns

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
E_NOTIMPL	Method not implemented.
E_POINTER	The pdwSize or pEventBuffer parameter is not a valid pointer.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.
TAPI_E_NOTENOUGHMEMORY	The pdwSize parameter was not large enough for the buffer.
TAPI_E_NOEVENT	No event has occurred.

-remarks

TAPI3 calls this method when the event handle given in initialize is signaled. TAPI will call this method repeatedly until it fails so it can get multiple events. Each call should return only one event structure.

Users of the MSP base classes: This method locks the event list.

-see-also

ITMSPAddress

Media Service Provider Interface (MSPI)