IStillImage::GetSTILaunchInformation

[This is preliminary documentation and subject to change.]

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.

HRESULT GetSTILaunchInformation(
  LPWSTR pwszDeviceName,  
  DWORD pdwEventCode,    
  LPWSTR pwszEventName  
);
 

Parameters

pwszDeviceName

If the application was launched by a push model event by means of the Control Center, this will be set to the friendly device name of the device which caused the event.

pdwEventCode

Reserved for future use.

pwszEventName

If the application was launched by a push model event from the Control Center, this will be set to the name of the event. This name is supplied by the vendor of the image acquisition device. It is the same string that is used in the Events tab of the STI Control Panel property page for the device.

Return Values

If the application was launched by the Control Center in response to a device event, this function will return S_OK, and the device event information will be stored in the function arguments.

If the application was not launched by the STI Control Center in response to a device event, this function will return a COM error code.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in sti.h.
  Import Library: Included as a resource in sti.dll.

See Also

Still Image Overview, Making An Application Still Image-Aware