Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 2.48 KB

nf-wiamdef-wiasqueueevent.md

File metadata and controls

87 lines (64 loc) · 2.48 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
NF:wiamdef.wiasQueueEvent
wiasQueueEvent function (wiamdef.h)
The wiasQueueEvent function informs the service that the device generated an event.
image\wiasqueueevent.htm
image
05/03/2018
wiasQueueEvent function
image.wiasqueueevent, wiamdef/wiasQueueEvent, wiasFncs_a853cdf1-8d80-4bb6-9c41-c7190e9e9202.xml, wiasQueueEvent, wiasQueueEvent function [Imaging Devices]
wiamdef.h
Wiamdef.h
Desktop
Wiaservc.lib
Wiaservc.dll
Windows
wiasQueueEvent
wiamdef/wiasQueueEvent
APIRef
kbSyntax
DllExport
Wiaservc.dll
wiasQueueEvent

wiasQueueEvent function

-description

The wiasQueueEvent function informs the service that the device generated an event.

-parameters

-param bstrDeviceId [in]

Specifies the device ID. This is the value passed to the minidriver in the call to the IWiaMiniDrv::drvInitializeWia method.

-param pEventGUID [in]

Pointer to a buffer that contains the GUID for the event.

-param bstrFullItemName [in, optional]

Specifies the full item name, including path information.

-returns

On success, the function returns S_OK.

If the function fails, it returns a standard COM error or one of the WIA error codes.

-remarks

This method should be used whenever the device must signal that an event of some type occurred. The device does this by placing the event on the event queue. For example, when a camera takes a new picture, it should generate a WIA_EVENT_ITEM_CREATED event after adding a new driver item to its tree. The camera can place this event on the event queue in this way:

hr = wiasQueueEvent(bstrMyDeviceId,
                    &WIA_EVENT_ITEM_CREATED,
                    bstrDescriptionString);

See the Windows SDK documentation for a complete list of WIA event identifiers.

-see-also

IWiaMiniDrv::drvInitializeWia