Edit

IWiaPropertyStorage::GetPropertyStream method (wia_xp.h)

  • Article

The IWiaPropertyStorage::GetPropertyStream method retrieves the property stream of an item.

Syntax

HRESULT GetPropertyStream(
  [out] GUID    *pCompatibilityId,
  [out] IStream **ppIStream
);

Parameters

[out] pCompatibilityId

Type: GUID*

Receives a unique identifier for a set of property values.

[out] ppIStream

Type: IStream**

Pointer to a stream that receives the item properties. For more information, see IStream.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Applications use this method to get a snapshot of the current properties of an item. These are subsequently restored by calling IWiaPropertyStorage::SetPropertyStream.

Applications can use the pCompatibilityID parameter to check if a device supports a specific set of property values before attempting to write these values to the device.

When it is finished using the item's property stream, the application must release it.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wia_xp.h (include Wia.h)
Library Wiaguid.lib
DLL Wiaservc.dll

See also

IPropertyStorage

IWiaPropertyStorage