IStillImageW::GetDeviceValue method (sti.h)

Article
10/21/2021

The IStillImage::GetDeviceValue method returns registry information associated with a specified still image device.

Syntax

HRESULT GetDeviceValue(
  [in]      LPWSTR  pwszDeviceName,
  [in]      LPWSTR  pValueName,
  [out]     LPDWORD pType,
  [out]     LPBYTE  pData,
  [in, out] LPDWORD cbData
);

Parameters

[in] pwszDeviceName

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

[in] pValueName

Caller-supplied pointer to a string representing a registry value name.

[out] pType

Receives a constant representing the data type of the returned registry value.

[out] pData

Caller-supplied pointer to a buffer to receive a returned value.

[in, out] cbData

Caller-supplied size, in bytes, of the buffer pointed to by pData. The method modifies this value to represent the size of the returned data. If the specified buffer size is too small, the method supplies the required buffer size and returns an error code.

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 purpose of the IStillImage::GetDeviceValue method is to return the values currently assigned to device-specific Registry Entries for Still Image Devices. The method calls RegQueryValueEx (described in the Microsoft Windows SDK documentation).

The IStillImage::GetDeviceValue method can return either an ANSI or a Unicode string. It can return a Unicode string only if your code is built as Unicode with Unicode defined.

Before calling IStillImage::GetDeviceValue, 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)