Partager via


IUpdate::Description property

Gets the localized description of the update.

This property is read-only.

Syntax

HRESULT get_Description(
  [out] BSTR *retval
);

Property value

The localized description of the update.

Error codes

Returns S_OK if successful. Otherwise, returns a COM or Windows error code.

Remarks

If the IUpdateSearcher interface is created by using the IUpdateSession::CreateUpdateSearcher method, the information that this property returns is for the language that is specified by the UserLocale property. This is the UserLocale property of the IUpdateSession2 interface of the session that is used to create IUpdateSearcher.

If a language preference is not specified by the UserLocale property of IUpdateSession2, or if the IUpdateSearcher interface is not created by using IUpdateSession::CreateUpdateSearcher, the information that is returned by this property is for the default user interface (UI) language of the user. If the default UI language of the user is unavailable, Windows Update Agent (WUA) uses the default UI language of the computer. If the default language of the computer is unavailable, WUA uses the language that the provider of the update recommends.

Requirements

Minimum supported client

Windows XP, Windows 2000 Professional with SP3 [desktop apps only]

Minimum supported server

Windows Server 2003, Windows 2000 Server with SP3 [desktop apps only]

Header

Wuapi.h

IDL

Wuapi.idl

Library

Wuguid.lib

DLL

Wuapi.dll

See also

IUpdate