SetClientWallPaper method of the Win32_TSEnvironmentSetting class

The SetClientWallPaper method sets the ClientWallPaper property.

Syntax

uint32 SetClientWallPaper(
  [in] uint32 ClientWallPaper
);

Parameters

ClientWallPaper [in]

Flag disabling or enabling the ClientWallPaper property, which specifies whether the background (or wallpaper) image is displayed on the client.

0

The background (or wallpaper) image is not displayed on the client.

1

The background (or wallpaper) image is displayed on the client.

Return value

Returns 0 on success, otherwise returns a WMI error code. Refer to Remote Desktop Services WMI Provider Error Codes for a list of these values. The method returns an error if the setting is under group policy control.

Remarks

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Namespace
Root\CIMv2\TerminalServices
MOF
TSCfgWmi.mof
DLL
TSCfgWmi.dll

See also

Win32_TSEnvironmentSetting