GetSTILaunchInformation method
The IStillImage::GetSTILaunchInformation method is used to determine if an application was launched by a push model device event. It is also used to retrieve the device event information.
Syntax
HRESULT GetSTILaunchInformation(
[out] LPWSTR pwszDeviceName,
DWORD pdwEventCode,
[out] LPWSTR pwszEventName
);
Parameters
-
pwszDeviceName [out]
-
If the application was launched by a push model event by means of the Event Monitor, this is set to the friendly device name of the device which caused the event.
-
pdwEventCode
-
Reserved.
-
pwszEventName [out]
-
If the application was launched by a push model event from the Event Monitor, this is set to a string representation of the event GUID. Sti.h defines the following standard event GUIDs:
GUID Meaning - GUID_DeviceArrivedLaunch
Launch the Still Image application. - GUID_ScanImage
Use the imaging device to scan an image. - GUID_ScanPrintImage
Scan an image and print it. - GUID_ScanFaxImage
Scan an image and fax it. - GUID_STIUserDefined1
Application-defined event. - GUID_STIUserDefined2
Application-defined event. - GUID_STIUserDefined3
Application-defined event.
Return value
If the application was launched by the Event Monitor in response to a device event, this method returns S_OK, and the device event information is stored in the method arguments.
If the application was not launched by the STI Event Monitor in response to a device event, this method returns a COM error code.
Requirements
Minimum supported client |
Windows XP [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
|
Library |
|
DLL |
|