Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-accepteula.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,6 @@ The Microsoft Software License Terms for the update could not be located.

## -see-also

[EulaAccepted property](nf-wuapi-iupdate-get_eulaaccepted.md)

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the update is flagged to be automatically selected by Windows Update, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_bundledupdates.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>IUpdateCollection**</b>

A pointer that, upon success, receives a pointer to an [IUpdateCollection](nn-wuapi-iupdatecollection.md) containing the bundled updates for the update.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_canrequiresource.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the source media of the update is required for installation or uninstallation, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>ICategoryCollection**</b>

A pointer that, upon success, receives a pointer to an [ICategoryCollection](nn-wuapi-icategorycollection.md) containing the categories.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -remarks

If the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesearcher">IUpdateSearcher</a> interface is created by using the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession-createupdatesearcher">IUpdateSession::CreateUpdateSearcher</a> method, the information that this property returns is for the language that is specified by the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession2-get_userlocale">UserLocale</a> property of the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesession2">IUpdateSession2</a> interface of the session that was used to create <b>IUpdateSearcher</b>.
Expand Down
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deadline.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant">VARIANT</a>. If the update has a deadline, it receives a value of type <b>VT_DATE</b> containing a <b>DATE</b> value specifying the deadline. If the update does not have a deadline, it receives a value of type <b>VT_EMPTY</b>.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -remarks

In COM, if the update has a deadline, the return value is of type VT_DATE and contains a DATE value that specifies the deadline. Otherwise, the return value is of type VT_EMPTY.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if delta-compressed content is available on a server for the update, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if delta-compressed content is preferred, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deploymentaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>DeploymentAction*</b>

A pointer to a variable of type <a href="/windows/win32/api/wuapi/ne-wuapi-deploymentaction">DeploymentAction</a> that receives the action for which the update is deployed.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_description.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>BSTR*</b>

A pointer to a variable of type <a href="/previous-versions/windows/desktop/automat/bstr">BSTR</a> that receives the localized description of the update. The caller must free this memory with the <a href="/windows/win32/api/oleauto/nf-oleauto-sysfreestring">SysFreeString</a> function when it is no longer required.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -remarks

If the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesearcher">IUpdateSearcher</a> interface is created by using the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession-createupdatesearcher">IUpdateSession::CreateUpdateSearcher</a> method, the information that this property returns is for the language that is specified by the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession2-get_userlocale">UserLocale</a> property. This is the <b>UserLocale</b> property of the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesession2">IUpdateSession2</a> interface of the session that is used to create <b>IUpdateSearcher</b>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,11 @@ This property is read-only.

## -parameters

### -param retval
### -param retval [out, retval]

An [IUpdateDownloadContentCollection](nn-wuapi-iupdatedownloadcontentcollection.md) that allows you to enumerate the URLs for download contents associated with an update.
Type: <b>IUpdateDownloadContentCollection**</b>

A pointer that, upon success, receives a pointer to an [IUpdateDownloadContentCollection](nn-wuapi-iupdatedownloadcontentcollection.md) that allows you to enumerate the URLs for download contents associated with an update.

## -see-also

Expand Down
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadpriority.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>DownloadPriority*</b>

A pointer to a variable of type [DownloadPriority](ne-wuapi-downloadpriority.md) that receives the suggested download priority of the update.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
12 changes: 12 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulaaccepted.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the terms are accepted, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

[AcceptEula method](nf-wuapi-update-accepteula.md)

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulatext.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>BSTR*</b>

A pointer to a variable of type <a href="/previous-versions/windows/desktop/automat/bstr">BSTR</a> that receives the localized license text. The caller must free this memory with the <a href="/windows/win32/api/oleauto/nf-oleauto-sysfreestring">SysFreeString</a> function when it is no longer required.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -remarks

If the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesearcher">IUpdateSearcher</a> interface is created by using the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession-createupdatesearcher">IUpdateSession::CreateUpdateSearcher</a> method, the information that this property returns is for the language that is specified by the <a href="/windows/desktop/api/wuapi/nf-wuapi-iupdatesession2-get_userlocale">UserLocale</a> property. This is the <b>UserLocale</b> property of the <a href="/windows/desktop/api/wuapi/nn-wuapi-iupdatesession2">IUpdateSession2</a> interface of the session that is used to create <b>IUpdateSearcher</b>.
Expand Down
27 changes: 12 additions & 15 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_handlerid.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ api_name:

