. DirectXtras Home
        Home

DirectCommunication Xtra
DirectConnection Xtra
DirectControl Xtra
DirectEmail Xtra
DirectFTP Xtra
DirectImage Xtra
DirectInteraction Xtra
DirectOS Xtra
Documentation
License Agreement
Licensing Fees
Order Form
DirectSMS Xtra
DirectSound Xtra
DirectTransition Xtra
DirectTransition3D Xtra Set I
DirectTransition3D Xtra Set II
DirectTransition3D Xtra Set III
DirectTTS Xtra
XtrAgent
DirectXport Xtra

SpeechPlugin

Special Discounted Bundles

The Gallery
How To Order
Order Form
Check for Upgrades

Sign in
Change Your Profile

Contact Us
















    .
DirectXtras
Xtra Power for Director & Authorware



DirectOS Xtra
 Directing Windows and MacOS. The OS at your fingertips!

Authorware 4.x Compatible Authorware 5.x CompatibleAuthorware 6.x CompatibleAuthorware 7.x CompatibleDirector 5.x Compatible Director 6.x CompatibleDirector 7.x Compatible Director 8.x CompatibleDirector MX Compatible     MacOS 8.x and 9.x CompatibleMacOS X CompatibleWindows Compatible   

dosSetWallpaper(string FileName, string DisplayMode)

Sets the image file of the desktop wallpaper.

Parameter :

FileName : A string specifying the full pathname of a valid image file. To remove the desktop wallpaper, set this parameter to an empty string.

DisplayMode : A case insensitive string specifying how to display the wallpaper. This parameter is ignored on MacOS X.

Possible Values :
"Centered" :
Displays the wallpaper image in its original size in the middle of the desktop.
"Tiled" : Repeatedly displays the wallpaper image all over the desktop.
"Stretched" : Stretches the wallpaper image to cover the entire desktop area. This flag is not available on Windows 95 and Windows NT.

Return Value : An integer indicating whether the method was successful. If 1 is returned, the method was successful. If 0 is returned, the method was not successful is which case dosGetLastError() should be called to determine the cause of the error. 

Possible Returned Error Codes via dosGetLastError() :
10000 :
Out of memory. 
10002 :
Invalid value for parameter 2.
10014 : File expected. A reference to a drive or folder was given. 
10016 : File not found. 
10022 : Method is not supported on Windows 95 or Windows NT for the particular DisplayMode.
11100 : Appearance Manager is not installed (MacOS classic only).
11101 :
Appearance Manager is too old (MacOS classic only). Version 1.1 or later is required for this feature.

Remarks : The function does not perform error checking as to whether the file specified by FileName is a valid image file for a desktop wallpaper. On Windows, the specified file should be a BMP file. You can use our DirectImage Xtra to convert, at runtime, the specified image file format to BMP prior to calling this function.



DirectXtras Inc.
P.O Box 2645, Menlo Park, CA, 94026, U.S.A
Voice: +1-415-5058249, Fax: +1-801-8585841
Toll Free: 1-800-4453093
E-mail General Information: info@directxtras.com
E-mail Technical Support: support@directxtras.com

Copyright 1996-2004 DirectXtras Inc. All Rights Reserved.
WebMaster: tamar@directxtras.com
Last Updated: 12/19/2002 2:52:56 AM.