SetDesktopImageURLForScreenOptionsError Method (url, screen, options, error)

Sets the desktop image for the given screen to the image at the specified URL.

Original signature is '- (BOOL)setDesktopImageURL:(NSURL *)url forScreen:(NSScreen *)screen options:(NSDictionary *)options error:(NSError **)error'

Available in Mac OS X v10.6 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual bool SetDesktopImageURLForScreenOptionsError(
	NSURL url,
	NSScreen screen,
	NSDictionary options,
	out NSError error
)

Public Overridable Function SetDesktopImageURLForScreenOptionsError ( _
	url As NSURL, _
	screen As NSScreen, _
	options As NSDictionary, _
	<OutAttribute> ByRef error As NSError _
) As Boolean

public:
virtual bool SetDesktopImageURLForScreenOptionsError(
	NSURL^ url, 
	NSScreen^ screen, 
	NSDictionary^ options, 
	[OutAttribute] NSError^% error
)

Parameters

url (NSURL): A file URL to the image. The URL must not be nil.

screen (NSScreen): The screen to set the desktop image on.

options (NSDictionary): The options dictionary may contain any of the “Desktop Image Dictionary Keys” keys, which control how the image is scaled on the screen.

error (NSError%): A error that is returned by-reference if setting the image fails.

Return Value

YES if the image was set as the desktop, otherwise NO. If NO is returned, the error parameter provides additional information.

Version Information

Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later)

Assembly: Monobjc.AppKit (Module: Monobjc.AppKit)