IStillImageW::GetDeviceInfo method (sti.h)

Article
02/22/2024

The IStillImage::GetDeviceInfo method returns hardware characteristics for a specified still image device.

Syntax

HRESULT GetDeviceInfo(
  [in]  LPWSTR pwszDeviceName,
  [out] LPVOID *ppBuffer
);

Parameters

[in] pwszDeviceName

Caller-supplied pointer to a string representing an internal device name, obtained by calling IStillImage::GetSTILaunchInformation or IStillImage::GetDeviceList.

[out] ppBuffer

Receives a handle to an STI_DEVICE_INFORMATION structure.

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

The IStillImage::GetDeviceInfo method returns an STI_DEVICE_INFORMATION structure for the specified still-image device. Structure contents are typically used for creating user interface displays.

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

When the caller has finished using the STI_DEVICE_INFORMATION structure referenced by ppBuffer, it must deallocate the buffer by calling LocalFree (described in the Microsoft Windows SDK documentation).

Requirements

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