TSLNTSurface Class Reference

Inheritance diagram for TSLNTSurface:

Detailed Description

Windows NT specific implementation of the abstract TSLDrawingSurface class.

Non-Native Rendering

Non-native rendering is not supported with this drawing surface.

Public Member Functions
	TSLNTSurface ()
	TSLNTSurface (TSLDeviceContext handle)
	TSLNTSurface (TSLWindowHandle handle)
virtual	~TSLNTSurface ()
virtual TSLDrawingSurface *	clone (bool copyUserData=false)
TSLStyleID	colourValue (int index)
bool	drawToHDC (TSLDeviceContext hDC, double x1, double y1, double x2, double y2, bool clear, int horizontalSizeMM=0, int verticalSizeMM=0, int horizontalSizePixels=0, int verticalSizePixels=0)
bool	fillStyleValue (int index, int colour, HBITMAP bitmap, TSLSimpleString *section=0)
bool	fontStyleValue (int index, int colour, HBITMAP bitmap, TSLSimpleString *fontName=0, const char *outputString=0, TSLSimpleString *section=0)
bool	lineStyleValue (int index, int colour, int thickness, HBITMAP bitmap, TSLSimpleString *section=0)
bool	symbolStyleValue (int index, int colour, HBITMAP bitmap, uint32_t fontSymbolCharacter=0, TSLRasterSymbolScalable rasterSymbolScalability=TSLRasterSymbolScalableAsSymbolFile, TSLSimpleString *section=NULL, TSLSimpleString *description=NULL, int *originX=NULL, int *originY=NULL)
void *	operator new (size_t size) TSL_NO_THROW
void	operator delete (void *self)
void *	operator new (size_t size, char *filename, int line)
Public Member Functions inherited from TSLDrawingSurface
bool	clearAllRendering ()
bool	clearDynamicColours ()
TSLRasterBuffer *	createRasterBuffer (unsigned int width, unsigned int height, TSLRasterBuffer::Format format, TSLRasterBuffer::FilterMode filterMode=TSLRasterBuffer::Linear)
bool	declutterIsVisible (const char *feature_name, double resolution=0.0, const char *layer_name=0) const
bool	drawDU (TSLDeviceUnits x1, TSLDeviceUnits y1, TSLDeviceUnits x2, TSLDeviceUnits y2, bool clear, bool updateExtentOnly=false)
bool	drawUU (double x1, double y1, double x2, double y2, bool clear, bool updateExtentOnly=false)
bool	DUToLatLong (TSLDeviceUnits x, TSLDeviceUnits y, double *latitude, double *longitude, bool local=false, bool boundCheck=true) const
bool	DUToMU (TSLDeviceUnits x1, TSLDeviceUnits y1, double *x2, double *y2) const
bool	DUToTMC (TSLDeviceUnits x1, TSLDeviceUnits y1, TSLTMC *x2, TSLTMC *y2) const
bool	DUToUU (TSLDeviceUnits x1, TSLDeviceUnits y1, double *x2, double *y2) const
TSLEntity *	findEntityDU (TSLDeviceUnits x, TSLDeviceUnits y, TSLDeviceUnits aperture, int depth, const char *feature_name=NULL)
TSLEntity *	findEntityUU (double x, double y, double aperture, int depth, const char *feature_name=NULL)
TSLEntity *	findSelectedEntityDU (TSLDeviceUnits x, TSLDeviceUnits y, TSLDeviceUnits aperture, int depth=-1, bool ignoreMapDataLayers=false)
TSLEntity *	findSelectedEntityUU (double x, double y, double aperture, int depth=-1, bool ignoreMapDataLayers=false)
bool	getColourIndices (int **indices, int *num)
TSLDataLayer *	getCoordinateProvidingLayer ()
const TSLDataLayer *	getCoordinateProvidingLayer () const
bool	getDeclutterRange (const char *featureName, double *innerLimit, double *outerLimit, const char *dataLayerName=0, const char *detailLayerName=0)
bool	getDeviceCapabilities (int &horizontalSizeMM, int &verticalSizeMM, int &horizontalSizePixels, int &verticalSizePixels) const
bool	getDeviceCapabilities (TSLDeviceCapabilities &capabilities) const
void	getDUExtent (TSLDeviceUnits *x1, TSLDeviceUnits *y1, TSLDeviceUnits *x2, TSLDeviceUnits *y2) const
bool	getFillStyleIndices (int **indices, int *num)
bool	getFontStyleIndices (int **indices, int *num)
bool	getLineStyleIndices (int **indices, int *num)
void	getMUExtent (double *x1, double *y1, double *x2, double *y2) const
bool	getSymbolStyleIndices (int **indices, int *num)
TSLDrawingSurfaceTiledBufferControl *	getTiledBufferController ()
void	getTMCExtent (TSLEnvelope &extent) const
void	getUUExtent (double *x1, double *y1, double *x2, double *y2) const
bool	getViewedLatLongRange (double *latitude, double *longitude, double *range, bool local=false, bool boundCheck=true) const
bool	latLongToDU (double latitude, double longitude, TSLDeviceUnits *x, TSLDeviceUnits *y, bool local=false) const
bool	latLongToMU (double latitude, double longitude, double *x, double *y, bool local=false) const
bool	latLongToTMC (double latitude, double longitude, TSLTMC *x, TSLTMC *y, bool local=false) const
bool	latLongToUU (double latitude, double longitude, double *x, double *y, bool local=false) const
bool	MUToDU (double x1, double y1, TSLDeviceUnits *x2, TSLDeviceUnits *y2) const
bool	MUToLatLong (double x, double y, double *latitude, double *longitude, bool local=false, bool boundCheck=true) const
bool	MUToTMC (double x1, double y1, TSLTMC *x2, TSLTMC *y2) const
bool	MUToUU (double x1, double y1, double *x2, double *y2) const
bool	pan (double x1, double y1, bool auto_redraw=true)
bool	pan (double x1, double y1, TSLDeviceUnits xDU, TSLDeviceUnits yDU, bool auto_redraw=true)
TSLMapQuery *	query (const char *layerName, TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, int depth=-1, const char *feature_name=NULL) const
TSLMapQuery *	query (const char *layerName, TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, TSLSelector *selector) const
bool	redraw ()
bool	reset (bool auto_redraw=true)
bool	resize (double x1, double y1, double x2, double y2, bool auto_redraw=true, bool keep_aspect=false)
bool	rotate (double angle)
double	rotation () const
bool	setDeclutterRange (const char *featureName, double innerLimit, double outerLimit, const char *dataLayerName=0, const char *detailLayerName=0)
bool	setDeviceCapabilities (const int horizontalSizeMM=0, const int verticalSizeMM=0, const int horizontalSizePixels=0, const int verticalSizePixels=0)
bool	setDeviceCapabilities (const TSLDeviceCapabilities &capabilities)
void	setRedrawCallback (TSLDrawingSurfaceDrawCallback *callback)
bool	setupDynamicColours (const char *filename)
bool	setViewedLatLongRange (double latitude, double longitude, double range, bool local=false, bool auto_redraw=true, bool keep_aspect=false)
void	TMCperDU (double &xr, double &yr)
double	TMCperUU ()
bool	TMCToDU (TSLTMC x1, TSLTMC y1, TSLDeviceUnits *x2, TSLDeviceUnits *y2) const
bool	TMCToLatLong (TSLTMC x, TSLTMC y, double *latitude, double *longitude, bool local=false, bool boundCheck=true) const
bool	TMCToMU (TSLTMC x1, TSLTMC y1, double *x2, double *y2) const
bool	TMCToUU (TSLTMC x1, TSLTMC y1, double *x2, double *y2) const
bool	updateEntityExtent (TSLEntity *entity, const char *layerName)
void	userUnitOrigin (double x_origin, double y_origin)
void	userUnitOrigin (TSLUUEnum origin_enum)
void	userUnits (double factor)
double	userUnits ()
bool	UUToDU (double x1, double y1, TSLDeviceUnits *x2, TSLDeviceUnits *y2) const
bool	UUToLatLong (double x, double y, double *latitude, double *longitude, bool local=false, bool boundCheck=true) const
bool	UUToMU (double x1, double y1, double *x2, double *y2) const
bool	UUToTMC (double x1, double y1, TSLTMC *x2, TSLTMC *y2) const
void	wrapAroundMode (WrapAroundMode mode)
WrapAroundMode	wrapAroundMode () const
bool	wndResize (TSLDeviceUnits x1, TSLDeviceUnits y1, TSLDeviceUnits x2, TSLDeviceUnits y2, bool auto_redraw=true, TSLResizeActionEnum action=TSLResizeActionNone)
bool	zoom (double percent, bool zoom_in, bool auto_redraw=true)
	TSLDrawingSurface ()
