HeifContextAddUserDescriptionProperty(HeifImageHandle, UserDescriptionProperty) Method

Adds an user description property to the specified image.

Definition

Namespace: LibHeifSharp
Assembly: LibHeifSharp (in LibHeifSharp.dll) Version: 3.2.0
C#
public void AddUserDescriptionProperty(
	HeifImageHandle imageHandle,
	UserDescriptionProperty userDescription
)

Parameters

imageHandle  HeifImageHandle
The image handle.
userDescription  UserDescriptionProperty
The user description.

Remarks

This method is supported starting with LibHeif version 1.16.0, it will throw an exception on older versions.

Exceptions

ArgumentNullExceptionimageHandle is . -or- userDescription is .
HeifExceptionA LibHeif error occurred.
ObjectDisposedExceptionThe object has been disposed.

See Also