diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-accepteula.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-accepteula.md index 19c9fd29376..fd21b21b04b 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-accepteula.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-accepteula.md @@ -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) + IUpdate diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_autoselectonwebsites.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_autoselectonwebsites.md index a3eb3b4ae14..7536e8c6618 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_autoselectonwebsites.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_autoselectonwebsites.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is flagged to be automatically selected by Windows Update, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_bundledupdates.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_bundledupdates.md index a2a6f9137cb..713780a2cb2 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_bundledupdates.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_bundledupdates.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IUpdateCollection** + +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 S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_canrequiresource.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_canrequiresource.md index a64cad014a9..966fc8ae4ca 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_canrequiresource.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_canrequiresource.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the source media of the update is required for installation or uninstallation, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_categories.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_categories.md index 47c59ff1ea4..dc041fc90d7 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_categories.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_categories.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: ICategoryCollection** + +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 S_OK. Otherwise, it returns an HRESULT 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 of the IUpdateSession2 interface of the session that was used to create IUpdateSearcher. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deadline.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deadline.md index 6e98c237246..359a52ce670 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deadline.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deadline.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT* + +A pointer to a variable of type VARIANT. If the update has a deadline, it receives a value of type VT_DATE containing a DATE value specifying the deadline. If the update does not have a deadline, it receives a value of type VT_EMPTY. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentavailable.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentavailable.md index 8b3732873e4..19aa0949136 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentavailable.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentavailable.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if delta-compressed content is available on a server for the update, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentpreferred.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentpreferred.md index fb25032400e..548db3a299b 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentpreferred.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deltacompressedcontentpreferred.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if delta-compressed content is preferred, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deploymentaction.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deploymentaction.md index cbc5f09254f..554c81a01c2 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deploymentaction.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_deploymentaction.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: DeploymentAction* + +A pointer to a variable of type DeploymentAction that receives the action for which the update is deployed. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_description.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_description.md index d4cac9f4db6..5c62ef82f24 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_description.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_description.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the localized description of the update. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadcontents.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadcontents.md index 7ba5b98d7e5..8208dc296f6 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadcontents.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadcontents.md @@ -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: IUpdateDownloadContentCollection** + +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 diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadpriority.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadpriority.md index ec5120e7fa2..e34b169157c 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadpriority.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_downloadpriority.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: DownloadPriority* + +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 S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulaaccepted.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulaaccepted.md index 992ae009a1f..0edc490590e 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulaaccepted.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulaaccepted.md @@ -57,6 +57,18 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the terms are accepted, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also +[AcceptEula method](nf-wuapi-update-accepteula.md) + IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulatext.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulatext.md index df0b067976b..02accd8f473 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulatext.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_eulatext.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the localized license text. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_handlerid.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_handlerid.md index 531a06f2c9c..549b3e4bac1 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_handlerid.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_handlerid.md @@ -48,7 +48,6 @@ api_name: # IUpdate::get_HandlerID - ## -description Gets the install handler of the update. @@ -57,27 +56,25 @@ This property is read-only. ## -parameters -## -remarks +### -param retval [out, retval] -The valid values for the HandlerID property include the following: +Type: BSTR* - +* The Command Line Installation Handler: http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/CommandLineInstallation +* The Inf Based Installation Handler: http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/InfBasedInstallation +* The Windows Installer Installation Handler: http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsInstaller +* The Package Installer for Microsoft Windows Operating Systems and Windows Components (update.exe) Installation Handler: http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsPatch +* The Component Based Servicing (CBS) Handler: http://schemas.microsoft.com/msus/2002/12/UpdateHandlers/Cbs ## -see-also diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_identity.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_identity.md index 46e18691eaf..2e21749df23 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_identity.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_identity.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IUpdateIdentity** + +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 S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_image.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_image.md index 2fca602a3aa..53fc325938e 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_image.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_image.md @@ -57,6 +57,12 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IImageInformation** + +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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_installationbehavior.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_installationbehavior.md index d0e64644651..0b260510edf 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_installationbehavior.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_installationbehavior.md @@ -57,6 +57,12 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IInstallationBehavior** + +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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isbeta.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isbeta.md index 60ed396ac62..8bca25c7508 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isbeta.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isbeta.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is a beta release, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isdownloaded.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isdownloaded.md index 87acd872b9f..a25a5a51dfa 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isdownloaded.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isdownloaded.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is downloaded, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ishidden.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ishidden.md index 2c48ff058e3..a7499c898ac 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ishidden.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ishidden.md @@ -58,10 +58,22 @@ This property is read/write. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is hidden, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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) + IUpdate diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isinstalled.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isinstalled.md index 94fb0ee9e55..041424e37d8 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isinstalled.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isinstalled.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is installed, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ismandatory.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ismandatory.md index 18ad711b9b3..2a95dca1c4b 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ismandatory.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_ismandatory.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update is mandatory, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks If you try to mark a mandatory update as hidden, an error occurs. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isuninstallable.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isuninstallable.md index 83242e1d34a..4d1759dad46 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isuninstallable.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_isuninstallable.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: VARIANT_BOOL* + +A pointer to a variable of type VARIANT_BOOL that receives VARIANT_TRUE if the update can be uninstalled, and VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_kbarticleids.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_kbarticleids.md index a2b33019813..ee1077f3dc0 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_kbarticleids.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_kbarticleids.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing the Knowledge Base article IDs. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_languages.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_languages.md index 7b768da303c..1e15c9eec67 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_languages.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_languages.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing the supported languages. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks This property refers to the language of the update itself. The language that is used for the title and description of the update is not necessarily the language of the update itself. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_lastdeploymentchangetime.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_lastdeploymentchangetime.md index 9d7cb2602c0..cec77c2abdf 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_lastdeploymentchangetime.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_lastdeploymentchangetime.md @@ -57,10 +57,22 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: DATE* + +A pointer that, upon success, receives the last published date of the update. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks On computers that are running Windows XP, the LastDeploymentChangeTime property retrieves the same date and time that are retrieved by the CreationDate property of the IUpdateApproval interface. The CreationDate property is used on computers that are running Windows Server 2003. ## -see-also -IUpdate \ No newline at end of file +IUpdate + +VARIANT \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_maxdownloadsize.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_maxdownloadsize.md index 8e00af0932d..977a9382d9e 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_maxdownloadsize.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_maxdownloadsize.md @@ -57,10 +57,22 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: DECIMAL* + +A pointer that, upon success, receives the maximum download size of the update. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The MinDownloadSize property of an update is always downloaded. However, the MaxDownloadSize property is not always downloaded. The MaxDownloadSize property is downloaded based on the configuration of the computer that receives the update. ## -see-also -IUpdate \ No newline at end of file +IUpdate + +VARIANT \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_mindownloadsize.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_mindownloadsize.md index f9d2769a432..45cd36be5ae 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_mindownloadsize.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_mindownloadsize.md @@ -57,10 +57,22 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: DECIMAL* + +A pointer that, upon success, receives the minimum download size of the update. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The MinDownloadSize property of an update is always downloaded. However, the MaxDownloadSize property is not always downloaded. The MaxDownloadSize property is downloaded based on the configuration of the computer that receives the update. ## -see-also -IUpdate \ No newline at end of file +IUpdate + +VARIANT \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_moreinfourls.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_moreinfourls.md index 377bbdd1cee..e812dad6945 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_moreinfourls.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_moreinfourls.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing hyperlinks to more information about the update. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_msrcseverity.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_msrcseverity.md index 65ab92c0839..9620b596cd4 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_msrcseverity.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_msrcseverity.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the severity rating. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The following ratings are the possible severity ratings of a security issue that is fixed by an update. These ratings were revised by the Microsoft Security Response Center in November 2002. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedcpuspeed.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedcpuspeed.md index f44789f9ab0..4f5f81e4a6b 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedcpuspeed.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedcpuspeed.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: LONG* + +A pointer that, upon success, receives the recommended CPU speed. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The following properties of the IUpdate interface return 0 (zero) when the information is not available: diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedharddiskspace.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedharddiskspace.md index 5f5d089cac4..3f02738a607 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedharddiskspace.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedharddiskspace.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: LONG* + +A pointer that, upon success, receives the recommended free disk space. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The following properties of the IUpdate interface return 0 (zero) when the information is not available: diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedmemory.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedmemory.md index 4952453771b..60d0c5f2cce 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedmemory.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_recommendedmemory.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: LONG* + +A pointer that, upon success, receives the recommended physical memory size. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks The following properties of the IUpdate interface return 0 (zero) when the information is not available: diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_releasenotes.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_releasenotes.md index f5a23e32b9d..e39c86392ab 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_releasenotes.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_releasenotes.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the localized release notes. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_securitybulletinids.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_securitybulletinids.md index 57ec7824ed6..e695cdabc7a 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_securitybulletinids.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_securitybulletinids.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing the security bulletin IDs. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supersededupdateids.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supersededupdateids.md index d02e28d2d5c..f73f2ecd783 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supersededupdateids.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supersededupdateids.md @@ -51,12 +51,22 @@ api_name: ## -description -Gets a collection of update identifiers. This collection of identifiers specifies the updates that are superseded by the update. +Gets a collection of update identifiers. This collection of identifiers specifies the updates that are superseded by this update. This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing the IDs of the superseded updates. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -see-also IUpdate \ No newline at end of file diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supporturl.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supporturl.md index 9890d92a85f..6c91092179c 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supporturl.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_supporturl.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the hyperlink to the support information. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_title.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_title.md index af52439e7e3..eb3e60d5c1e 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_title.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_title.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the localized title of the update. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_type.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_type.md index 648169e40c2..6ecd6504311 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_type.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_type.md @@ -57,9 +57,13 @@ This property is read-only. ## -parameters -### -param retval +### -param retval [out, retval] -A member of the [UpdateType](ne-wuapi-updatetype.md) enumeration specifying the type of the update. +A pointer to a variable of type [UpdateType](ne-wuapi-updatetype.md) that receives the type of the update. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. ## -see-also diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationbehavior.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationbehavior.md index 6a742e1bc38..c59297f9b0d 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationbehavior.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationbehavior.md @@ -57,6 +57,12 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IInstallationBehavior** + +A pointer that, upon success, receives a pointer to an [IInstallationBehavior](nn-wuapi-iinstallationbehavior.md) containing the uninstallation options of the update. + ## -returns Returns S_OK if successful. Otherwise, returns a COM or Windows error code. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationnotes.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationnotes.md index 3ccab666096..d6e61b97622 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationnotes.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationnotes.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: BSTR* + +A pointer to a variable of type BSTR that receives the uninstallation notes. The caller must free this memory with the SysFreeString function when it is no longer required. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationsteps.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationsteps.md index 2c28a4b1fca..bdee3fdf578 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationsteps.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-get_uninstallationsteps.md @@ -57,6 +57,16 @@ This property is read-only. ## -parameters +### -param retval [out, retval] + +Type: IStringCollection** + +A pointer that, upon success, receives a pointer to an [IStringCollection](nn-wuapi-istringcollection.md) containing the uninstallation steps. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT 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. diff --git a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-put_ishidden.md b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-put_ishidden.md index e63ef38fb10..3698638b3b8 100644 --- a/sdk-api-src/content/wuapi/nf-wuapi-iupdate-put_ishidden.md +++ b/sdk-api-src/content/wuapi/nf-wuapi-iupdate-put_ishidden.md @@ -52,16 +52,28 @@ api_name: ## -description -Gets a Boolean value that indicates whether an update is hidden by a user. Administrators, users, and power users can retrieve the value of this property. However, only administrators and members of the Power Users administrative group can set the value of this property. +Sets a Boolean value that indicates whether an update is hidden by a user. Administrators, users, and power users can retrieve the value of this property. However, only administrators and members of the Power Users administrative group can set the value of this property. This property is read/write. ## -parameters +### -param retval [in] + +Type: VARIANT_BOOL + +VARIANT_TRUE if the update is to be hidden, VARIANT_FALSE if not. + +## -returns + +If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. + ## -remarks An attempt to mark a mandatory update as hidden causes an error. ## -see-also +[IsHidden getter](nf-wuapi-iupdate-get_ishidden.md) + IUpdate