virtual	~TSLDrawingSurface ()
void	clearSymbolList ()
void	clearFontList ()
void	clearLineList ()
void	clearFillList ()
bool	removeFillStyle (TSLStyleID style)
bool	removeLineStyle (TSLStyleID style)
bool	removeSymbolStyle (TSLStyleID style)
bool	removeFontStyle (TSLStyleID style)
TSLStyleID	createFontID (const TSLSimpleString &name, TSLFontType meaningOfName, int fontWeight, bool italic=false, bool underline=false, bool antiAliased=false, const unsigned char *memoryBlock=NULL, TSLSize memoryBlockSize=0)
TSLStyleID	createStandardLineID (const unsigned char *pattern, TSLSize patternLength, int initialOffset, TSLLineScalingType scaleType)
TSLStyleID	createSymbolLineID (int symbolID, double size=0.0, TSLDimensionUnits sizeUnits=TSLDimensionUnitsUndefined, float rotation=0.0f, double anchorPointX=0.0, double anchorPointY=0.0, TSLDimensionUnits anchorPointUnits=TSLDimensionUnitsUndefined)
TSLStyleID	createStandardFillID (const unsigned char *pattern=NULL, TSLSize patternSizeInBytes=0, int patternXSize=0, int patternYSize=0)
TSLStyleID	createSymbolFillID (int symbolID, double size=0.0, TSLDimensionUnits sizeUnits=TSLDimensionUnitsUndefined, float rotation=0.0f, double anchorPointX=0.0, double anchorPointY=0.0, TSLDimensionUnits anchorPointUnits=TSLDimensionUnitsUndefined)
TSLStyleID	createSVGSymbolID (const TSLSimpleString &name, const unsigned char *memoryBlock=NULL, TSLSize memoryBlockSize=0)
TSLStyleID	createFontSymbolID (const TSLSimpleString &name, TSLFontType meaningOfName, const unsigned char *memoryBlock=NULL, TSLSize memoryBlockSize=0)
TSLStyleID	createRasterSymbolID (const TSLSimpleString &name, int xorigin, int yorigin, bool scaleable, const unsigned char *memoryBlock=NULL, TSLSize memoryBlockSize=0)
TSLStyleID	createSymbolIDFromSymbol (TSLStyleID symbolID, int numberofColourPairs, const int *colourFrom, const int *colourTo)
Public Member Functions inherited from TSLDrawingSurfaceBase
bool	addDataLayer (TSLDataLayer *data_layer_interface, const char *data_id)
bool	addDynamicRenderer (TSLDynamicRenderer *renderer, TSLFeatureID featureID=-1, const char *layerName=0)
bool	addFeatureRendering (const char *featureName, TSLFeatureID featureID)
void	attach (TSLDeviceContext handle)
void	attach (TSLWindowHandle handle)
void	attach (TSLDrawableHandle handle)
bool	bringInFrontof (const char *move_data_layer, const char *target_data_layer)
bool	bringToFront (const char *move_data_layer)
bool	clearAllDeclutterData (const char *layer_name=0)
void	clearAllDynamicRenderers ()
bool	clearBackgroundColour ()
bool	clearDeclutterData (const char *feature_name, const char *layer_name=0)
bool	clearDynamicRenderer (TSLFeatureID featureID=-1, const char *layerName=0)
bool	clearFeatureRendering (const char *featureName, TSLFeatureID featureID)
bool	clearFrame ()
bool	copyDeclutterData (const char *src_feature_name, const char *dest_feature_name, const char *src_layer_name=0, const char *dest_layer_name=0)
void	detach ()
void	detachAllDynamicRenderers ()
bool	detachDynamicRenderer (TSLFeatureID featureID=-1, const char *layerName=0)
const char *	featureClass (TSLFeatureID feature_id)
bool	forceLayer (const char *data_id, const char *detail_layer_name)
bool	getBackgroundColour (TSLStyleID *value)
bool	getColourValue (int colour, unsigned char &r, unsigned char &g, unsigned char &b)
TSLDataLayer *	getDataLayer (const char *data_id)
bool	getDataLayerInfo (int N, TSLDataLayer **dataLayer, const char **layerName) const
bool	getDataLayerProps (const char *data_id, TSLPropertyEnum property_id, TSLPropertyValue *old_value)
bool	getDeclutterStatus (const char *feature_name, TSLDeclutterStatusResultEnum *value, const char *dataLayerName=0, const char *detailLayerName=0)
bool	getDeclutterStatus (TSLFeatureID feature_id, TSLDeclutterStatusResultEnum *value, const char *dataLayerName, const char *detailLayerName=0)
TSLDynamicRenderer *	getDynamicRenderer (TSLFeatureID featureID=-1, const char *layerName=0)
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributes *result) const
int	getNumDataLayers () const
bool	getOption (TSLOptionEnum option)
void	id (int id_)
int	id () const
bool	idleProcess ()
bool	loadDeclutter (const char *filename)
bool	loadRendering (const char *filename)
TSLPickResultSet *	pick (TSLDeviceUnits x, TSLDeviceUnits y, TSLDeviceUnits aperture, int depth, TSLPickSelector *selector=0)
TSLPickResultSet *	pick (const char *data_id, TSLDeviceUnits x, TSLDeviceUnits y, TSLDeviceUnits aperture, int depth=-1, TSLPickSelector *selector=0)
bool	queryActiveLayer (const char *data_id, char *detail_layer_name, int detail_layer_name_size)
bool	removeDataLayer (const char *data_id)
bool	saveDeclutter (const char *filename, TSLMapLinkVersion ver=TSL_CURRENT_MAPLINK_VERSION)
bool	saveRendering (const char *filename, TSLMapLinkVersion ver=TSL_CURRENT_MAPLINK_VERSION)
bool	sendToBack (const char *move_data_layer)
bool	sendToBackOf (const char *move_data_layer, const char *target_data_layer)
bool	setBackgroundColour (int value)
bool	setCoordinateProvidingLayer (const char *layer_name)
bool	setDataLayerProps (const char *data_id, TSLPropertyEnum property_id, TSLPropertyValue new_value)
bool	setDeclutterStatus (const char *feature_name, TSLDeclutterStatusEnum value, const char *dataLayerName=0, const char *detailLayerName=0)
bool	setDeclutterStatus (TSLFeatureID feature_id, TSLDeclutterStatusEnum value, const char *dataLayerName=0, const char *detailLayerName=0)
bool	setDeclutterStatusOnAllFeatures (TSLDeclutterStatusEnum value, const char *dataLayerName=0, const char *detailLayerName=0)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributes *value)
bool	setFrame (int style, int colour, int thickness)
virtual void	setOption (TSLOptionEnum option, bool value)
double	TMCperMU ()
TSLDrawingSurfaceTypeEnum	type () const
void	userWord (void *ptr) const
void *	userWord () const
bool	cloneDynamicRenderersFrom (const TSLDrawingSurfaceBase *otherSurface)
void	addDuplicateLayers (bool value)
virtual	~TSLDrawingSurfaceBase ()

