IStillImageW::GetSTILaunchInformation method (sti.h)

The IStillImage::GetSTILaunchInformation method returns the reason the calling still image application was started, if the still image event monitor started it.

Syntax

HRESULT GetSTILaunchInformation(
  [out]           LPWSTR pwszDeviceName,
  [out, optional] DWORD  *pdwEventCode,
  [out]           LPWSTR pwszEventName
);

Parameters

[out] pwszDeviceName

Caller-supplied pointer to a buffer, STI_MAX_INTERNAL_NAME_LENGTH bytes in length, to receive the internal device name of the still image device for which the application was started.

[out, optional] pdwEventCode

Reserved for future use.

[out] pwszEventName

Caller-supplied pointer to a buffer that is large enough to receive a string representation of a GUID. The GUID represents the Still Image Device Events for which the application was started.

Return value

If the operation succeeds, the method returns S_OK. Otherwise, it returns one of the STIERR-prefixed error codes defined in stierr.h.

Remarks

If the still image event monitor started the application, the pwszDeviceName and pwszEventName values identify the /StiDevice and /StiEvent command-line arguments (see the description of IStillImage::RegisterLaunchApplication). If the event monitor did not start the application, the method returns STIERR_GENERIC.

Before calling IStillImage::GetSTILaunchInformation, clients of the IStillImage COM interface must call IStillImage::StiCreateInstance to obtain an IStillImage interface pointer.

Requirements

Requirement	Value
Target Platform	Desktop
Header	sti.h (include Sti.h)