OSD_SetOEMWallpaper

Owned by Martin Gudme Søndergaard
Last updated: Oct 23, 2024 by Mitesh Oliver Sahijpal
1 min read

OSD_SetOEMWallpaper()

Changes the default Windows login wallpaper to one specified by the customer.

Arguments

No arguments provided.

Return Type

Boolean, TRUE if function completed successfully.

Wallpaper files

The wallpaper file to be used must already exist on the disk in the following locations.

OPERATING SYSTEM

FILE NAME

LOCATION

Windows 8, 8.1, 10, Windows Server 2012 / 2012 R2,backgroundDefault.jpg<target drive>:\Windows\System32\oobe\info\backgrounds\

Windows 7, Windows Server 2008 / 2008R2

backgroundDefault.jpg

<target drive>:\Windows\System32\oobe\info\backgrounds\

Windows XP, Windows Server 2003 / 2003R2

InstallationWallpaper.bmp

<target drive>:\Windows\System32\

Remarks

Typically used in the PreBootScript.wsf
The wallpaper files can be placed on the filesystem using the OSD extra files feature, which allows for adding additional files to the filesystem once the image has been applied.

Example

The following example specifies that a custom wallpaper should be used.

Private Function IncludeScript(sScriptFile)
 '...
End Function

'Begin
  bStatus=True
  If bStatus Then bStatus=IncludeScript("customlib.cis")
  If bStatus Then bStatus=IncludeLibrary("Capalib.cin")
  If bStatus Then bStatus=IncludeLibrary("Osdlib.cin")
  If bStatus Then bStatus=Job_Start("WS","Script Name","1.0","ScriptName.log","INSTALL")
  If bStatus Then bStatus=OSD_Initialize()

  If bStatus Then bStatus=OSD_SetOEMWallpaper()

  Job_End(bStatus)
'End main

See Also

IncludeScript function