Additional Inherited Members
Public Types inherited from TSLDrawingSurface
enum	WrapAroundMode { WrapAroundDisabled , WrapAroundLongitudinal , WrapAroundDefault = WrapAroundDisabled }
Static Public Member Functions inherited from TSLDrawingSurface
static void	cleanup ()
static bool	copy (TSLDrawingSurface *copyTo, TSLDrawingSurface *copyFrom, bool copyUserData=false)
static TSLStyleID	getIDOfNearestColour (int r, int g, int b)
static bool	loadStandardConfig (const char *path=0, bool delayLoadIncludes=false)
static bool	setupColours (const char *filename)
static bool	setupFillStyles (const char *filename, bool delayLoadIncludes=false)
static bool	setupFonts (const char *filename, bool delayLoadIncludes=false)
static bool	setupLineStyles (const char *filename, bool delayLoadIncludes=false)
static bool	setupSymbols (const char *filename, bool delayLoadIncludes=false)
static void	disableAntiAliasFonts ()
static void	enableAntiAliasFonts ()
Static Public Member Functions inherited from TSLDrawingSurfaceBase
static bool	addLoader (TSLFileLoader *loader)
static bool	addPathList (TSLPathList *path_list)
static bool	findFile (const char *filename, TSLSimpleString &foundPath)
static TSLFileLoader *	getLoader ()
Protected Member Functions inherited from TSLDrawingSurfaceBase
	TSLDrawingSurfaceBase ()