# IUpdate::get_HandlerID


## -description

Gets the install handler of the update.
Expand All @@ -57,27 +56,25 @@ This property is read-only.

## -parameters

## -remarks
### -param retval [out, retval]

The valid values for the <b>HandlerID</b> property include the following:
Type: <b>BSTR*</b>

<ul>
<li>The Command Line Installation Handlerhttp://schemas.microsoft.com/msus/2002/12/UpdateHandlers/CommandLineInstallation
A pointer to a variable of type <a href="/previous-versions/windows/desktop/automat/bstr">BSTR</a> that receives the identifier of the install handler. The caller must free this memory with the <a href="/windows/win32/api/oleauto/nf-oleauto-sysfreestring">SysFreeString</a> function when it is no longer required.

</li>
<li>The Inf Based Installation Handlerhttp://schemas.microsoft.com/msus/2002/12/UpdateHandlers/InfBasedInstallation
## -returns

</li>
<li>The <a href="/windows/desktop/Msi/windows-installer-portal">Windows Installer</a> Installation Handlerhttp://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsInstaller
If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

</li>
<li>The Package Installer for Microsoft Windows Operating Systems and Windows Components (update.exe) Installation Handlerhttp://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsPatch
## -remarks

</li>
<li>The Component Based Servicing (CBS) Handlerhttp://schemas.microsoft.com/msus/2002/12/UpdateHandlers/Cbs
The valid values for the <b>HandlerID</b> property include the following:

</li>
</ul>
* The Command Line Installation Handler: <code>http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/CommandLineInstallation</code>
* The Inf Based Installation Handler: <code>http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/InfBasedInstallation</code>
* The <a href="/windows/desktop/Msi/windows-installer-portal">Windows Installer</a> Installation Handler: <code>http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsInstaller</code>
* The Package Installer for Microsoft Windows Operating Systems and Windows Components (update.exe) Installation Handler: <code>http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsPatch</code>
* The Component Based Servicing (CBS) Handler: <code>http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/Cbs</code>

## -see-also

Expand Down
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>IUpdateIdentity**</b>

A pointer that, upon success, receives a pointer to an [IUpdateIdentity](nn-wuapi-iupdateidentity.md) containing the unique identifier of the update.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
6 changes: 6 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>IImageInformation**</b>

A pointer that, upon success, receives a pointer to an [IImageInformation](nn-wuapi-iimageinformation.md) containing the image information.

## -returns

Returns S_OK if successful. Otherwise, returns a COM or Windows error code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>IInstallationBehavior**</b>

A pointer that, upon success, receives a pointer to an [IInstallationBehavior](nn-wuapi-iinstallationbehavior.md) containing the installation options of the update.

## -returns

Returns S_OK if successful. Otherwise, returns a COM or Windows error code.
Expand Down
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isbeta.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the update is a beta release, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
10 changes: 10 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isdownloaded.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ This property is read-only.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the update is downloaded, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -see-also

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
Expand Down
12 changes: 12 additions & 0 deletions sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ishidden.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,22 @@ This property is read/write.

## -parameters

### -param retval [out, retval]

Type: <b>VARIANT_BOOL*</b>

A pointer to a variable of type <a href="/windows/win32/api/oaidl/ns-oaidl-variant#__variant_name_2__variant_name_3bool">VARIANT_BOOL</a> that receives <b>VARIANT_TRUE</b> if the update is hidden, and <b>VARIANT_FALSE</b> if not.

## -returns

If this method succeeds, it returns <b>S_OK</b>. Otherwise, it returns an <b>HRESULT</b> error code.

## -remarks

An attempt to mark a mandatory update as hidden causes an error.

## -see-also

[IsHidden setter](nf-wuapi-iupdate-put_ishidden.md)

<a href="/windows/desktop/api/wuapi/nn-wuapi-iupdate">IUpdate</a>
Loading