v2.22
IImage Interface Reference

A compressed image data container. More...

Inheritance diagram for IImage:

Public Member Functions

HRESULT LoadFromData ([in] SAFEARRAY(byte) data, [in] enum ImageFormat format)
 Loads an image from the given binary data. More...
 
HRESULT LoadFromFile ([in] BSTR path_)
 Loads an image from the given image file. More...
 
HRESULT SaveToFile ([in] BSTR path_, [in] enum ImageFormat format)
 Saves an image to the given image file. More...
 
HRESULT SaveToData ([in] enum ImageFormat format, [out, retval] SAFEARRAY(byte) *pData)
 Saves an image to data. More...
 

Detailed Description

A compressed image data container.

The IAction interface uses IImage to represent icons. The same image can be used by multiple actions simultaneously.

/sa IAction

Member Function Documentation

◆ LoadFromData()

HRESULT IImage::LoadFromData ( [in] SAFEARRAY(byte)  data,
[in] enum ImageFormat  format 
)

Loads an image from the given binary data.

Parameters
[in]dataBinary data to load the image from.
[in]formatFormat of the image.

◆ LoadFromFile()

HRESULT IImage::LoadFromFile ( [in] BSTR  path_)

Loads an image from the given image file.

Parameters
[in]path_Path to the image file.

◆ SaveToData()

HRESULT IImage::SaveToData ( [in] enum ImageFormat  format,
[out, retval] SAFEARRAY(byte) *  pData 
)

Saves an image to data.

Parameters
[in]formatFormat of the image received as data.
[out]pDataBytes array of the saved image.

◆ SaveToFile()

HRESULT IImage::SaveToFile ( [in] BSTR  path_,
[in] enum ImageFormat  format 
)

Saves an image to the given image file.

Parameters
[in]path_Path to the file to save the image.
[in]formatFormat of the image.