Protected Attributes inherited from TSLDrawingSurfaceBase
void *	m_classID

Constructor & Destructor Documentation

TSLNTSurface() [1/3]

TSLNTSurface::TSLNTSurface

(

)

Construct an unattached Windows specific TSLDrawingSurface.

TSLNTSurface() [2/3]

TSLNTSurface::TSLNTSurface

(

TSLDeviceContext

handle

)

Construct a WindowsNT specific TSLDrawingSurface.

Parameters

handle

Reference to a HDC to which the TSLDrawingSurface is to be attached.

TSLNTSurface() [3/3]

TSLNTSurface::TSLNTSurface

(

TSLWindowHandle

handle

)

Construct a WindowsNT specific TSLDrawingSurface.

Parameters

handle

Reference to a HWND to which the TSLDrawingSurface is to be attached.

~TSLNTSurface()

virtual TSLNTSurface::~TSLNTSurface ( )

virtual

Destructor.

Member Function Documentation

clone()

virtual TSLDrawingSurface * TSLNTSurface::clone ( bool copyUserData = false )

virtual

This method clones the drawing surface and creates another drawing surface which reference the same data layers, data layer properties, options and coordinate system configuration.

Parameters

copyUserData

If true, the userID and userWord will be copied to the new surface.

Returns

new cloned drawing surface, NULL on error.

Implements TSLDrawingSurface.

colourValue()

TSLStyleID TSLNTSurface::colourValue

(

int

index

)

Query colour value used by TSLDrawingSurface.

This method retrieves the colour definition used by the drawing surface for a given index. On Windows NT, the returned value contains the red, green and blue values of the colour used when creating the pen or brushes.

Parameters

index

Index of the colour to retrieve.

Returns

colour value, or 0 on error.

drawToHDC()

bool TSLNTSurface::drawToHDC	(	TSLDeviceContext	hDC,
		double	x1,
		double	y1,
		double	x2,
		double	y2,
		bool	clear,
		int	horizontalSizeMM = 0,
		int	verticalSizeMM = 0,
		int	horizontalSizePixels = 0,
		int	verticalSizePixels = 0 )

This method allows the TSLNTSurface to draw to a HDC to which it is not attached.

Typically this method would be used to request the TSLNTSurface to draw to a printer device context.

Note: the device co-ordinate system for the target HDC may not be the same as the one currently attached to the TSLDrawingSurface. Because of this, it may be necessary to do a temporary wndResize() and resize() on the TSLDrawingSurface.

Parameters

hDC	Handle of the device to draw to.
(x1,y1)	Bottom left co-ordinate (in user units) of the area to draw.
(x2,y2)	Top right co-ordinate (in user units) of the area to draw.
clear	If true this will clear the specified area before drawing any of the data.
horizontalSizeMM	Horizontal size of the visible screen in mm's. Defaults to system setting.
verticalSizeMM	Vertical size of the visible screen in mm's. Defaults to system setting.
horizontalSizePixels	Horizontal size of the screen in pixels. Defaults to system setting.
verticalSizePixels	Vertical size of the screen in pixels. Defaults to system setting.

See Also: TSLDrawingSurface::setDeviceCapabilities

fillStyleValue()

bool TSLNTSurface::fillStyleValue	(	int	index,
		int	colour,
		HBITMAP	bitmap,
		TSLSimpleString *	section = 0 )

Query example fill rendering used by TSLDrawingSurface.

This method populates the specified bitmap with a sample of the specified fill. The bitmap is not cleared before filling, thus enabling translucent and stippled patterns to show the underling user rendered bitmap.

Parameters

index	Index of a fill style.
colour	Colour to fill with.
bitmap	Bitmap to populate with fill style rendering
section	If provided this will be populated with the section heading that this fill style appears under

Returns

true on success, false otherwise.

fontStyleValue()

bool TSLNTSurface::fontStyleValue	(	int	index,
		int	colour,
		HBITMAP	bitmap,
		TSLSimpleString *	fontName = 0,
		const char *	outputString = 0,
		TSLSimpleString *	section = 0 )

Query example text rendering used by TSLDrawingSurface.

This method populates the specified bitmap with a sample of the specified text style. The bitmap is not cleared before drawing the text. The height of the bitmap is used define the height of the text. The text displayed is either the specified outputString, or the font name if no string is passed.

If required, the name of the font may be returned through the fontName parameter.

Parameters

index	Index of a font style
colour	Colour to display the text
bitmap	Bitmap to populate with text
fontName	Populated by the base name of the font (optional)
outputString	String to be displayed, otherwise font name is used (optional)
section	If provided this will be populated with the section heading that this font style appears under

Returns

true on success, false otherwise.

lineStyleValue()

bool TSLNTSurface::lineStyleValue	(	int	index,
		int	colour,
		int	thickness,
		HBITMAP	bitmap,
		TSLSimpleString *	section = 0 )

Query example line rendering used by TSLDrawingSurface.

This method populates the specified bitmap with a sample of the specified line style. The bitmap is not cleared before rendering.

Parameters

index	Index of a line style
colour	Colour to draw line with
thickness	Thickness of line style, in pixels
bitmap	Bitmap to populate with line style rendering
section	If provided this will be populated with the section heading that this line style appears under

Returns

true on success, false otherwise.

operator delete()

void TSLNTSurface::operator delete

(

void *

self

)

operator new() [1/2]

void * TSLNTSurface::operator new

(

size_t

size

)

operator new() [2/2]

void * TSLNTSurface::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

symbolStyleValue()

bool TSLNTSurface::symbolStyleValue	(	int	index,
		int	colour,
		HBITMAP	bitmap,
		uint32_t	fontSymbolCharacter = 0,
		TSLRasterSymbolScalable	rasterSymbolScalability = TSLRasterSymbolScalableAsSymbolFile,
		TSLSimpleString *	section = NULL,
		TSLSimpleString *	description = NULL,
		int *	originX = NULL,
		int *	originY = NULL )

Query example symbol rendering used by TSLDrawingSurface.

This method allows the user to populate a bitmap with a symbol, according to an index into the symbol list used by the drawing surface. The aim of this method is to give the user the ability of viewing the symbols used by the drawing surface.

The user creates the bitmap to be populated. The size of the bitmap is typically 32*32 pixels if the symbol is an icon.

Parameters

index	Index of a symbol style.
colour	Colour of the symbol.
bitmap	Bitmap to populate with symbol rendering
fontSymbolCharacter	If the symbol style index refers to a font symbol, this is the character that will be drawn using that font. The value is a Unicode Code Point.
rasterSymbolScalability	The symbol style index refers to a raster symbol, this flag will dictate the scalability of the symbol.
section	If provided this will be populated with the section heading that this symbol style appears under
description	If not null will be populated with the symbol's description
(originX,originY)	The returned origin of the symbol, in pixels (both originX and originY have to be passed in for them to be populated)

Returns

true on success, false otherwise.