MapBasic Reference Guide
MapBasic
Version 9.0
REFERENCE GUIDE
Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its
representatives. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, without the written permission of MapInfo Corporation, One Global View, Troy, New York 12180-8399.
© 2007 MapInfo Corporation. All rights reserved. MapInfo, the MapInfo logo and MapBasic are trademarks of MapInfo Corporation and/or
its affiliates.
MapInfo Corporate Headquarters:
Voice: (518) 285-6000
Fax: (518) 285-6070
Sales Info Hotline: (800) 327-8627
Government Sales Hotline: (800) 619-2333
Technical Support Hotline: (518) 285-7283
Technical Support Fax: (518) 285-6080
Contact information for all MapInfo offices is located at: http://www.mapinfo.com/contactus.
Adobe Acrobat® is a registered trademark of Adobe Systems Incorporated in the United States.
Products named herein may be trademarks of their respective manufacturers and are hereby recognized. Trademarked names are used
editorially, to the benefit of the trademark owner, with no intent to infringe on the trademark.
May 2007
2
MapBasic 9.0
Table of Contents
Chapter 1: Introduction to MapBasic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Language Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
MapBasic Fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Looping and Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Output and Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Procedures (Main and Subs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Custom Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Data-Conversion Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Date and Time Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Math Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
String Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Working With Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Creating and Modifying Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Querying Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Working With Remote Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Working With Files (Other Than Tables) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
File Input/Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
File and Directory Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Working With Maps and Graphical Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Creating Map Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Modifying Map Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Querying Map Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Working With Object Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Working With Map Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
ButtonPads (ToolBars). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Dialog Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
System Event Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Reference Guide
3
Table of Contents
Communicating With Other Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
DDE (Dynamic Data Exchange; Windows Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Integrated Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Special Statements and Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Contacting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Copyright Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Chapter 2: New and Enhanced MapBasic Statements and Functions . . . . . . . . 35
CoordSysName$( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CurDateTime function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
CurTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
FormatTime$ function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
FME Refresh Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetDate function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetTime function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
HotlinkInfo function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Hour function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
MakeDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Minute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
NumberToDateTime function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
NumberToTime function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
RegionInfo( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Second function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
StringToDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
StringToTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Enhanced Functions and Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Commit Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
GeocodeInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
IsogramInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
LabelInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
LayerInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Register Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Server Create Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Set Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Layer Activate clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
SystemInfo() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
TableInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 3: A – Z MapBasic Language Reference . . . . . . . . . . . . . . . . . . . . . . . . . 61
Acos( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Add Cartographic Frame statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Add Column statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4
MapBasic 9.0
Table of Contents
Add Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Alter Button statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Alter ButtonPad statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Alter Cartographic Frame statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Alter Control statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
Alter MapInfoDialog statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83
Alter Menu statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
Alter Menu Bar statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
Alter Menu Item statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
Alter Object statement 92
Alter Table statement 98
ApplicationDirectory$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Area( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
AreaOverlap( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Asc( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
Asin( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
Ask( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
Atn( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
AutoLabel statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
Beep statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Browse statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Brush clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
Buffer( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
ButtonPadInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Call statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
CartesianArea( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
CartesianBuffer( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116
CartesianConnectObjects( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
CartesianDistance( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
CartesianObjectDistance( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
CartesianObjectLen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
CartesianOffset( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
CartesianOffsetXY( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
CartesianPerimeter( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
Centroid( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
CentroidX( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
CentroidY( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
CharSet clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
ChooseProjection$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Chr$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Close All statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Reference Guide
5
Table of Contents
Close Connection statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Close File statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Close Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Close Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
ColumnInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Combine( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
CommandInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Commit Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
ConnectObjects( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Continue statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Control Button / OKButton / CancelButton clause . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Control CheckBox clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Control DocumentWindow clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Control EditText clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Control GroupBox clause. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Control ListBox / MultiListBox clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Control PenPicker/BrushPicker/SymbolPicker/FontPicker clause . . . . . . . . . . . . . . 157
Control PopupMenu clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Control RadioGroup clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Control StaticText clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
ConvertToPline( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
ConvertToRegion( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
ConvexHull( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
CoordSys clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
CoordSysName$() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Cos( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Create Arc statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Create ButtonPad statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Create ButtonPads As Default statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Create Cartographic Legend statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
CreateCircle( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Create Collection statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Create Cutter statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Create Ellipse statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Create Frame statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Create Grid statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Create Index statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Create Legend statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
CreateLine( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Create Line statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Create Map statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
6
MapBasic 9.0
Table of Contents
Create Map3D statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190
Create Menu statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Create Menu Bar statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197
Create MultiPoint statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
Create Object statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
Create Pline statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
CreatePoint( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207
Create Point statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
Create PrismMap statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
Create Ranges statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
Create Rect statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
Create Redistricter statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215
Create Region statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216
Create Report From Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
Create RoundRect statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
Create Styles statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220
Create Table statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
CreateText( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224
Create Text statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225
CurDate( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226
CurDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227
CurrentBorderPen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227
CurrentBrush( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228
CurrentFont( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229
CurrentLinePen( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229
CurrentPen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
CurrentSymbol( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231
CurTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231
DateWindow( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
Day( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
DDEExecute statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
DDEInitiate( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235
DDEPoke statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238
DDERequest$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
DDETerminate statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
DDETerminateAll statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
Declare Function statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
Declare Sub statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
Define statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
DeformatNumber$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248
Delete statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249
Reference Guide
7
Table of Contents
Dialog statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Dialog Preserve statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Dialog Remove statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Dim statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Distance( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Do Case…End Case statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Do…Loop statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Drop Index statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Drop Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Drop Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
End MapInfo statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
End Program statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
EndHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
EOF( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
EOT( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
EPSGToCoordSysString$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Erase( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Err( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Error statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Error$( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Exit Do statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Exit For statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Exit Function statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Exit Sub statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Exp( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Export statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
ExtractNodes( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Farthest statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Fetch statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
FileAttr( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
FileExists( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
FileOpenDlg( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
FileSaveAsDlg( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Find statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Find Using statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Fix( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Font clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
For…Next statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
ForegroundTaskSwitchHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Format$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
FormatDate$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
8
MapBasic 9.0
Table of Contents
FormatNumber$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .307
FormatTime$ function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
FME Refresh Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
FrontWindow( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
Function…End Function statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311
Geocode statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .314
GeocodeInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
Get statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .322
GetDate function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .323
GetFolderPath$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
GetMetadata$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .325
GetSeamlessSheet( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
GetTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
Global statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
Goto statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .328
Graph statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329
HomeDirectory$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .331
HotlinkInfo function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .331
Hour function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332
If…Then statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333
Import statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .335
Include statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .340
Input # statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .340
Insert statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .341
InStr( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .343
Int( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344
IntersectNodes( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .345
IsogramInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .345
IsPenWidthPixels( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .348
Kill statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .349
LabelFindByID( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .350
LabelFindFirst( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .351
LabelFindNext( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .352
LabelInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .353
LayerInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .356
Layout statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .361
LCase$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .362
Left$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .363
LegendFrameInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .364
LegendInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365
LegendStyleInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .366
Reference Guide
9
Table of Contents
Len( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Like( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Line Input statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
LocateFile$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
LOF( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Log( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
LTrim$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Main procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
MakeBrush( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
MakeCustomSymbol( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
MakeDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
MakeFont( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
MakeFontSymbol( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
MakePen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
MakeSymbol( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Map3DInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
MapperInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Maximum( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
MBR( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Menu Bar statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
MenuItemInfoByHandler( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
MenuItemInfoByID( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Metadata statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
MGRSToPoint( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Mid$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
MidByte$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Minimum( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Minute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Month( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Nearest statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Note statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
NumAllWindows( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
NumberToDate( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
NumberToDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
NumberToTime function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
NumCols( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
NumTables( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
NumWindows( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
ObjectDistance( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
ObjectGeography( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
10
MapBasic 9.0
Table of Contents
ObjectInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .414
ObjectLen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .418
ObjectNodeHasM( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .419
ObjectNodeHasZ( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .420
ObjectNodeM( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .422
ObjectNodeX( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .423
ObjectNodeY( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .424
ObjectNodeZ( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .425
Objects Check statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .426
Objects Clean statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .428
Objects Combine statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .429
Objects Disaggregate statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .431
Objects Enclose statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .433
Objects Erase statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .434
Objects Intersect statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .436
Objects Move statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .437
Objects Offset statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .438
Objects Overlay statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .440
Objects Pline statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .440
Objects Snap statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .441
Objects Split statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .443
Offset( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .445
OffsetXY( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .446
OnError statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .447
Open Connection statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .449
Open File statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .450
Open Report statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .452
Open Table statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .453
Open Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .455
Overlap( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .456
OverlayNodes( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .457
Pack Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .457
PathToDirectory$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .459
PathToFileName$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .459
PathToTableName$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .460
Pen clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .461
PenWidthToPoints( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .464
Perimeter( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .465
PointsToPenWidth( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .466
PointToMGRS$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .467
Print statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .468
Reference Guide
11
Table of Contents
Print # statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
PrintWin statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
PrismMapInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
ProgramDirectory$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
ProgressBar statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Proper$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
ProportionOverlap( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Put statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Randomize statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
RegionInfo( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
ReadControlValue( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
ReDim statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Register Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Relief Shade statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Reload Symbols statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
RemoteMapGenHandler procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
RemoteMsgHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
RemoteQueryHandler( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Remove Cartographic Frame statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Remove Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
Rename File statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Rename Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Reproject statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Resume statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
RGB( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Right$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Rnd( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Rollback statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Rotate( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
RotateAtPoint( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Round( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
RTrim$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Run Application statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Run Command statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Run Menu Command statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Run Program statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Save File statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Save MWS statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Save Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Save Workspace statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
SearchInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
12
MapBasic 9.0
Table of Contents
SearchPoint( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .522
SearchRect( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .523
Second function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .524
Seek( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .525
Seek statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .525
SelChangedHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .526
Select statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .527
SelectionInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .536
Server Begin Transaction statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .537
Server Bind Column statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .538
Server Close statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .539
Server_ColumnInfo( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .540
Server Commit statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .542
Server_Connect( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .543
Server_ConnectInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .550
Server Create Map statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .551
Server Create Style statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .553
Server Create Table statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .554
Server Create Workspace statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .556
Server Disconnect statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .557
Server_DriverInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .558
Server_EOT( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .559
Server_Execute( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .560
Server Fetch statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .561
Server_GetODBCHConn( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .563
Server_GetODBCHStmt( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .564
Server Link Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .565
Server_NumCols( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .567
Server_NumDrivers( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .568
Server Refresh statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .569
Server Remove Workspace statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .570
Server Rollback statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .570
Server Set Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .571
Server Versioning statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .572
Server Workspace Merge statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .574
Server Workspace Refresh statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .576
SessionInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .577
Set Application Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .578
Set Area Units statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .579
Set Browse statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .580
Set Cartographic Legend statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .581
Reference Guide
13
Table of Contents
Set Command Info statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Set Connection Geocode statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Set Connection Isogram statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Set CoordSys statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Set Date Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Set Datum Transform Version statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Set Digitizer statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Set Distance Units statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Set Drag Threshold statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Set Event Processing statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Set File Timeout statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Set Format statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Set Graph statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Set Handler statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Set Layout statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Set Legend statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Set Map statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Set Map3D statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Set Next Document statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Set Paper Units statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Set PrismMap statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Set ProgressBars statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Set Redistricter statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Set Resolution statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Set Shade statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Set Style statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Set Table Datum statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Set Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Set Target statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Set Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Sgn( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Shade statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Sin( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Space$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
SphericalArea( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
SphericalConnectObjects( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
SphericalDistance( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
SphericalObjectDistance( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
SphericalObjectLen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
SphericalOffset( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
SphericalOffsetXY( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
14
MapBasic 9.0
Table of Contents
SphericalPerimeter( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .666
Sqr( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .667
StatusBar statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .668
Stop statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .668
Str$( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .669
String$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .671
StringCompare( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .671
StringCompareIntl( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .672
StringToDate( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .673
StringToDateTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .674
StringToTime function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .675
StyleAttr( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .675
Sub…End Sub statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .678
Symbol clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .680
SystemInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .683
TableInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .685
Tan( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .688
TempFileName$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .689
Terminate Application statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .690
TextSize( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .690
Time( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .691
Timer( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .691
ToolHandler procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .692
TriggerControl( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .694
TrueFileName$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .695
Type statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .695
UBound( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .696
UCase$( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .697
UnDim statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .698
UnitAbbr$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .699
UnitName$( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .699
Unlink statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .700
Update statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .701
Update Window statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .702
Val( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .702
Weekday( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .703
WFS Refresh Table statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .704
While…Wend statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .704
WinChangedHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .706
WinClosedHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .707
WindowID( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .708
Reference Guide
15
Table of Contents
WindowInfo( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
WinFocusChangedHandler procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Write # statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Year( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Appendix A: HTTP and FTP Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
MICloseContent( ) procedure 720
MICloseFtpConnection( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
MICloseFtpFileFind( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
MICloseHttpConnection( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
MICloseHttpFile( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
MICloseSession( ) procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
MICreateSession( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
MICreateSessionFull( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
MIErrorDlg( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
MIFindFtpFile( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
MIFindNextFtpFile( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
MIGetContent( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
MIGetContentBuffer( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
MIGetContentLen( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
MIGetContentString( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
MIGetContentToFile( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
MIGetContentType( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
MIGetCurrentFtpDirectory( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
MIGetErrorCode( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
MIGetErrorMessage( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
MIGetFileURL( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
MIGetFtpConnection( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
MIGetFtpFile( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
MIGetFtpFileFind( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
MIGetFtpFileName( ) procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
MIGetHttpConnection( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
MIIsFtpDirectory( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
MIIsFtpDots( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
MIOpenRequest( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
MIOpenRequestFull( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
MIParseURL( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
MIPutFtpFile( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
MIQueryInfo( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
MIQueryInfoStatusCode( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
MISaveContent( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
MISendRequest( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
16
MapBasic 9.0
Table of Contents
MISendSimpleRequest( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .747
MISetCurrentFtpDirectory( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .747
MISetSessionTimeout( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .748
Appendix B: XML Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
MIXmlAttributeListDestroy( ) procedure 750
MIXmlDocumentCreate( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .750
MIXmlDocumentDestroy( ) procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .751
MIXmlDocumentGetNamespaces( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .751
MIXmlDocumentGetRootNode( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .752
MIXmlDocumentLoad( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .752
MIXmlDocumentLoadXML( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .753
MIXmlDocumentLoadXMLString( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .754
MIXmlDocumentSetProperty( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .755
MIXmlGetAttributeList( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .756
MIXmlGetChildList( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .756
MIXmlGetNextAttribute( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .757
MIXmlGetNextNode( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .758
MIXmlNodeDestroy( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .758
MIXmlNodeGetAttributeValue( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .759
MIXmlNodeGetFirstChild( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .759
MIXmlNodeGetName( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .760
MIXmlNodeGetParent( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .761
MIXmlNodeGetText( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .761
MIXmlNodeGetValue( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .762
MIXmlNodeListDestroy( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .762
MIXmlSCDestroy( ) procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .763
MIXmlSCGetLength( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .763
MIXmlSCGetNamespace( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .764
MIXmlSelectNodes( ) function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .764
MIXmlSelectSingleNode( ) function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .765
Appendix C: Character Code Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Appendix D: Summary of Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Comparison Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .770
Logical Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .771
Geographical Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .771
Automatic Type Conversions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .772
Appendix E: MapBasic Definitions File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Reference Guide
17
Table of Contents
18
MapBasic 9.0
Introduction to MapBasic
This manual describes every statement and function in the MapBasic
Development Environment programming language. To learn about the concepts
behind MapBasic programming, or to learn about using the MapBasic
development environment, see the MapBasic User Guide.
In this chapter…
Š
Š
Š
Š
Š
Š
Š
Š
Š
Š
Type Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Language Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
MapBasic Fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Working With Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Working With Files (Other Than Tables) . . . . . . . . . . . . . . . . . . . .26
Working With Maps and Graphical Objects . . . . . . . . . . . . . . . . . .27
Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Communicating With Other Applications . . . . . . . . . . . . . . . . . . .31
Special Statements and Functions . . . . . . . . . . . . . . . . . . . . . . . . .32
1
Type Conventions
Type Conventions
This manual uses the following conventions to designate specific items in the text:
Convention
If, Call, Map, Browse, Area
Meaning
Bold words with the first letter capitalized are MapBasic keywords.
Within this manual, the first letter of each keyword is capitalized; however,
when you write MapBasic programs, you may enter keywords in upper-,
lower-, or mixed-case.
Main, Pen, Object
Non-bold words with the first letter capitalized are usually special procedure
names or variable types.
table, handler, window_id
Italicized words represent parameters to MapBasic statements. When you
construct a MapBasic statement, you must supply an appropriate
expression for each parameter.
[ window_id ], [ Interactive ]
Keywords or parameters which appear inside square brackets are optional.
{ On | Off }
When a syntax expression appears inside braces, the braces contain a list
of keywords or parameters, separated by the vertical bar character ( | ).
You must choose one of the options listed. For example, in the sample
shown on the left ({ On | Off }), you should choose either On or Off.
"Note "Hello,world!"
Actual program samples are shown in Courier font.
Language Overview
The following pages provide an overview of the MapBasic language. Task descriptions appear on
the left; corresponding statement names and function names appear on the right, in bold. Function
names are followed by parentheses ( ).
MapBasic Fundamentals
Variables
20
Declare local or global variables:
Dim, Global
Resize array variables:
ReDim, UBound( ), UnDim
Declare custom data structure:
Type
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Looping and Branching
Looping:
For…Next, Exit For, Do…Loop, Exit Do,
While…Wend
Branching:
If…Then, Do Case, GoTo
Other flow control:
End Program, Terminate Application, End
MapInfo
Output and Printing
Print a window's contents:
PrintWin
Print text to message window:
Print
Set up a Layout window:
Layout, Create Frame, Set Window
Export a window to a file:
Save Window
Controlling the Printer:
Set Window, Window Info( )
Procedures (Main and Subs)
Define a procedure:
Declare Sub, Sub…End Sub
Call a procedure:
Call
Exit a procedure:
Exit Sub
Main procedure:
Main
Error Handling
Set up an error handler:
OnError
Return current error information:
Err( ), Error$( )
Return from error handler:
Resume
Simulate an error:
Error
Reference Guide
21
Functions
Functions
Custom Functions
Define a custom function:
Declare Function, Function…End Function
Exit a function:
Exit Function
Data-Conversion Functions
Convert strings to codes:
Asc( )
Convert codes to strings:
Chr$( )
Convert strings to numbers:
Val( )
Convert numbers to strings:
Str$( ), Format$( )
Convert a number or a string to a date:
NumberToDate( ), StringToDate( )
Converting to a 2-Digit Year:
Set Date Window, DateWindow( )
Convert object types:
ConvertToRegion( ), ConvertToPline( )
Convert labels to text:
LabelInfo( )
Convert a point object to an MGRS coordinate:
PointToMGRS$( )
Convert a MGRS coordinate to a point object:
MGRSToPoint( )
Date and Time Functions
22
Obtain the current date:
CurDate( )
Extract parts of a date:
Day( ), Month( ), Weekday( ), Year( )
Read system timer:
Timer( )
Convert a number or a string to a date:
NumberToDate( ), StringToDate( )
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Math Functions
Trigonometric functions:
Cos( ), Sin( ), Tan( ), Acos( ), Asin( ), Atn( )
Geographic functions:
Area( ), Perimeter( ), Distance( ),
ObjectLen( ), CartesianArea( ),
CartesianPerimeter( ), CartesianDistance( ),
CartesianObjectLen( ), SphericalArea( ),
SphericalPerimeter( ), SphericalDistance( ),
SphericalObjectLen( )
Random numbers:
Randomize, Rnd( )
Sign-related functions:
Abs( ), Sgn( )
Truncating fractions:
Fix( ), Int( ), Round( )
Other math functions:
Exp( ), Log( ), Minimum( ), Maximum( ),
Sqr( )
String Functions
Upper / lower case:
UCase$( ), LCase$( ), Proper$( )
Find a sub-string:
InStr( )
Extract part of a string:
Left$( ), Right$( ), Mid$( ), MidByte$( )
Trim blanks from a string:
LTrim$( ), RTrim$( )
Format numbers as strings:
Format$( ), Str$( ), Set Format,
FormatNumber$( ), DeformatNumber$( )
Determine string length:
Len( )
Convert character codes:
Chr$( ), Asc( )
Compare strings:
Like( ), StringCompare( ),
StringCompareIntl( )
Repeat a string sequence:
Space$( ), String$( )
Return unit name:
UnitAbbr$( ), UnitName$( )
Convert a point object to an MGRS coordinate:
PointToMGRS$( )
Convert a MGRS coordinate to a point object:
MGRSToPoint( )
Convert an EPSG string to a CoordSys clause:
EPSGToCoordSysString$( )
Reference Guide
23
Working With Tables
Working With Tables
Creating and Modifying Tables
Open an existing table:
Open Table
Close one or more tables:
Close Table, Close All
Create a new, empty table:
Create Table
Turn a file into a table:
Register Table
Import/export tables/files:
Import, Export
Modify a table's structure:
Alter Table, Add Column, Create Index, Drop Index, Create
Map, Drop Map
Create a Crystal Reports file:
Create Report From Table
Load a Crystal Report:
Open Report
Add, edit, delete rows:
Insert, Update, Delete
Pack a table:
Pack Table
Control table settings:
Set Table
Save recent edits:
Table
Discard recent edits:
Rollback
Rename a table:
Rename Table
Delete a table:
Drop Table
Querying Tables
24
Position the row cursor:
Fetch, EOT( )
Select data, work with Selection:
Select, SelectionInfo( )
Find map objects by address:
Find, Find Using, CommandInfo( )
Find map objects at location:
SearchPoint( ), SearchRect( ), SearchInfo( )
Obtain table information:
NumTables( ), TableInfo( )
Obtain column information:
NumCols( ), ColumnInfo( )
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Query a table's metadata:
GetMetadata$( ), Metadata
Query seamless tables:
TableInfo( ), GetSeamlessSheet( )
Working With Remote Data
Create a new table:
Server Create Table
Communicate with data server:
Server_Connect( ), Server_ConnectInfo( )
Begin work with remote server:
Server Begin Transaction
Assign local storage:
Server Bind Column
Obtain column information:
Server_ColumnInfo( ), Server_NumCols( )
Send an SQL statement:
Server_Execute( )
Position the row cursor:
Server Fetch, Server_EOT( )
Save changes:
Server
Discard changes:
Server Rollback
Free remote resources:
Server Close
Make remote data mappable:
Server Create Map
Change object styles:
Server Set Map
Synchronize a linked table:
Server Refresh
Create a linked table:
Server Link Table
Unlink a linked table:
Unlink
Disconnect from server:
Server Disconnect
Retrieve driver information:
Server_DriverInfo( ), Server_NumDrivers( )
Get ODBC connection handle:
Server_GetODBCHConn( )
Get ODBC statement handle:
Server_GetODBCHStmt( )
Set Object styles:
Server Create Style
Reference Guide
25
Working With Files (Other Than Tables)
Working With Files (Other Than Tables)
File Input/Output
Open or create a file:
Open File
Close a file:
Close File
Delete a file:
Kill
Rename a file:
Rename File
Copy a file:
Save File
Read from a file:
Get, Seek, Input #, Line Input
Write to a file:
Put, Print #, Write #
Determine file's status:
EOF( ), LOF( ), Seek( ), FileAttr( ), FileExists( )
Turn a file into a table:
Register Table
Retry on sharing error:
Set File Timeout
File and Directory Names
26
Return system directories:
ProgramDirectory$( ), HomeDirectory$( ),
ApplicationDirectory$( )
Extract part of a filename:
PathToTableName$( ), PathToDirectory$( ),
PathToFileName$( )
Return a full filename:
TrueFileName$( )
Let user choose a file:
FileOpenDlg( ), FileSaveAsDlg( )
Return temporary filename:
TempFileName$( )
Locate files:
LocateFile$( ), GetFolderPath$( )
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Working With Maps and Graphical Objects
Creating Map Objects
Creation statements:
Create Arc, Create Ellipse, Create Frame, Create Line, Create
Object, Create PLine, Create Point, Create Rect, Create
Region, Create RoundRect, Create Text, AutoLabel, Create
Multipoint, Create Collection
Creation functions:
CreateCircle( ), CreateLine( ), CreatePoint( ), CreateText( )
Advanced operations:
Create Object, Buffer( ), CartesianBuffer( ), CartesianOffset( ),
CartesianOffsetXY( ), ConvexHull( ), Offset( ), OffsetXY( ),
SphericalOffset( ), SphericalOffsetXY( )
Store object in table:
Insert, Update
Create regions:
Objects Enclose
Modifying Map Objects
Modify object attribute:
Alter Object
Change object type:
ConvertToRegion( ), ConvertToPLine( )
Offset objects:
Objects Offset, Objects Move
Set the editing target:
Set Target
Erase part of an object:
CreateCutter, Objects Erase, Erase( ), Objects Intersect,
Overlap( )
Merge objects:
Objects Combine, Combine( ), Create Object
Rotate objects:
Rotate( ), RotateAtPoint( )
Split objects:
Objects Pline, Objects Split
Add nodes at intersections:
Objects Overlay, OverlayNodes( )
Control object resolution:
Set Resolution
Store an object in a table:
Insert, Update
Check Objects for bad data:
Objects Check
Object processing:
Objects Disaggregate, Objects Snap, Objects Clean
Reference Guide
27
Working With Maps and Graphical Objects
Querying Map Objects
Return calculated values:
Area( ), Perimeter( ), Distance( ),
ObjectLen( ), Overlap( ), AreaOverlap( ),
ProportionOverlap( )
Return coordinate values:
ObjectGeography( ), MBR( ), ObjectNodeX( ),
ObjectNodeY( ), ObjectNodeZ( ), Centroid( ),
CentroidX( ), CentroidY( ), ExtractNodes( ),
IntersectNodes( )
Return settings for coordinates, distance, area
and paper units:
SessionInfo( )
Configure units of measure:
Set Area Units, Set Distance Units, Set Paper
Units, UnitAbbr$( ), UnitName$( )
Configure coordinate system:
Set CoordSys
Return style settings:
ObjectInfo( )
Query a map layer's labels:
LabelFindByID( ), LabelFindFirst( ),
LabelFindNext( ), Labelinfo( )
Working With Object Styles
28
Return current styles:
CurrentPen( ), CurrentBorderPen( ),
CurrentBrush( ), CurrentFont( ),
CurrentLinePen( ), CurrentSymbol( ), Set
Style, TextSize( )
Return part of a style:
StyleAttr( )
Create style values:
MakePen( ), MakeBrush( ), MakeFont( ),
MakeSymbol( ), MakeCustomSymbol( ),
MakeFontSymbol( ), Set Style, RGB( )
Query object's style:
ObjectInfo( )
Modify object's style:
Alter Object
Reload symbol styles:
Reload Symbols
Style clauses:
Pen clause, Brush clause, Symbol clause,
Font clause
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Working With Map Windows
Open a map window:
Map
Create/edit 3DMaps:
Create Map3D, Set Map3D, Map3DInfo( ),
Create PrismMap, Set PrismMap,
PrismMapInfo( )
Add a layer to a map:
Add Map
Remove a map layer:
Remove Map
Label objects in a layer:
AutoLabel
Query a map's settings:
MapperInfo( ), LayerInfo( )
Change a map's settings:
Set Map
Create or modify thematic layers:
Shade, Set Shade, Create Ranges, Create
Styles, Create Grid, Relief Shade
Query a map layer's labels:
LabelFindByID( ), LabelFindFirst( ),
LabelFindNext( ), Labelinfo( )
Creating the User Interface
ButtonPads (ToolBars)
Create a new ButtonPad:
Create ButtonPad
Modify a ButtonPad:
Alter ButtonPad
Modify a button:
Alter Button
Query the status of a pad:
ButtonPadInfo( )
Respond to button use:
CommandInfo( )
Restore standard pads:
Create ButtonPads As Default
Reference Guide
29
Creating the User Interface
Dialog Boxes
Display a standard dialog box:
Ask( ), Note, ProgressBar, FileOpenDlg( ),
FileSaveAsDlg( ), GetSeamlessSheet( )
Display a custom dialog box:
Dialog
Dialog handler operations:
Alter Control, TriggerControl( ),
ReadControlValue( ), Dialog Preserve,
Dialog Remove
Determine whether user clicked OK:
CommandInfo(CMD_INFO_DLG_OK)
Disable progress bars:
Set ProgressBars
Modify a standard MapInfo Professional dialog box:
Alter MapInfoDialog
Menus
Define a new menu:
Create Menu
Redefine the menu bar:
Create Menu Bar
Modify a menu:
Alter Menu, Alter Menu Item
Modify the menu bar:
Alter Menu Bar, Menu Bar
Invoke a menu command:
Run Menu Command
Query a menu item's status:
MenuItemInfoByHandler( ), MenuItemInfoByID( )
Windows
30
Show or hide a window:
Open Window, Close Window, Set Window
Open a new window:
Map, Browse, Graph, Layout, Create Redistricter, Create
Legend, Create Cartographic Legend, LegendFrameInfo
Determine a window's ID:
FrontWindow( ), WindowID( )
Modify an existing window:
Set Map, Shade, Add Map, Remove Map, Set Browse, Set
Graph, Set Layout, Create Frame, Set Legend, Set
Cartographic Legend, Set Redistricter, StatusBar, Alter
Cartographic Frame, Add Cartographic Frame, Remove
Cartographic Frame
Return a window's settings:
WindowInfo( ), MapperInfo( ), LayerInfo( )
MapBasic 9.0
Chapter 1: Introduction to MapBasic
Print a window:
PrintWin
Control window redrawing:
Set Event Processing, Update Window, Control
DocumentWindow clause
Count number of windows:
NumWindows( ), NumAllWindows( )
System Event Handlers
React to selection:
SelChangedHandler
React to window closing:
WinClosedHandler
React to map changes:
WinChangedHandler
React to window focus:
WinFocusChangedHandler
React to DDE request:
RemoteMsgHandler,
RemoteQueryHandler( )
React to OLE Automation method:
RemoteMapGenHandler
Provide custom tool:
ToolHandler
React to termination of application:
EndHandler
React to MapInfo Professional getting or losing focus:
ForegroundTaskSwitchHandler
Disable event handlers:
Set Handler
Communicating With Other Applications
DDE (Dynamic Data Exchange; Windows Only)
Start a DDE conversation:
DDEInitiate( )
Send a DDE command:
DDEExecute
Send a value via DDE:
DDEPoke
Retrieve a value via DDE:
DDERequest$( )
Close a DDE conversation:
DDETerminate, DDETerminateAll
Respond to a request:
RemoteMsgHandler, RemoteQueryHandler( ),
CommandInfo(CMD_INFO_MSG)
Reference Guide
31
Special Statements and Functions
Integrated Mapping
Set MapInfo Professional 's parent window:
Set Application Window
Set a Map window's parent:
Set Next Document
Create a Legend window:
Create Legend
Special Statements and Functions
Launch another program:
Run Program
Return information about the system:
SystemInfo( )
Run a string as an interpreted command:
Run Command
Save a workspace file:
Save Workspace
Load a workspace file or an MBX:
Run Application
Configure a digitizing tablet:
Set Digitizer
Send a sound to the speaker:
Beep
Set data to be read by CommandInfo:
Set Command Info
Set duration of the drag-object delay:
Set Drag Threshold
Contacting Technical Support
MapInfo Corporation offers a free support period on all new software purchases and upgrades, so
you can be productive from the start. Once the free period ends, MapInfo Corporation offers a broad
selection of extended support services for individual, business, and corporate users.
Technical Support is here to help you, and your call is important. This section lists the information
you need to provide when you call your local support center. It also explains some of the technical
support procedures so that you will know what to expect about the handling and resolution of your
particular issue.
MapInfo Corporation provides full technical support for MapInfo MapBasic for the previous two
versions of the product and later. Please remember to include your serial number, partner number or
contract number when contacting Technical Support.
ontact the technical support personnel for your area:
32
MapBasic 9.0
Chapter 1: Introduction to MapBasic
The Americas
Phone: 518.285.7283
Fax: 518.285.6080
E-mail: techsupport@mapinfo.com
Hours: Monday - Friday from 8:00am - 7:00pm EST, excluding MapInfo Holidays. Closed
between 10:30am - 11:30 am on Mondays for training.
Asia-Pacific Headquarters
Phone: 61.7.3844.7744
Fax: 61.7.3844.2400
E-mail: ozsupport@mapinfo.com
Hours: Monday - Friday from 9:00am and 5:00pm (EST) Australian Eastern Standard Time,
excluding MapInfo Holidays.
Europe/Middle East/Africa
Phone: 44.1753.848229
Fax: 44.1753.621140
E-mail: support-europe@mapinfo.com
Hours: Monday - Friday from 8am to 5pm GMT, excluding MapInfo Holidays.
Germany
Phone: +49 (0) 6142-203-400
Fax: +49 (0) 6142-203-444
E-mail: supportgermany@mapinfo.com
Hours: Monday - Friday from 9 am to 5 pm MEZ, excluding MapInfo Holidays.
To use Technical Support, you must register your product. This can be done very easily during
installation. To receive more information on MapInfo’s technical support programs, contact a
representative in your area or one of our technical support offices.
In the United States, call 1–800–FASTMAP for more information. To purchase MapInfo technical
support or renew your current contract, please contact MapInfo Customer Service at 1–800–552–
2511, and press 3 at the main menu, or send an e-mail at custserv@mapinfo.com.
Extended support options are available at each of our technical support centers in the United States,
United Kingdom, and Australia.
Before You Call
Please have the following information ready when contacting us for assistance.
Reference Guide
33
Copyright Information
1. Serial Number. You must have a registered serial number to receive Technical Support.
2. Your name and organization. The person calling must be the contact person listed on the support
agreement.
3. Version of the product you are calling about.
4. The operating system name and version.
5. A brief explanation of the problem. Some details that can be helpful in this context are:
•
Error messages
•
Context in which the problem occurs
•
Consistency – is the problem reoccurring or occurring erratically?
Copyright Information
Information in this document is subject to change without notice and does not represent a
commitment on the part of the vendor or its representatives. No part of this document may be
reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, without the written permission of MapInfo Corporation, One Global View, Troy, New
York 12180-8399.
© 2007 MapInfo Corporation. All rights reserved. MapInfo, the MapInfo logo and MapBasic are
trademarks of MapInfo Corporation and/or its affiliates.
MapInfo Corporate Headquarters:
Voice: (518) 285-6000
Fax: (518) 285-6070
Sales Info Hotline: (800) 327-8627
Government Sales Hotline: (800) 619-2333
Technical Support Hotline: (518) 285-7283
Technical Support Fax: (518) 285-6080
Contact information for all MapInfo offices is located at: http://www.mapinfo.com/contactus.
Adobe Acrobat® is a registered trademark of Adobe Systems Incorporated in the United States.
Products named herein may be trademarks of their respective manufacturers and are hereby
recognized. Trademarked names are used editorially, to the benefit of the trademark owner, with no
intent to infringe on the trademark.
34
MapBasic 9.0
New and Enhanced
MapBasic Statements
and Functions
These are the new statements and functions available for the MapInfo
Professional 9.0 product.
Sections in this Chapter:
Š
Š
New in MapBasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Enhanced Functions and Statements . . . . . . . . . . . . . . . . . . . . . .47
2
New in MapBasic
New in MapBasic
We have added a new set of date and time data types which increase your ability to create datebased and time-based queries and thematics.
The following new functions have been added to MapBasic for the current release of MapInfo
Professional. These functions are included in their place in the logical order of the reference section.
We are duplicating them here for your reference.
•
CoordSysName$( ) function
•
CurDateTime function
•
CurTime function
•
FormatTime$ function
•
FME Refresh Table statement
•
GetDate function
•
GetTime function
•
HotlinkInfo function
•
Hour function
•
MakeDateTime function
•
Minute function
•
NumberToDateTime function
•
NumberToTime function
•
RegionInfo( ) function
•
Second function
•
StringToDateTime function
•
StringToTime function
CoordSysName$( ) function
Purpose
Returns coordinate system name string from MapBasic Coordinate system clause.
Syntax
CoordSysName$ ( string )
Return Value
String
Example
Note CoordSysName$("Coordsys Earth Projection 1, 62")
36
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Returns this string in the MapInfo dialog box:
Longitude / Latitude (NAD 27 for Continental US)
Note: If a coordinate system name does not exist in the MapInfow.prj file, such as when the map is
in NonEarth system in Survey Feet, then function will return an empty string.
Note CoordSysName$("CoordSys NonEarth Units " + """survey ft""" +
"Bounds (0, 0) (10, 10)")
If an invalid CoordSys clause is passed such as this (using invalid units):
Note CoordSysName$("CoordSys Earth Projection 3, 74, " + """foo""" +
"-90, 42, 42.7333333333, 44.0666666667, 1968500, 0")
Then an Error regarding the Invalid Coordinate System should be returned (Error #727).
Invalid Coordinate System: CoordSys Earth Projection <content>
CurDateTime function
Purpose
Returns the current date and time.
Syntax
CurDateTime
Return Value
DateTime
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as datetime
X = CurDateTime()
Print X
CurTime function
Purpose
Returns the current time.
Syntax
CurTime
Return Value
Time
Reference Guide
37
FormatTime$ function
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Y as time
Y = CurTime()
Print Y
FormatTime$ function
Purpose
Returns a string representing a time using the format specified in the second argument. The format
string should follow the same Microsoft standards as for setting the locale time format:
Hours
Meaning
h
Hours without leading zeros for single-digit hours (12-hour clock).
hh
Hours with leading zeros for single-digit hours (12-hour clock).
H
Hours without leading zeros for single-digit hours (24-hour clock).
HH
Hours with leading zeros for single-digit hours (24-hour clock).
Minutes
Meaning
m
Minutes without leading zeros for single-digit minutes.
mm
Minutes with leading zeros for single-digit minutes.
Seconds
Meaning
s
Seconds without leading zeros for single-digit seconds.
ss
Seconds with leading zeros for single-digit seconds.
Time marker
t
Meaning
One-character time marker string.
Note: Do not to use this format for certain languages, for example, Japanese
(Japan). With this format, the application always takes the first character
from the time marker string, defined by LOCALE_S1159 (AM) and
LOCALE_S2359 (PM). Because of this, the application can create
incorrect formatting with the same string used for both AM and PM.
tt
Multi-character time marker string.
Source: http://msdn2.microsoft.com/en-us/library/ms776320.aspx
Note: In the preceding formats, the letters m, s, and t must be lowercase, and the letter h must be
lowercase to denote the 12-hour clock or uppercase to denote the 24-hour clock.
38
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Our code follows the rules for specifying the system local time format. In addition, we also allow the
user to specify f, ff, or fff for tenths of a second, hundredths of a second, or milliseconds.
Syntax
FormatTime$ (Time, String)
Return Value
String
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Z as time
Z = CurTime()
Print FormatTime$(Z, "hh:mm:ss.fff tt")
FME Refresh Table statement
Purpose
Refreshes a Universal Data Source (FME) table from the original data source
Syntax
FME Refresh Table alias
alias is the an alias for an open registered Universal Data Source (FME) table.
Example
The following example refreshes the local table named watershed.
FME Refresh Table watershed
GetDate function
Purpose
Returns the Date component of a DateTime.
Syntax
GetDate (DateTime)
Return Value
Date
Reference Guide
39
GetTime function
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim dtX as datetime
dim Z as date
dtX = "03/07/2007 12:09:09.000 AM"
Z = GetDate(dtX)
Print FormatDate$(Z)
GetTime function
Purpose
Returns the Time component of a DateTime.
Syntax
GetTime (DateTime)
Return Value
Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim dtX as datetime
dim Z as time
dtX = "03/07/2007 12:09:09.000 AM"
Z = GetTime(dtX)
Print FormatTime$(Z,"hh:mm:ss.fff tt")
HotlinkInfo function
Purpose
Returns information about a HotLink definition in a map layer.
Syntax
HotlinkInfo ( map_window_id, layer_number, hotlink_number, attribute )
map_window_id is a Map window identifier.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer);
to determine the number of layers in a Map window, call the MapperInfo( ) function.
hotlink_number - the index of the hotlink definition being queried. The first hotlink definition in a layer
has index of 1.
40
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
attribute - the following attribute values are allowed:
HOTLINK_INFO_EXPR
Returns the filename expression for this hotlink definition.
HOTLINK_INFO_MODE
Returns the mode for this hotlink definition, one of the
following predefined values:
•
•
•
HOTLINK_MODE_LABEL
HOTLINK_MODE_OBJ
HOTLINK_MODE_BOTH
HOTLINK_INFO_RELATIVE
Returns TRUE if the relative path option is on for this hotlink
definition.
HOTLINK_INFO_ENABLED
Returns TRUE if this hotlink definition is enabled.
See Also
Set Map statement, LayerInfo( ) function,
Hour function
Purpose
Returns the hour component of a Time.
Syntax
Hour (Time)
Return Value
Number
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Z as time
dim iHour as integer
Z = CurDateTime()
iHour = Hour(Z)
Print iHour
Reference Guide
41
MakeDateTime function
MakeDateTime function
Purpose
Returns a DateTime made from the specified Date and Time.
Syntax
MakeDateTime (Date, Time)
Return Value
DateTime
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim tX as time
dim dX as date
dim dtX as datetime
tX = 105604123
dX = 20070908
dtX = MakeDateTime(dX,tX)
Print FormatDate$(GetDate(dtX))
Print FormatTime$(GetTime(dtX), "hh:mm:ss.fff tt")
Minute function
Purpose
Returns the minute component of a Time.
Syntax
Minute (Time)
Return Value
Number
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as time
dim iMin as integer
X = CurDateTime()
iMin = Minute(X)
Print iMin
42
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
NumberToDateTime function
Purpose
Returns a DateTime value.
Syntax
NumberToDateTime( numeric_datetime )
numeric_datetime is an seventeen-digit integer in the form YYYYMMDDHHMMSSFFF. For
example, 20070301214237582 represents March 1, 2007 9:42:37.582 PM.
Return Value
Date/Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim fNum as float
dim Y as datetime
fNum = 20070301214237582
Y = NumbertoDateTime (fNum)
Print FormatDate$(Y)
Print FormatTime$(Y,"hh:mm:ss.fff tt")
NumberToTime function
Purpose
Returns a Time value.
Syntax
NumberToTime( numeric_time )
numeric_time is an nine-digit integer in the form HHMMSSFFF. For example, 214237582 represents
9:42:37.582 P.M.
Return Value
Time
Reference Guide
43
RegionInfo( ) function
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim fNum as float
dim Y as time
fNum = 214237582
Y = NumberToTime(fNum)
Print FormatTime$(Y,"hh:mm:ss.fff tt")
RegionInfo( ) function
Purpose:
This function was created to determine the orientation of points in polygons -- whether they are
ordered clockwise, or counter-clockwise. The only attribute the function reports on is the
'direction' of the points in a specified polygon.
Syntax:
RegionInfo(object, REGION_INFO_IS_CLOCKWISE, polygon_num)
Only one parameter exists for this function:
REGION_INFO_IS_CLOCKWISE
1
Example:
If you were to select the state of Utah from States mapper and issued the following command in the
MapBasic window, you would get a result of F or False, since the nodes in the single region of Utah
are drawn in counter-clockwise order. Colorado's nodes are drawn in clockwise order and return T or
True.
print RegionInfo(selection.obj,1,1)
Second function
Purpose
Returns the second and millisecond component of a Time as a floating-point number.
Syntax
Second (Time)
Return Value
Number
44
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as time
dim iSec as integer
X = CurDateTime()
Sec = Second(X)
Print iSec
StringToDateTime function
Purpose
Returns a DateTime value given a string that represents a date and time. MapBasic interprets the
date/time string according to the date and time-formatting options that are set up on the user's
computer. At least one space must be between the date and time. See StringToDate( ) function
and StringToTime function for details.
Syntax
StringToDateTime (String)
Return Value
DateTime
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim strX as string
dim Z as datetime
strX = "19990912041345789"
Z = StringtoDateTime(strX)
Print FormatDate$(Z)
Print FormatTime$(Z,"hh:mm:ss.fff tt")
StringToTime function
Purpose
Returns a Time value given a string that represents a time. MapBasic interprets the time string
according to the time-formatting options that are set up on the user's computer. However, either 12
or 24-hour time representations are accepted. In addition, the less significant components of a time
may be omitted. In other words, the hour must be specified, but the minutes, seconds, and
milliseconds are optional.
Syntax
StringToTime (String)
Reference Guide
45
StringToTime function
Return Value
Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim strY as string
dim X as time
strY = "010203000"
X = StringtoTime(strY)
Print FormatTime$ (X,"hh:mm:ss.fff tt")
46
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Enhanced Functions and Statements
The following functions and statements have been enhanced to provide additional functionality to
:MapBasic:
•
Commit Table statement
•
GeocodeInfo( ) function
•
IsogramInfo( ) function
•
LabelInfo( ) function
•
LayerInfo( ) function
•
Register Table statement
•
Server Create Table statement
•
Set Map statement
•
SystemInfo() function
•
TableInfo( ) function
Commit Table statement
Purpose
Saves recent edits to disk, or saves a copy of a table. The new clause contains datetime option.
Syntax
Commit Table table
[ As
filespec
[ Type { NATIVE |
DBF [ Charset
char_set ] |
Access Database database_filespec
Version version
Table tablename
[ Password pwd ] [ Charset char_set ] |
QUERY |
ODBC Connection ConnectionNumber Table tablename
[ ConvertDateTime {ON | OFF | INTERACTIVE}]
}]
[ CoordSys... ]
[ Version version ] ]
[ { Interactive | Automatic commit_keyword } ]
[ ConvertObjects {ON | OFF | INTERACTIVE}]
tableName is the name of the table as you want it to appear in database. Starting release 9.0, the
name can include a schema name which specifies the schema that the table belongs to. If no
schema name is provided, the table belongs to the default schema as in 8.5 and earlier versions.
The user is responsible for providing an eligible schema name and must know if the login user has
the proper permissions on the given schema. This extension is for SQL Server 2005 only.
ConvertDateTime If the source table contains Time or Date type columns, these columns will be
converted to DATETIME or TIMESTAMP depending on whether the server supports the data types.
However, you can control this behavior using the clause ConvertDateTime. If the source table does
Reference Guide
47
Commit Table statement
not contain a Time or Date type, this clause is a non-operational. If ConvertDateTime is set to ON
(which is the default setting), Time or Date type columns will be converted to DATETIME or
TIMESTAMP. If ConvertDateTime is set to OFF, the conversion is not done and the operation will be
cancelled if necessary. If ConvertDateTime is set to INTERACTIVE a dialog box will pop up to
prompt the user and the operation will depend on the user's choice. If the user chooses to convert,
then the operation will convert and continue; if the user chooses to cancel, the operation will be
cancelled.
The Time type requires conversion for all supported servers (Oracle, IBM Informix, MS SQL Server
and Access) and the Date type requires conversion for MS SQL Server and Access database
servers.
Note: For MS SQL Server and Access database servers, this restriction could be an backward
compatibility issue. In previous releases, we did the conversion without explaining it. In this
release, we suggest you use the DateTime data type instead of Date data type. If you still use
the Date data type, the conversion operation will fail.
ConvertObjects ON automatically converts any unsupported objects encountered in supported
objects.
ConvertObjects OFF This does not convert any unsupported objects. If they are encountered, an
error message is displayed saying the table can not be saved. (Before implementation of this feature
this was the only behavior.)
ConvertObjects Interactive If any unsupported objects are encountered in a table, ask the user what
she wants to do.
Example 1
Commit Table DATETIME90 As "D:\MapInfo\Data\Remote\DATETIME90CPY.TAB"
Type ODBC Connection 1 Table """EAZYLOADER"".""DATETIME90CPY"""
ConvertDateTime Interactive
Example 2
Server 1 Create Table """EAZYLOADER"".""CITY_125AA""" (Field1
Char(10),Field2 Char(10),Field3 Char(10),MI_STYLE Char(254)) KeyColumn
SW_MEMBER ObjectColumn SW_GEOMETRY
or
Server 1 Create Table "EAZYLOADER.CITY_125AA" (Field1 Char(10),Field2
Char(10),Field3 Char(10),MI_STYLE Char(254)) KeyColumn SW_MEMBER
ObjectColumn SW_GEOMETRY
Commit Table City_125aa As
"C:\Projects\Data\TestScripts\English\remote\City_125aacpy.tab" Type ODBC
Connection 1 Table """EAZYLOADER"".""CITY_125AACPY"""
or
Commit Table City_125aa As
"C:\Projects\Data\TestScripts\English\remote\City_125aacpy.tab" Type ODBC
Connection 1 Table "EAZYLOADER.CITY_125AACPY"
48
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
GeocodeInfo( ) function
Purpose
We have added a new attribute to this function to handle the maximum number of addresses that the
server will permit to be sent to the service at a time.
Syntax
GeoCodeInfo( connection_handle, attribute )
connection_handle is an Integer.
attribute is an Integer code, indicating which type of information should be returned.
Return Value
Float, Integer, SmallInt, Logical, or String, depending on the attribute parameter.
Description
The GeoCodeInfo( ) function returns the properties defaulted by the connection or the properties
that have been changed using Set GeoCode. Like many functions of this type in MapBasic, the
return values vary according to the attribute parameter. All the codes for these values are listed in
MAPBASIC.DEF.
GEOCODE_MAX_BATCH_SIZE
Integer value representing the maximum number of records (i.e., addresses) that the server will
permit to be sent to the service at one time.
Example
The following MapBasic snippet will print the Envinsa Location Utility Constraints to the message
window in MapInfo Professional:
Include "MapBasic.Def"
declare sub main
sub main
dim iConnect as integer
Open Connection Service Geocode Envinsa
URL
"http://envinsa_server:8066/LocationUtility/services/LocationUtility"
User "john"
Password "green"
into variable iConnect
Print "Geocode Max Batch Size: " +
GeoCodeInfo(iConnect,GEOCODE_MAX_BATCH_SIZE)
end sub
Reference Guide
49
IsogramInfo( ) function
IsogramInfo( ) function
Purpose
New attributes have been added to this function to handle the maximum number of records for
server, time, and distance values.
Syntax
IsogramInfo( connection_handle, attribute )
connection_handle is an integer signifying the number of the connection returned from the Open
Connection statement.
attribute is an Integer code, indicating which type of information should be returned.
Return Value
Float, Logical, or String, depending on the attribute parameter.
Description
This function returns the properties defaulted by the connection or the properties that have been
changed using the Set Connection Isogram statement.
There are several attributes that IsogramInfo( ) can return. Codes are defined in MAPBASIC.DEF.
Attribute Setting
50
IsogramInfo Return Value
ISOGRAM_MAX_BATCH_SIZE
Integer value representing the maximum number of
records (i.e., points) that the server will permit to be sent
to the service at one time.
ISOGRAM_MAX_BANDS
Integer value representing the maximum number of Iso
bands (i.e., distances or times) allowed.
ISOGRAM_MAX_DISTANCE
Float value representing the maximum distance permitted
for an Isodistance request. The distance units are
specified by ISOGRAM_MAX_DISTANCE_UNITS.
ISOGRAM_MAX_DISTANCE_UNITS
String value representing the units for
ISOGRAM_MAX_DISTANCE.
ISOGRAM_MAX_TIME
Float value representing the maximum time permitted for
an Isochrone request. The time units are specified by
ISOGRAM_MAX_TIME_UNITS.
ISOGRAM_MAX_TIME_UNITS
String value representing the units for
ISOGRAM_MAX_TIME.
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Example
The following MapBasic snippet will print the Envinsa Routing Constraints to the message window in
MapInfo Professional:
Include "MapBasic.Def"
declare sub main
sub main
dim iConnect as integer
Open Connection Service Isogram
URL "http://envinsa_server:8062/Route/services/Route"
User "john"
Password "green"
into variable iConnect
Print "Isogram_Max_Batch_Size: " +
IsogramInfo(iConnect,Isogram_Max_Batch_Size)
Print "Isogram_Max_Bands: " + IsogramInfo(iConnect, Isogram_Max_Bands)
Print "Isogram_Max_Distance: " + IsogramInfo(iConnect,
Isogram_Max_Distance)
Print "Isogram_Max_Distance_Units: " + IsogramInfo(iConnect,
Isogram_Max_Distance_Units)
Print "Isogram_Max_Time: " + IsogramInfo(iConnect,Isogram_Max_Time)
Print "Isogram_Max_Time_Units: " +
IsogramInfo(iConnect,Isogram_Max_Time_Units)
Close Connection iConnect
end sub
LabelInfo( ) function
Purpose
Returns information about a label in a map. LabelInfo can return a label as a text object. However, if
the label is curved, it will be returned as rotated flat text.
Syntax
Labelinfo( map_window_id, layer_number, attribute )
Description
The attribute parameter must be one of the codes from the following table; codes are defined in
MAPBASIC.DEF.
Reference Guide
51
LayerInfo( ) function
attribute code
Labelinfo( ) Return Value
LABEL_INFO_ORIENTATION
Returns Smallint value indicating the 'current' label's orientation.
The current label is initialized by using one of the following Label
functions: LabelFindFirst, LabelFindByID, or LabelFindNext. The
Return value will be one of these:
•
•
•
LAYER_INFO_LABEL_ORIENT_HORIZONTAL (label has
angle equal to 0)
LAYER_INFO_LABEL_ORIENT_PARALLEL (label has nonzero angle)
LAYER_INFO_LABEL_ORIENT_CURVED (label is curved)
LayerInfo( ) function
Purpose of the New Attributes
New attribute value LAYER_INFO_HOTLINK_COUNT will allow programmers to query the number
of hotlink definitions in a layer.
For backwards compatibility, the original set of attributes will still work, and will return the values for
the layer's first hotlink definition. If no hotlinks are defined when the function is called, then the
following values are returned:
LAYER_INFO_HOTLINK_EXPR - empty string ("")
LAYER_INFO_HOTLINK_MODE - returns default value HOTLINK_MODE_LABEL
LAYER_INFO_HOTLINK_RELATIVE - returns default value FALSE
New Attribute:
LAYER_INFO_LABEL_ORIENTATION - Returns Smallint value indicating the setting for the layer's
auto label orientation. Return value will be one of these values:
LAYER_INFO_LABEL_ORIENT_HORIZONTAL (labels have angle equal to 0)
LAYER_INFO_LABEL_ORIENT_PARALLEL
(labels have non-zero angle)
LAYER_INFO_LABEL_ORIENT_CURVED
(labels are curved)
Note: If LAYER_INFO_LABEL_ORIENT_PARALLEL is returned, then
LAYER_INFO_LABEL_PARALLEL will return TRUE.
52
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Register Table statement
Purpose
Builds a MapInfo Professional table from a spreadsheet, database, text file, raster, or grid image.
Syntax
Register Table source_file
{ Type "NATIVE" |
Type "DBF" [ Charset char_set ] |
Type "ASCII" [ Delimiter delim_char ][ Titles ][ CharSet char_set ] |
Type "WKS" [ Titles ] [ Range range_name ] |
Type "WMS" Coordsys...
Type "WFS" [ Charset char_set ] Coordsys... [ Symbol... ]
[ Linestyle Pen(...) ] [ Regionstyle Pen(...) Brush(...) ]
Type "XLS" [ Titles ] [ Range range_name ] [ Interactive ] |
Type "Access" Table table_name [ Password pwd ] [ CharSet char_set ]}
Type ODBC
Connection { Handle ConnectionNumber | ConnectionString }
Toolkit toolkitname
Cache { ON | OFF }
[ Autokey { ON | OFF }]
Table SQLQuery
[ Versioned { ON | OFF }]
[ Workspace WorkspaceName ]
[ ParentWorkspace ParentWorkspaceName ]
Type "GRID" | Type "RASTER"
[ ControlPoints ( MapX1, MapY1 ) ( RasterX1, RasterY1 ),
( MapX2, MapY2 ) ( RasterX2, RasterY2 ),
( MapX3, MapY3 ) ( RasterX3, RasterY3 )
[, ... ]
]
[ CoordSys ... ]
Type "FME" [ Charset char_set ]
CoordSys...
Format format type
Schema featuretype
[ Use Color ]
[ Database ]
[ SingleFile ]
[ Symbol...]
[ Linestyle Pen(...) ]
[ Regionstyle Pen(...) Brush(...) ]
[ Font ... ]
Settings string1 [, string2 .. ]
Type "SHAPEFILE" [ Charset char_set ] CoordSys...
[ PersistentCache { ON | OFF } ]
[ Symbol...] [ Linestyle Pen(...) ]
[ Regionstyle Pen(...) Brush(...) ]
[ Into destination_file ]
Reference Guide
53
Server Create Table statement
Charset char_set - this is optional parameter. If character set is not specified in MapBasic, then
system character set is used. This is similar to all other formats.
CoordSys... - CoordSys clause is required.
Format formattype - formattype is a string that is used by FME to identify format that is opened.
Schema featuretype - specifies a featuretype (essentially schema name).
Settings string1 [, string2 .. ] - These are Safe Software FME-specific settings that vary depending
upon the format and settings options the user selects.
Use Color - specifies if color information from dataset is used
Database - specifies if referenced data source is from a database
SingleFile - specifies if referenced data source consist of a single file
Example
Register Table "D:\MUT\DWG\Data\africa_miller.DWG" Type "FME" CoordSys
Earth Projection 11, 104, "m", 0 Format "ACAD" Schema "africa_miller" Use
Color SingleFile Symbol (35,0,16) Linestyle Pen (1,2,0) RegionStyle Pen
(1,2,0) Brush (2,16777215,16777215)
Font ("Arial",0,9,0) Settings
"RUNTIME_MACROS","METAFILE,acad,_EXPAND_BLOCKS,yes,ACAD_IN_USE_BLOCK_HEAD
ER_LAYER,yes,ACAD_IN_RESOLVE_ENTITY_COLOR,yes,_EXPAND_VISIBLE,yes,_BULGES
_AS_ARCS,no,_STORE_BULGE_INFO,no,_READ_PAPER_SPACE,no,ACAD_IN_READ_GROUPS
,no,_IGNORE_UCS,no,_ACADPreserveComplexHatches,no,_MERGE_SCHEMAS,YES",
"META_MACROS","Source_EXPAND_BLOCKS,yes,SourceACAD_IN_USE_BLOCK_HEADER_LA
YER,yes,SourceACAD_IN_RESOLVE_ENTITY_COLOR,yes,Source_EXPAND_VISIBLE,yes,
Source_BULGES_AS_ARCS,no,Source_STORE_BULGE_INFO,no,Source_READ_PAPER_SPA
CE,no,SourceACAD_IN_READ_GROUPS,no,Source_IGNORE_UCS,no,Source_ACADPreser
veComplexHatches,no", "METAFILE","acad", "COORDSYS","", "IDLIST","" Into
"C:\Temp\africa_miller.tab"
Open table "C:\Temp\africa_miller.tab"
Map From "africa_miller"
Server Create Table statement
There is no specific change in terms of syntax. We do have following restrictions for the some data
types:
In release 9.0, there are two new MapInfo date types, Time and DateTime, which were added to
meet customers needs. However, most databases do not have a corresponding DBMS TIME types.
Before this release, we only supported the Date type. Even the Date was converted to server type If
the server did not support Date type. Starting 9.0, this statement only supports the types that the
server also supports. Therefore, the Time type is prohibited from this statement for all supported
servers (such as Oracle, IBM Informix, MS SQL Server and Access) and the Date type data type is
prohibited for MS SQL Server and Access. Those "unsupported” types should be replaced with
DateTime if you still want to create the table that contains time information on a column.
Note: For MS SQL Server and Access, the restriction could be a backward compatibility issue. In
the previous release, we did the conversion in the background. As of 9.0, the users must
choose to use DATETIME instead of DATE. If you still use DATE, the operation will fail.
54
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Server ConnectionNumber Create Table TableName(ColumnName ColumnType [,…])
[KeyColumn ColumnName]
[ObjectColumn ColumnName]
[StyleColumn ColumnName]
[CoordSys... ]
TableName is the name of the table as you want it to appear in database. Starting release 9.0, the
name can include a schema name which specifies the schema that the table belongs to. If no
schema name is provided, the table belongs to the default schema as in 8.5 and earlier versions.
The user is responsible for providing an eligible schema name and must know if the login user has
the proper permissions on the given schema. This extension is for SQL Server 2005 only.
Set Map statement
LabelClause Change
This change allows for the creation of curved labels.
Syntax
Each LABELCLAUSE has the syntax described below:
[
[
[
[
[
[
[
[
[
[
[
[
[
[
Label [ Line { Simple | Arrow | None } ]
Position [ Center ] [ Above | Below ] [ Left | Right ] ]]
Font... ] [ Pen... ]
With label_expr ]
Parallel { On | Off } | Follow Path ]
Visibility { On | Off | Zoom( min_vis, max_vis ) [ Units dist_unit ] } ]
Auto [ { On | Off } ] ]
Overlap [ { On | Off } ] ]
PartialSegments { On | Off } ]
Duplicates [ { On | Off } ] ]
Max [ number_of_labels ] ]
Offset offset_amount ]
Default ]
Object ID
[ Table alias ]
[ Visibility { On | Off } ]
[ Anchor ( anchor_x, anchor_y ) ]
Text text_string
[ Position [ Center ] [ Above | Below ] [ Left | Right ] ]
[ Font... ] [ Pen... ]
[ Line { Simple | Arrow | None } ]
[ Angle text_angle | Follow Path ]
[ Offset offset_amount ]
[ Callout ( callout_x, callout_y ) ] }
[ Object... ]
]
Reference Guide
55
Set Map statement
Parallel This parameter contains the following attributes:
Parallel Off = creates horizontal labels, not rotated with line
Parallel On = creates labels rotated with line
Follow Path clause = creates curved label, with the path auto calculated once and stored until
location edited
Example
Set Map Layer 1 Label Follow Path
Layer Activate clause
The hotlink settings are currently persisted via Set Map Layer Activate, which has been expanded to
support a multiple hotlink definitions. This includes the ability to add new items, modify the attribute
of existing items, remove and reorder items. Below is a description of the different "flavors" of the
Activate clause, including syntax details. See the Exceptions to Support Backwards
Compatibility section for a discussion of how MapBasic supports legacy syntax.
Note that the properties of an individual hotlink are the same as in prior version, except for the new
Enable clause, which allow the user to "turn off" a hotlink while preserving the definition. (In a prior
version the user disabled the hotlink by setting the expression to "", losing the original expression.)
Purpose
The purpose of Activate is to allow you to define new hotlinks. You use a hotlink to launch a file or a
URL from a Map window.
Syntax
{ Using launch_expr[ On { [ [ Labels ] | [ Objects ] ] } ] | [ Relative
Path { On | Off } ] [ Enable { On | Off } ] },
[ Using launch_expr[ On { [ [ Labels ] | [ Objects ] ] } ] | [ Relative
Path { On | Off } ] [ Enable { On | Off } ] ]...
Example
Set Map Layer 1 Activate Using Url1 On Objects Relative Path Off Enable
On, Using Url2 On Objects Relative Path On Enable On
Notes
This version of the command wipes out any existing definitions and one or more new definitions. The
Using clause is required and launch_exprmust not be an empty string (for example, ""). When the
Enable clause is included and set to Off, the hotlink definition will be disabled. The On, Relative and
Enable clauses are optional.
56
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Adding New HotLink Definitions
Syntax
Activate Add [ First
{ Using launch_expr[
Path { On | Off }
[ Using launch_expr[
Path { On | Off }
]
On { [ [ Labels
] [ Enable { On
On { [ [ Labels
] [ Enable { On
]
|
]
|
| [
Off
| [
Off
Objects ] ] } ] | [ Relative
} ] },
Objects ] ] } ] | [ Relative
} ]...
Examples
Activate Add Using URL1 On Objects Relative Path On, Using URL2 On Objects
Enabled Off
Activate Add First Using URL1 On Objects
Comments
The MapBasic 9.0 version of this command adds a new hotlink def at the end of the hotlink list.
It can include the optional First keyword to insert the new items at the beginning of the list.
When the Enable clause is included and set to Off, the hotlink definition will be disabled.
The On, Relative and Enable clauses are optional.
Modifying Existing HotLinks Definitions
Syntax
Activate Modify
{ hotlink_id[ Using
] | [ Relative Path
[ hotlink_id[ Using
] | [ Relative Path
launch_expr ] | [ On { [ [ Labels ] | [ Objects ] ] }
{ On | Off } ] [ Enable { On | Off } },
launch_expr ] | [ On { [ [ Labels ] | [ Objects ] ] }
{ On | Off } ] [ Enable { On | Off } ]...
Examples
Activate
Activate
Activate
Activate
Modify
Modify
Modify
Modify
1
2
3
2
Using URL1 On
On Objects, 4
Relative Path
Enable Off, 3
Objects, 2 Relative Path Off
On Labels
On Enable Off
Enable On
Comments
hotlink_id is an integer index (1-based) that specifies the hotlink definition to modify
At least one of the Using/On/Relative/Enabled clauses is required.
launch_expr must not be an empty string (for example, "").
When the Enable clause is included and set to Off, the hotlink definition will be disabled.
Reference Guide
57
SystemInfo() function
Removing HotLink Definitions
Syntax
Activate Remove { All | hotlink_id [ , hotlink_id, hotlink_id, ... ] }
Examples
Activate Remove 2, 4
Activate Remove All
Comments
hotlink_id is an integer index (1-based) that specifies the hotlink definition to modify.
At least one hotlink_id must be specified.
If the All keyword is used, then all hotlink definitions are removed.
Reordering HotLink Definitions
Syntax
Activate Order { hotlink_id [ , hotlink_id, hotlink_id, ... ] }
Examples
Activate Order 2, 3, 1
Comments
hotlink_id is an integer index (1-based) that specifies the hotlink definition to modify
At least one hotlink_id must be specified.
Exceptions to Support Backwards Compatibility
The Using clause can be omitted, but only from the first HotLink definition. The Using expression
can be empty (""), but only for the first HotLink definition.
SystemInfo() function
Purpose:
This function has a new attribute to return the current build number so you can distinguish between
MapInfo Professional point versions in MapBasic. For example,
SystemInfo(SYS_INFO_MIVERSION) returns 850 for MapInfo Professional 8.5 and 8.5.2. You can
further distinguish between 8.5 and 8.5.2 with SystemInfo(SYS_INFO_MIBUILD_NUMBER), which
returns 32 for 8.5, and 60 for 8.5.2.
58
MapBasic 9.0
Chapter 2: New and Enhanced MapBasic Statements and Functions
Syntax:
SystemInfo(SYS_INFO_MIBUILD_NUMBER)
Note: The MapBasic.def constant for this function is 18.
TableInfo( ) function
Purpose
Returns information about an open table. Added a new define for FME tables.
Syntax
TableInfo( table_id, attribute )
table_id is a string representing a table name, a positive integer table number, or 0 (zero).
attribute is an integer code indicating which aspect of the table to return.
Return Value
String, SmallInt, or logical, depending on the attribute parameter specified.
The attribute parameter can be any value from the table below. Codes in the left column (for
example, TAB_INFO_NAME) are defined in MAPBASIC.DEF.
attribute code
TableInfo( ) returns
TAB_INFO_TYPE
SmallInt result, indicating the type of table. The returned value will match one
of these:
•
•
•
•
•
•
•
•
Reference Guide
TAB_TYPE_BASE (if a normal or seamless table).
TAB_TYPE_RESULT (if results of a query).
TAB_TYPE_IMAGE (if table is a raster image).
TAB_TYPE_VIEW (if table is actually a view; for example, StreetInfo
tables are actually views).
TAB_TYPE_LINKED (if this table is linked).
TAB_TYPE_WMS (if table is from a Web Map Service).
TAB_TYPE_WFS (if table is from a Web Feature Service).
TAB_TYPE_FME (if table is opened through FME).
59
TableInfo( ) function
60
MapBasic 9.0
A – Z MapBasic
Language Reference
This section describes the MapBasic language in detail. You will find both
statements and function descriptions arranged alphabetically. Each is
described in the following format:
Purpose
Brief description of the function or statement.
Restrictions
Information about limitations (for example, “The DDEInitiate function is only
available under Microsoft Windows,” “You cannot issue a For…Next
statement through the MapBasic window”).
Syntax
The format in which you should use the function or statement and
explanation of argument(s).
Return Value
The type of value returned by the function.
Description
Thorough explanation of the function or statement's role and any other
pertinent information.
Example
A brief example.
Related functions or statements. Most MapBasic statements can be typed
directly into MapInfo Professional, through the MapBasic window. If a
statement may not be entered through the MapBasic window, the
Restrictions section identifies the limitation. Generally, flow-control
statements (such as looping and branching statements) cannot be entered
through the MapBasic window.
See Also
Abs( )function to Continue statement
3
ConvertToPline( ) function to CurrentSymbol( ) function
DateWindow( ) function to Graph statement
HomeDirectory$( ) function to NumWindows( ) function
ObjectDistance( ) function to Run Program statement
Save File statement to Sgn( ) function
Shade statement to Year( ) function
62
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Abs( )function
Purpose
Returns the absolute value of a number.
Syntax
Abs ( num_expr )
num_expr is a numeric expression.
Return Value
Float
Description
The Abs( ) function returns the absolute value of the expression specified by num_expr.
If num_expr has a value greater than or equal to zero, Abs( ) returns a value equal to num_expr. If
num_expr has a negative value, Abs( ) returns a value equal to the value of num_expr multiplied by
negative one (-1).
Example
Dim f_x, f_y As Float
f_x = -2.5
f_y = Abs(f_x)
' f_y now equals 2.5
See Also
Sgn( ) function
Acos( ) function
Purpose
Returns the arc-cosine value of a number.
Syntax
Acos ( num_expr )
num_expr is a numeric expression between one and negative one, inclusive.
Return Value
Float
Reference Guide
63
Acos( ) function
Description
The Acos( ) function returns the arc-cosine of the numeric num_expr value. In other words, Acos( )
returns the angle whose cosine is equal to num_expr.
The result returned from Acos( ) represents an angle, expressed in radians. This angle will be
somewhere between zero and Pi radians (given that Pi is equal to approximately 3.141593, and
given that Pi/2 radians represents 90 degrees).
To convert a degree value to radians, multiply that value by DEG_2_RAD. To convert a radian value
into degrees, multiply that value by RAD_2_DEG. Your program must Include MAPBASIC.DEF in
order to reference DEG_2_RAD or RAD_2_DEG.
Since cosine values range between one and negative one, the expression num_expr should
represent a value no larger than one and no smaller than negative one.
Example
Include "MAPBASIC.DEF"
Dim x, y As Float
x = 0.5
y = Acos(x) * RAD_2_DEG
' y will now be equal to 60,
' since the cosine of 60 degrees is 0.5
See Also
Asin( ) function, Atn( ) function, Cos( ) function, Sin( ) function, Tan( ) function
64
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Add Cartographic Frame statement
The Add Cartographic Frame statement allows you to add cartographic frames to an existing
cartographic legend created with the Create Cartographic Legend statement.
Syntax
Add Cartographic Frame
[ Window legend_window_id ]
[ Custom ]
[ Default Frame Title { def_frame_title } [ Font... ] ]
[ Default Frame Subtitle { def_frame_subtitle } [ Font... ] ]
[ Default Frame Style { def_frame_style } [ Font... ] ]
[ Default Frame Border Pen... pen_expr ]
Frame From Layer { map_layer_id | map_layer_name }
[ Position ( x , y ) [ Units paper_units ] ]
[ Using
[ Column { column | object [ FromMapCatalog { On | Off }]} ]
[ Label { expression | default } ]
[ Title [ frame_title ] [ Font... ] ]
[ SubTitle [ frame_subtitle ] [ Font... ] ]
[ Border Pen... ]
[ Style [Font...] [ NoRefresh ]
[ Text { style_name } { Line Pen...
| Region Pen... Brush...
| Symbol Symbol... } ]
[ , ... ]
]
[ , ... ]
legend_window_id is an integer window identifier which you can obtain by calling the
FrontWindow( ) function and WindowID( ) function.
def_frame_title is a string which defines a default frame title. It can include the special character “#”
which will be replaced by the current layer name.
def_frame_subtitle is a string which defines a default frame subtitle. It can include the special
character “#” which will be replaced by the current layer name.
def_frame_style is a string that displays next to each symbol in each frame. The “#” character will be
replaced with the layer name. The “%” character will be replaced by the text “Line”, “Point, “Region”,
as appropriate for the symbol. For example, “% of #” will expand to “Region of States” for the
states.tab layer.
pen_expr is a Pen expression, e.g., MakePen( width, pattern, color ). If a default border
pen is defined, then it will be become the default for the frame. If a border pen clause exists at the
frame level, then it is used instead of the default.
map_layer_id or map_layer_name identifies a map layer; can be a SmallInt (e.g., use 1 to specify
the top map layer other than Cosmetic) or a string representing the name of a table displayed in the
map. For a theme layer you must specify the map_layer_id.
paper_units is a string representing a paper unit name (for example, “cm” for centimeters).
Reference Guide
65
Add Cartographic Frame statement
frame_title is a string which defines a frame title. If a Title clause is defined here for a frame, then it
will be used instead of the def_frame_title.
frame_subtitle is a string which defines a frame subtitle. If a SubTitle clause is defined here for a
frame, then it will be used instead of the def_frame_subtitle.
column is an attribute column name from the frame layer's table, or the object column (meaning that
legend styles are based on the unique styles in the mapfile). The default is 'object'.
style_name is a string which displays next to a symbol, line, or region in a custom frame.
Description
If the Custom keyword is included, then each frame section must include a Position clause. If
Custom is omitted and the legend is laid out in portrait or landscape, then the frames will be added
to the end.
The Position clause controls the frame's position on the legend window. The upper left corner of the
legend window has the position 0, 0. Position values use paper units settings, such as “in” (inches)
or “cm” (centimeters). MapBasic has a current paper units setting, which defaults to inches; a
MapBasic program can change this setting through the Set Paper Units statement.You can
override the current paper units by including the optional Units subclause within the Position
clause.
The defaults in this statement apply only to the frames being created in this statement. They have no
affect on existing frames. Frame defaults used in the Create Cartographic Legend statement have
no affect on frames created in this statement.
When you save to a workspace, the FromMapCatalog OFF clause is written to the workspace when
specified. This requires the workspace to bumped up to 800. If the FromMapCatalog ON clause is
specified, we do not write it to the workspace since it is default behavior. This lets us avoid bumping
up the workspace version in this case.
FromMapCatalog ON retrieves styles from the MapCatalog for a live access table. If the table is not
a live access table, MapBasic reverts to the default behavior for a non-live access table instead of
throwing an error. The default behavior for a non-access table is FromMapCatalog Off (i.e., map
styles).
FromMapCatalog OFF retrieves the unique map styles for the live table from the server. This table
must be a live access table that supports per record styles for this to occur. If the live table does not
support per record styles than the behavior is to revert to the default behavior for live tables, which is
to get the default styles from the MapCatalog (FromMapCatalog ON).
Label is a valid expression or default (meaning that the default frame style pattern is used when
creating each style's text, unless the style clause contains text). The default is default.
66
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
The Style clause and the NoRefresh keyword allow you to create a custom frame that will not be
overwritten when the legend is refreshed. If the NoRefresh keyword is used in the Style clause,
then the table is not scanned for styles. Instead, the Style clause must contain your custom list of
definitions for the styles displayed in the frame. This is done with the Text and appropriate Line,
Region, or Symbol clause.
See Also
Create Cartographic Legend statement, Set Cartographic Legend statement, Alter
Cartographic Frame statement, Remove Cartographic Frame statement
Add Column statement
Purpose
Adds a new, temporary column to an open table, or updates an existing column with data from
another table.
Syntax
Add Column table ( column [ datatype ] )
{ Values const [ , const ... ] |
From source_table
Set To expression
[ Where { dest_column = source_column |
Within | Contains | Intersects } ]
[ Dynamic ] }
table is the name of the table to which a column will be added.
column is the name of a new column to add to that table.
datatype is the data type of the column, defined as Char(width), Float, Integer, SmallInt,
Decimal(width, decimal_places), Date or Logical; if not specified, type defaults to Float.
source_table is the name of a second open table.
expression is the expression used to calculate values to store in the new column; this expression
usually extracts data from the source_table, and it can include aggregate functions.
dest_column is the name of a column from the destination table (table).
source_column is the name of a column from the source_table.
Dynamic specifies a dynamic (hot) computed column that can be automatically update: if you
include this keyword, then subsequent changes made to the source table are automatically applied
to the destination table.
Description
The Add Column statement creates a temporary new column for an existing MapInfo Professional
table. The new column will not be permanently saved to disk. However, if the temporary column is
based on base tables, and if you save a workspace while the temporary column is in use, the
Reference Guide
67
Add Column statement
workspace will include information about the temporary column, so that the temporary column will be
rebuilt if the workspace is reloaded. To add a permanent column to a table, use the Alter Table
statement and Update statement.
Filling The New Column With Explicit Values
Using the Values clause, you can specify a comma-separated list of explicit values to store in the
new column.
The following example adds a temporary column to a table of “ward” regions. The values for the new
column are explicitly specified, through the Value clause.
Open Table "wards"
Add Column wards(percent_dem)
Values 31,17,22,24,47,41,66,35,32,88
Filling The New Column With Values From Another Table
If you specify a From clause instead of a Values clause, MapBasic derives the values for the new
column from a separate table (source_table). Both tables must already be open.
When you use a From clause, MapInfo Professional joins the two tables. To specify how the two
tables are joined, include the optional Where clause. If you omit the Where clause, MapInfo
Professional automatically tries to join the two tables using the most suitable method.
A Where clause of the form Where column = column joins the two tables by matching column
values from the two tables. This method is appropriate if a column from one of your tables has
values matching a column from the other table (e.g., you are adding a column to the States table,
and your other table also has a column containing state names).
If both tables contain map objects, the Where clause can specify a geographic join. For example, if
you specify the clause Where Contains, MapInfo Professional constructs a join by testing whether
objects from the source_table contain objects from the table that is being modified.
The following example adds a “County” column to a “Stores” table. The new column will contain
county names, which are extracted from a separate table of county regions:
Add Column
stores(county char(20) 'add "county" column
From counties 'derive data from counties table...
Set to cname 'using the counties table's "cname" column
Where Contains 'join: where a county contains a store site
The Where Contains method is appropriate when you add a column to a table of point objects, and
the secondary table represents objects that contain the points.
The following example adds a temporary column to the States table. The new column values are
derived from a second table (City_1K, a table of major U.S. cities). After the completion of the Add
Column statement, each row in the States table will contain a count of how many major cities are in
that state.
68
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Open Table "states" Interactive
Open Table "city_1k" Interactive
Add Column states(num_cities)
From city_1k 'derive values from other table
Set To Count(*)'count cities in each state
Where Within 'join: where cities fall within states
The Set To clause in this example specifies an aggregate function, Count(*). Aggregate functions
are described below.
Filling An Existing Column With Values From Another Table
To update an existing column instead of adding a new column, omit the datatype parameter and
specify a From clause instead of a Values clause. When updating an existing column, MapBasic
ignores the Dynamic clause.
Filling The New Column With Aggregate Data
If you specify a From clause, you can calculate values for the new column by aggregating data from
the second table. To perform data aggregation, specify a Set To clause that includes an aggregate
function.
The following table lists the available aggregate functions.
Function
Value Stored In The New Column
Avg( col )
Average of values from rows in the source table.
Count( * )
Number of rows in the source table that correspond to the
row in the table being updated.
Max( col )
Largest of the values from rows in the source table.
Min( col )
Smallest of the values from rows in the source table.
Sum( col )
Sum of the values from rows in the source table.
WtAvg( col, weight_col )
Weighted average of the values from the source table; the
averaging is weighted so that rows having a large
weight_col value have more of an impact than rows
having a small weight_col value.
Proportion Avg( col )
Average calculation that makes adjustments based on
how much of an object is within another object.
Proportion Sum( col )
Sum calculation that makes adjustments based on how
much of an object is within another object.
Proportion WtAvg( col , weight_col )
Weighted average calculation that makes adjustments
based on how much of an object is within another object.
Reference Guide
69
Add Column statement
Most of the aggregate functions operate on data values only. The last three functions (Proportion
Sum, Proportion Avg, Proportion WtAvg) perform calculations that take geographic relationships into
account. This is best illustrated by example.
Suppose you have a Counties table, containing county boundary regions and demographic
information (such as population) about each county. You also have a Risk table, which contains a
region object. The object in the Risk table represents some sort of area that is at risk; perhaps the
region object represents an area in danger of flooding due to proximity to a river.
1
2
1 County Boundaries 2 Risk Buffer Region
Given these two tables, you might want to calculate the population that lives within the risk region. If
half of a county's area falls within the risk region, you will consider half of that county's population to
be at risk; if a third of a county's area falls within the risk region, you will consider a third of that
county's population to be at risk; etc.
The following example calculates the population at risk by using the Proportion Sum aggregate
function, then stores the calculation in a new column (population_at_risk):
Add Column Risk(population_at_risk Integer)
From counties
Set To Proportion Sum(county_pop)
Where Intersects
For each county that is at least partly within the risk region, MapInfo Professional adds some or all of
the counties county_pop value to a running total.
The Proportion Sum function produces results based on an assumption—the assumption that the
number being totalled is distributed evenly throughout the region. If you use Proportion Sum to
process population statistics, and half of a region falls within another region, MapInfo Professional
adds half of the region's population to the total. In reality, however, an area representing half of a
region does not necessarily contain half of the region's population. For example, the population of
New York State is not evenly distributed, because a large percentage of the population lives in New
York City.
70
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
If you use Proportion Sum in cases where the data values are not evenly distributed, the results
may not be realistic. To ensure accurate results, work with smaller region objects (for example,
operate on county regions instead of state regions).
The Proportion Avg aggregate function performs an average calculation which takes into account
the percentage of an object that is covered by another object. Continuing the previous example,
suppose the County table contains a column, median_age, that indicates the median age in each
county.
The following statement calculates the median age within the risk zone:
Add Column Risk(age Float)
From Counties
Set To Proportion Avg(median_age)
Where Intersects
For each row in the County table, MapInfo Professional calculates the percentage of the risk region
that is covered by the county; that calculation produces a number between zero and one, inclusive.
MapInfo Professional multiplies that number by the county’s median_age value, and adds the result
to a running total. Thus, if a county has a median_age value of 50, and if the county region covers
10% of the risk region, MapInfo Professional adds 5 (five) to the running total, because 10% of 50 is
5.
Proportion WtAvg is similar to Proportion Avg, but it also lets you specify a data column for
weighting the average calculation; the weighting is also proportionate.
Using Proportion… Functions With Non-Region Objects
When you use Proportion functions and the source table contains region objects, MapInfo
Professional calculates percentages based on the overlap of regions. However, when the source
table contains non-region objects, MapInfo Professional treats each object as if it were completely
inside or completely outside of the destination region (depending on whether the non-region object's
centroid is inside or outside of the destination region).
Dynamic Columns
If you include the optional Dynamic keyword, the new column becomes a dynamic computed
column, meaning that subsequent changes made to the source table are automatically applied to
the destination table.
If you create a dynamic column, and then close the source table used to calculate the dynamic
column, the column values are frozen (the column is no longer updated dynamically).
Similarly, if a geographic join is used in the creation of a dynamic column, and you close either of the
maps used for the geographic join, the column values are frozen.
See Also
Alter Table statement, Update statement
Reference Guide
71
Add Map statement
Add Map statement
Purpose
Adds another layer to a Map window.
Syntax
Add Map
[ Window window_id ]
[ Auto ]
Layer table [ , table ... ]
[ Animate ]
window_id is the window identifier of a Map window.
table is the name of a mappable open table to add to a Map window.
Description
The Add Map statement adds one or more open tables to a Map window. MapInfo Professional then
automatically redraws the Map window, unless you have suppressed redraws through a Set Event
Processing Off statement or Set Map…Redraw Off statement.
The window_id parameter is an integer window identifier representing an open Map window; you
can obtain a window identifier by calling the FrontWindow( ) function and WindowID( ) function. If
the Add Map statement does not specify a window_id value, the statement affects the topmost Map
window.
If you include the optional Auto keyword, MapInfo Professional tries to automatically position the
map layer at an appropriate place in the set of layers. A raster table or a map of region objects would
be placed closer to the bottom of the map, while a map of point objects would be placed on top.
If you omit the Auto keyword, the specified table becomes the topmost layer in the window; in other
words, when the map is redrawn, the new table layer will be drawn last. You can then use the Set
Map statement to alter the order of layers in the Map window.
Adding Layers of Different Projections
If the layer added is a raster table, and the map does not already contain any raster map layers, the
map adopts the coordinate system and projection of the raster image. If a Map window contains two
or more raster layers, the window dynamically changes its projection, depending on which image
occupies more of the window at the time.
72
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
If the layer added is not a raster table, MapInfo Professional continues to display the Map window
using whatever coordinate system and projection were used before the Add Map statement, even if
the table specified is stored with a different native projection or coordinate system. When a table's
native projection differs from the projection of the Map window, MapInfo Professional converts the
table coordinates “on the fly” so that the entire Map window appears in the same projection.
Note: When MapInfo Professional converts map layers in this fashion, map redraws take longer,
since MapInfo Professional must perform mathematical transformations while drawing the
map.
Using Animation Layers to Speed Up Map Redraws
If the Add Map statement includes the Animate keyword, the added layer becomes a special layer
known as the animation layer. When an object in the animation layer is moved, the Map window
redraws very quickly, because MapInfo Professional only redraws the one animation layer.
For an example of animation layers, see the sample program ANIMATOR.MB.
The animation layer is useful in real-time applications, where map features are updated frequently.
For example, you can develop a fleet-management application that represents each vehicle as a
point object. You can receive current vehicle coordinates by using GPS (Global Positioning Satellite)
technology, and then update the point objects to show the current vehicle locations on the map. In
this type of application, where map objects are constantly changing, the map redraws much more
quickly if the objects being updated are stored in the animation layer instead of a conventional layer.
The following example opens a table (Vehicles) and makes the table an animation layer:
Open Table "vehicles" Interactive
Add Map Layer vehicles Animate
If the Add Map statement specifies two or more layers and it includes the Animate keyword, the first
layer named becomes the animation layer, and the remaining layers are added to the map as
conventional layers.
To terminate the animation layer processing, issue a Remove Map…Layer Animate statement.
Animation layers have special restrictions. For example, users cannot use the Info tool to click on
objects in an animation layer. Also, each Map window can have only one animation layer. For more
information about animation layers, see the MapBasic User's Guide.
Example
Open Table "world"
Map From world
Open Table "cust1992" As customers
Open Table "lead1992" As leads
Add Map Auto Layer customers, leads
See Also
Map statement, Remove Map statement, Set Map statement
Reference Guide
73
Alter Button statement
Alter Button statement
Purpose
Enables, disables, selects, or deselects a button from a ButtonPad (toolbar).
Syntax
Alter Button { handler | ID button_id }
[ { Enable | Disable } ]
[ { Check | Uncheck } ]
handler is the handler that is already assigned to an existing button. The handler can be the name of
a MapBasic procedure, or a standard command code (e.g., M_TOOLS_RULER or
M_WINDOW_LEGEND) from MENU.DEF.
button_id is a unique integer button identification number.
Description
If the Alter Button statement specifies a handler (e.g., a procedure name), MapInfo Professional
modifies all buttons that call that handler. If the statement specifies a button_id number, MapInfo
Professional modifies only the button that has that ID.
The Disable keyword changes the button to a grayed-out state, so that the user cannot select the
button.
The Enable keyword enables a button that was previously disabled.
The Check and Uncheck keywords select and deselect ToggleButton type buttons, such as the
Show Statistics Window button. The Check keyword has the effect of “pushing in” a ToggleButton
control, and the Uncheck keyword has the effect of releasing the button. For example, the following
statement selects the Show Statistics Window button:
Alter Button M_WINDOW_STATISTICS Check
Note: Checking or unchecking a standard MapInfo Professional button does not automatically
invoke that button's action; thus, checking the Show/Hide Statistics button does not actually
show the Statistics window—it only affects the appearance of the button. To invoke an action
as if the user had checked or unchecked the button, issue the appropriate statement; in this
example, the appropriate statement is the Open Window Statistics.
Similarly, you can use the Check keyword to change the appearance of a ToolButton. However,
checking a ToolButton does not actually select that tool, it only changes the appearance of the
button. To make a standard tool the active tool, issue a Run Menu Command statement, such as
the following:
Run Menu Command M_TOOLS_RULER
To make a custom tool the active tool, use the syntax Run Menu Command ID IDnum.
See Also
Alter ButtonPad statement, Create ButtonPad statement, Run Menu Command statement
74
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Alter ButtonPad statement
Purpose
Displays / hides a ButtonPad (toolbar), or adds / removes buttons.
Syntax
Alter ButtonPad { current_title | ID pad_num }
[ Add button_definition [ button_definition ... ] ]
[ Remove { handler_num | ID button_id } [ , ... ] ]
[ Title new_title ]
[ Width w ]
[ Position ( x, y ) [ Units unit_name ] ]
[ ToolbarPosition ( row, column ) ]
[ { Show | Hide } ]
[ { Fixed | Float } ]
[ Destroy ]
current_title is the toolbar's title string (e.g., “Main”).
pad_num is the ID number for a standard toolbar: 1 for Main, 2 for Drawing, 3 for Tools, 4 for
Standard, 5 for ODBC.
button_id is a custom button's unique identification number.
handler_num is an integer handler code (e.g., M_TOOLS_RULER) from MENU.DEF.
new_title is a string that becomes the toolbar's new title; visible when toolbar is floating.
w is the pad width, in terms of the number of buttons across.
x, y specify the toolbar's position when floating; specified in paper units (e.g., inches).
unit_name is a string paper unit name (e.g., “in” for inches, “cm” for centimeters).
row, column specify the toolbar's position when docked (e.g., 0, 0 places the pad at the left edge of
the top row of toolbars, and 0, 1 represents the second toolbar on the top row).
Each button_definition clause can consist of the keyword Separator, or it can have the following
syntax:
{ PushButton | ToggleButton | ToolButton }
Calling { procedure | menu_code | OLE methodname | DDE server, topic }
[ ID button_id ]
[ Icon icon_code [ File file_spec ] ]
[ Cursor cursor_code [ File file_spec ] ]
[ DrawMode dm_code ]
[ HelpMsg msg ]
[ ModifierKeys { On | Off } ]
[ { Enable | Disable } ]
[ { Check | Uncheck } ]
procedure is the handler procedure to call when a button is used.
Reference Guide
75
Alter ButtonPad statement
menu_code is a standard MapInfo Professional menu code from MENU.DEF (e.g., M_FILE_OPEN);
MapInfo Professional runs the menu command when the user uses the button.
methodname is a string specifying an OLE method name. For details on the Calling OLE clause
syntax, see Create ButtonPad statement on page 169.
server and topic are strings specifying a DDE server and topic name. For details on the Calling DDE
clause syntax, see Create ButtonPad statement on page 169.
button_id specifies the unique button number. This number can be used: as a tag in help; as a
parameter to allow the handler to determine which button is in use (in situations where different
buttons call the same handler); or as a parameter to be used with the Alter Button statement.
Icon icon_code specifies the icon to appear on the button; icon_code can be one of the standard
MapInfo icon codes listed in ICONS.DEF (e.g., MI_ICON_RULER). If the File sub-clause specifies
the name of a file containing icon resources, icon_code is an integer resource ID identifying a
resource in the file.
Cursor cursor_code specifies the shape the mouse cursor should adopt whenever the user chooses
a ToolButton tool; cursor_code is a code (e.g., MI_CURSOR_ARROW) from ICONS.DEF. This
clause applies only to ToolButtons. If the File sub-clause specifies the name of a file containing icon
resources, cursor_code is an integer resource ID identifying a resource in the file.
dm_code specifies whether the user can click and drag, or only click with the tool; dm_code is a
code (e.g., DM_CUSTOM_LINE) from ICONS.DEF. Applies only to ToolButtons.
msg is a string that specifies the button's status bar help and, optionally, ToolTip help. The first part
of msg is the status bar help message. If the msg string includes the letters \n then the text following
the \n is used as the button's ToolTip help.
The ModifierKeys clause applies only to ToolButtons; it controls whether the shift and control keys
affect “rubber-band” drawing if the user drags the mouse while using a ToolButton. Default is Off
(modifier keys have no effect).
Description
Use the Alter ButtonPad statement to show, hide, modify, or destroy an existing ButtonPad. For an
introduction to ButtonPads, see the MapBasic User Guide.
To show or hide a ButtonPad, include the Show or Hide keyword; see example below. The user also
can show or hide ButtonPads by choosing the Options > Toolbars command.
To set whether the pad is fixed to the top of the screen (“docked”) or floating like a window, include
the Fixed or the Float keyword. The user can also control whether the pad is docked or not by
dragging the pad to or from the top of the screen.
When a pad is floating, its position is controlled by the Position clause; when a pad is docked, its
position is controlled by the ToolbarPosition clause.
To destroy a ButtonPad, include the Destroy keyword. Once a ButtonPad is destroyed, it no longer
appears in the Options > Toolbars dialog box.
76
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
The Alter ButtonPad statement can add buttons to existing ButtonPads, such as Main and
Drawing. There are three types of button controls you can add: PushButton controls (which the user
can click and release—for example, to display a dialog box); ToggleButton controls (which the user
can select by clicking, then deselect by clicking again); and ToolButton controls (which the user can
select, and then use for clicking on a Map or Layout window).
If you include the optional Disable keyword when adding a button, the button is disabled (grayed
out) when it appears. Subsequent Alter Button statements can enable the button. However, if the
button's handler is a standard MapInfo Professional command, MapInfo Professional automatically
enables or disables the button depending on whether the command is currently enabled.
If you include the optional Check keyword when adding a ToggleButton or a ToolButton, the button
is automatically selected (“checked”) when it first appears.
If the user clicks while using a custom ToolButton tool, MapInfo Professional automatically calls the
tool's handler, unless the user cancels (e.g., by pressing the Esc key while dragging the mouse). A
handler procedure can call CommandInfo( ) to determine where the user clicked. If two or more
tools call the same handler procedure, the procedure can call CommandInfo( ) to determine the ID
of the button currently in use.
Custom Icons and Cursors
The Icon clause specifies the icon that appears on the button. If you omit the File clause, the
parameter n must refer to one of the icon codes listed in ICONS.DEF (e.g., MI_ICON_RULER).
Note: MapInfo Professional has many built-in icons that are not part of the normal user interface. To
see a demonstration of these icons, run the sample program ICONDEMO.MBX. This sample
program displays icons, and also lets you copy any icon's define code to the clipboard (so
that you can then paste the code into your program).
The File file_spec sub-clause refers to a DLL file that contains bitmap resources; the n parameter
refers to the ID of a bitmap resource. For more information on creating Windows icons, see the
MapBasic User Guide.
A ToolButton definition also can include a Cursor clause, which controls the appearance of the
mouse cursor while the user is using the custom tool. Available cursor codes are listed in
ICONS.DEF (e.g., MI_CURSOR_CROSSHAIR or MI_CURSOR_ARROW). The procedure for
specifying a custom cursor is similar to the procedure for specifying a custom icon.
Custom Drawing Modes
A ToolButton definition can include a DrawMode clause, which controls whether the user can drag
with the tool (e.g., to draw a line) or only click (e.g., to draw a point). The following table lists the
available drawing modes. Codes in the left column are defined in ICONS.DEF.
DrawMode parameter
Description
DM_CUSTOM_POINT
The user cannot drag while using the custom tool.
DM_CUSTOM_LINE
As the user drags, a line connects the cursor with the location
where the user clicked.
Reference Guide
77
Alter ButtonPad statement
DrawMode parameter
Description
DM_CUSTOM_RECT
As the user drags, a rectangular marquee appears.
DM_CUSTOM_CIRCLE
As the user drags, a circular marquee appears.
DM_CUSTOM_ELLIPSE
As the user drags, an elliptical marquee appears; if you include the
ModifierKeys clause, the user can force the marquee to a circular
shape by holding down the Shift key.
DM_CUSTOM_POLYGON
The user may draw a polygon. To retrieve the object drawn by the
user, use the function call:
CommandInfo(CMD_INFO_CUSTOM_OBJ).
DM_CUSTOM_POLYLINE
The user may draw a polyline. To retrieve the object drawn by the
user, use the function call:
CommandInfo(CMD_INFO_CUSTOM_OBJ).
All of the draw modes except for DM_CUSTOM_POINT support the Autoscroll feature, which allows
the user to scroll a Map or Layout by clicking and dragging to the edge of the window. To disable
autoscroll, see Set Window statement on page 639.
Note: MapBasic supports an additional draw mode that is not available to MapInfo Professional
users. If a custom ToolButton has the following Calling clause Calling
M_TOOLS_SEARCH_POLYGON then the tool allows the user to draw a polygon. When the user
double-clicks to close the polygon, MapInfo Professional selects all objects (from selectable
map layers) within the polygon. The polygon is not saved.
Examples
The following example shows the Main ButtonPad and hides the Drawing ButtonPad:
Alter ButtonPad "Main" Show
Alter ButtonPad "Drawing" Hide
The next example docks the Main ButtonPad and sets its docked position to 0,0 (upper left):
Alter ButtonPad "Main" Fixed ToolbarPosition(0,0)
The next example moves the Main ButtonPad so that it is floating instead of docked, and sets its
floating position to half an inch inside the upper-left corner of the screen.
Alter ButtonPad "Main" Float Position(0.5,0.5) Units "in"
The sample program, ScaleBar, contains the following Alter ButtonPad statement, which adds a
custom ToolButton to the Tools ButtonPad. (Note that “ID 3" identifies the Tools ButtonPad.)
78
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Alter ButtonPad ID 3
Add
Separator
ToolButton
Icon MI_ICON_CROSSHAIR
HelpMsg "Draw a distance scale on a map\nScale Bar"
Cursor MI_CURSOR_CROSSHAIR
DrawMode DM_CUSTOM_POINT
Calling custom_tool_routine
Show
Note: The Separator keyword inserts space between the last button on the Tools ButtonPad and
the new MI_CURSOR_CROSSHAIR button.
See Also
Alter Button statement, ButtonPadInfo( ) function, Create ButtonPad statement,Set Window
statement
Alter Cartographic Frame statement
Purpose
The Alter Cartographic Frame statement changes a frame(s) position, title, subtitle, border and
style of an existing cartographic legend created with the Create Cartographic Legend statement.
(To change the size, position or title of the legend window, use the Set Window statement.)
Syntax
Alter Cartographic Frame
[ Window legend_window_id ]
Id { frame_id }
[ Position ( x, y ) [ Units paper_units ] ]
[ Title [ frame_title ] [ Font... ] ]
[ SubTitle [ frame_subtitle ] [ Font... ] ]
[ Border Pen... ]
[ Style [ Font... ]
[ ID { id } Text { style_name } ]
[Line Pen... | Region Pen... Brush... | Symbol Symbol... ] ]
[ , ... ]
legend_window_id is an integer window identifier which you can obtain by calling the
FrontWindow( ) function and WindowID( ) function.
frame_id is the ID of the frame on the legend. You cannot use a layer name. For example, three
frames on a legend would have the successive ID's 1, 2, and 3.
frame_title is a string which defines a frame title.
frame_subtitle is a string which defines a frame subtitle.
id is the position within the style list for that frame. Currently there is no MapBasic function to get
information about the number of styles in a frame.
Reference Guide
79
Alter Control statement
style_name is a string that displays next to each symbol for the frame specified in ID. The “#”
character will be replaced with the layer name. The “%” character will be replaced by the text “Line”,
“Point, “Region”, as appropriate for the symbol. For example, “% of #” will expand to “Region of
States” for the frame corresponding to the states.tab layer.
Description
If a Window clause is not specified MapInfo Professional will use the topmost legend window.
The Position clause controls the frame's position on the legend window. The upper left corner of the
legend window has the position 0, 0. Position values use paper units settings, such as “in” (inches)
or “cm” (centimeters). MapBasic has a current paper units setting, which defaults to inches; a
MapBasic program can change this setting through the Set Paper Units statement. An Alter
Cartographic Frame statement can override the current paper units by including the optional Units
subclause within the Position clause.
The Title and SubTitle clauses accept new text, new font or both.
The Style clause must contain a list of definitions for the styles displayed in frame. You can only
update the Style type for a custom style. You can update the Text of any style. There is no way to
add or remove styles from any type of frame.
See Also
Create Cartographic Legend statement, Set Cartographic Legend statement, Add
Cartographic Frame statement, Remove Cartographic Frame statement
Alter Control statement
Purpose
Changes the status of a control in the active custom dialog box.
Syntax
Alter Control id_num
[ Title { title | From Variable array_name } ]
[ Value value ]
[ { Enable | Disable } ]
[ { Show | Hide } ]
[ Active ]
id_num is an integer identifying one of the controls in the active dialog box.
title is a string representing the new title to assign to the control.
array_name is the name of an array variable; used to reset the contents of ListBox, MultiListBox,
and PopupMenu controls.
value is the new value to associate with the specified control.
Restrictions
You cannot issue this statement through the MapBasic window.
80
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Description
The Alter Control statement modifies one or more attributes of a control in the active dialog box;
accordingly, the Alter Control statement should only be issued while a dialog box is active (i.e., from
within a handler procedure that is called by one of the dialog box controls). If there are two or more
nested dialog boxes on the screen, the Alter Control statement only affects controls within the
topmost dialog box.
The id_num specifies which dialog box control should be modified; this corresponds to the id_num
parameter specified within the ID clause of the Dialog statement.
Each of the optional clauses (Title, Value, Enable/Disable, Hide/Show, Active) modifies a different
attribute of a dialog box control. Note that all of these clauses can be included in a single statement;
thus, a single Alter Control statement could change the name, the value, and the enabled/disabled
status of a dialog box control.
Some attributes do not apply to all types of controls. For example, a Button control may be enabled
or disabled, but has no value attribute.
The Title clause resets the text that appears on most controls (except for Picker controls and
EditText controls; to reset the contents of an EditText control, set its Value). If the control is a ListBox,
MultiListBox, or PopupMenu control, the Title clause can read the control's new contents from an
array of string variables, by specifying a From Variable clause.
The Active keyword applies only to EditText controls. An Alter Control…Active statement puts the
keyboard focus on the specified EditText control.
Use the Hide and Show keywords to make controls disappear or reappear.
To de-select all items in a MultiListBox control, use a value setting of zero. To add a list item to the
set of selected MultiListBox items, issue an Alter Control statement with a positive integer value
corresponding to the number of the list item.
Note: In this case, do not issue the Alter Control statement from within the MultiListBox control's
handler.
You can use an Alter Control statement to modify the text that appears in a StaticText control.
However, MapInfo Professional cannot increase the size of the StaticText control after it is created.
Therefore, if you plan to alter the length of a StaticText control, you may want to pad it with spaces
when you first define it. For example, your Dialog statement could include the following clause:
Control StaticText ID 1 Title "Message goes here" + Space$(30)
Reference Guide
81
Alter Control statement
Example
The following example creates a dialog box containing two checkboxes, an OK button, and a Cancel
button. Initially, the OK button is disabled (grayed out). The OK button is only enabled if the user
selects one or both of the check boxes.
Include "mapbasic.def"
Declare Sub Main
Declare Sub checker
Sub Main
Dim browse_it, map_it As Logical
Dialog
Title "Display a file"
Control CheckBox
Title "Display in a Browse window"
Value 0
Calling checker
ID 1
Into browse_it
Control CheckBox
Title "Display in a Map window"
Value 0
Calling checker
ID 2
Into map_it
Control CancelButton
Control OKButton
ID 3
Disable
If CommandInfo(CMD_INFO_DLG_OK) Then
' ... then the user clicked OK...
End If
End Sub
Sub checker
' If either check box is checked,
' enable the OK button; otherwise, Disable it.
If ReadControlValue(1) Or ReadControlValue(2) Then
Alter Control 3 Enable
Else
Alter Control 3 Disable
End If
End Sub
See Also
Dialog statement, Dialog Preserve statement, ReadControlValue( ) function
82
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Alter MapInfoDialog statement
Purpose
Disables, hides, or assigns new values to controls in MapInfo Professional's standard dialog boxes.
Restrictions
CAUTION:
The Alter MapInfoDialog statement may not be supported in future versions of
MapInfo Professional. As a result, MapBasic programs that use this statement
may not work correctly when run using future versions of MapInfo Professional.
Use this statement with caution.
Syntax 1 (assigning non-default settings)
Alter MapInfoDialog dialog_ID
Control control_ID
{ Disable | Hide | Value new_value } [ , { Disable... } ]
[ Control... ]
Syntax 2 (restoring default settings)
Alter MapInfoDialog dialog_ID Default
dialog_ID is an integer ID number, indicating which MapInfo Professional dialog box to alter.
control_ID is an integer ID number, 1 or larger, indicating which control to modify.
new_value is a new value assigned to the dialog box control.
Description
Use this statement if you need to disable, hide, or assign new values to controls—buttons, check
boxes, etc.—in MapInfo Professional's standard dialog boxes.
Note: Use this statement to modify only MapInfo Professional's standard dialog boxes. To modify
custom dialog boxes that you create using the Dialog statement, use the Alter Control
statement.
Determining ID Numbers
To determine a dialog box's ID number, run MapInfo Professional with this command line:
mapinfow.exe -helpdiag
After you run MapInfo Professional with the -helpdiag argument, display a MapInfo Professional
dialog box and click the Help button. Ordinarily, the Help button launches Help, but because you
used the -helpdiag argument, MapInfo Professional displays the ID number of the current dialog
box.
Note: There are different “common dialog boxes” (such as the Open and Save dialog boxes) for
different versions of Windows. If you want to modify a common dialog box, and if your
application will be used under different versions of Windows, you may need to issue two
Alter MapInfoDialog statements, ne for each version of the common dialog box.
Reference Guide
83
Alter MapInfoDialog statement
Each individual control has an ID number. For example, most OK buttons have an ID number of 1,
and most Cancel buttons have an ID number of 2. To determine the ID number for a specific control,
you must use a third-party developer's utility, such as the Spy++ utility that Microsoft provides with its
C compiler. The MapBasic software does not provide a Spy++ utility.
Although the Alter MapInfoDialog statement changes the initial appearance of a dialog box, the
changes do not have any effect unless the user clicks OK. For example, you can use Alter
MapInfoDialog to store an address in the Find dialog box; however, MapInfo Professional will not
perform the Find operation unless you display the dialog box and the user clicks OK.
Types of Changes Allowed
Use the Disable keyword to disable (gray out) the control.
Use the Hide keyword to make the control disappear.
Use the Value clause to change the setting of the control.
When you alter common dialog boxes (e.g., the Open dialog box), you may reset the item selected
in a combo box control, or you may assign new text to static text, button, and edit box controls.
You can change the orientation control in the Page Setup dialog box. The Portrait and Landscape
buttons are 1056 and 1057, respectively.
When you alter other MapInfo Professional dialog boxes, the following list summarizes the types of
changes you may make.
•
•
•
•
•
•
•
•
•
Button, static text, edit box, editable combo box: You may assign new text by using a text
string in the new_value parameter.
List box, combo box: You may set which item is selected by using a numeric new_value.
Checkbox: You may set the checkbox (specify a value of 1) or clear it (value of zero).
Radio button: Setting a button's value to 1 selects that button from the radio group.
Symbol style button: You may assign a new symbol style (e.g., use the return value from the
MakeSymbol( ) function).
Pen style button: You may assign a new Pen value.
Brush style button: You may assign a new Brush value.
Font style button: You may assign a new Font value.
Combined Pen/Brush style button: Specify a Pen value to reset the Pen style, or specify a
Brush value to reset the Brush style. (For an example of this type of control, see MapInfo
Professional's Region Style dialog box, which appears when you double-click an editable
region.)
Example
The following example alters MapInfo Professional's Find dialog box by storing a text string (“23
Main St.”) in the first edit box and hiding the Respecify button.
If SystemInfo(SYS_INFO_MIVERSION) = 400 Then
Alter MapInfoDialog 2202
Control 5 Value "23 Main St."
Control 12 Hide
End If
Run Menu Command M_ANALYZE_FIND
84
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
The ID number 2202 refers to the Find dialog box. Control 5 is the edit box where the user types an
address. Control 12 is the Respecify button, which this example hides. All ID numbers are subject to
change in future versions of MapInfo Professional; therefore, this example calls the SystemInfo( )
function to determine the MapInfo Professional version number.
See Also
Alter Control statement, Dialog statement, SystemInfo( ) function
Alter Menu statement
Purpose
Adds or removes items from an existing menu.
Syntax 1
Alter Menu { menuname | ID menu_id }
Add menudef [ , menudef... ]
Where each menudef defines a menu item, according to the syntax:
newmenuitem
[ ID menu_item_id ]
[ HelpMsg help ]
[ { Calling handler | As menuname } ]
menuname is the name of an existing menu (e.g., “File”).
menu_id is a standard integer menu ID from 1 to 22; 1 represents the File menu.
newmenuitem is a string, the name of an item to add to the specified menu.
menu_item_id is a custom integer menu item identifier, which can be used in subsequent Alter
Menu Item statements.
help is a string that will appear on the status bar while the menu item is highlighted.
handler is the name of a procedure, or a code for a standard menu command (e.g., M_FILE_NEW),
or a special syntax for handling the menu event by calling OLE or DDE. If you specify a command
code for a standard MapInfo Professional Show/Hide command (such as
M_WINDOW_STATISTICS), the newmenuitem string must start with an exclamation point and
include a caret (^), to preserve the item's Show/Hide behavior. For more details on the different
types of handler syntax, see the Create Menu statement.
Syntax 2
Alter Menu { menuname | ID menu_id }
Remove { handler | submenuname | ID menu_item_id }
[ , { handler | submenuname | ID menu_item_id } ... ]
menuname is the name of an existing menu.
menu_id is an integer menu ID from 1 to 22; 1 represents the File menu.
Reference Guide
85
Alter Menu statement
handler is either the name of a sub procedure or the code for a standard MapInfo Professional
command.
submenuname is the name of a hierarchical submenu to remove from the specified menu.
menu_item_id is a custom integer menu item identifier.
Description
The Alter Menu statement adds menu items to an existing menu or removes menu items from an
existing menu.
The statement can identify the menu to be modified by specifying the name of the menu (e.g., “File”)
through the menuname parameter. Note that if the application is running on a non-English language
version of MapInfo, and the menu names have been translated, the Alter Menu statement must
specify the translated version of the menu name.
If the menu to be modified is one of the standard MapInfo Professional menus, the Alter Menu
statement can identify which menu to alter by using the ID clause. The ID clause identifies the menu
by a number from 1 to 31.
The following table lists the names and ID numbers of all standard MapInfo Professional menus.
Note: Menus 16 through 31 are shortcut menus, which appear if the user clicks with the right
mouse button.
ID Numbers for Menus
Menu Name
86
ID
Description
File
1
File menu.
Edit
2
Edit menu.
Query
3
Query menu.
Tools
4
Tools menu.
Options
5
Options menu.
Window
6
Window menu.
Help
7
Help menu.
Browse
8
Browse menu. Ordinarily, this only appears when a Browser
window is the active window.
Map
9
Map menu. Ordinarily, this menu is only available when a Map
window is active.
Layout
10
Layout menu. Available when a Layout window is active.
Graph
11
Graph menu. Available when a Graph window is active.
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
ID Numbers for Menus (continued)
Menu Name
ID
Description
MapBasic
12
MapBasic menu. Available when the MapBasic window is
active.
Redistrict
13
Redistrict menu. Available when a Districts Browser is active.
Objects
14
Objects menu.
Table
15
Table menu.
DefaultShortcut
16
The default shortcut menu. This menu appears if the user rightclicks on a window that does not have its own shortcut menu
defined.
MapperShortcut
17
The Map window shortcut menu.
BrowserShortcut
18
The Browse window shortcut menu.
LayoutShortcut
19
The Layout window shortcut menu.
GrapherShortcut (1)
20
The Graph window shortcut menu. This menu contains options
for creating graphs.
CmdShortcut
21
The MapBasic window shortcut menu.
RedistrictShortcut
22
The Redistricting shortcut menu; available when the Districts
Browser is active.
LegendShortcut
23
The Legend window shortcut menu.
GrapherShortcut (2)
24
The graph window shortcut menu. This menu contains options
for formatting graphs already created.
3DMapShortcut
25
The 3D Map window shortcut menu.
3DWindow
28
3D Window menu.
Graph
29
Graph menu.
Legend
31
Legend menu.
Examples
The following statement adds an item to the File menu.
Alter Menu "File" Add
"Special" Calling sub_procedure_name
In the following example, the menu to be modified is identified by its number.
Alter Menu ID 1 Add
"Special" Calling sub_procedure_name
Reference Guide
87
Alter Menu Bar statement
In the following example, the menu item that is added contains an ID clause. The ID number (300)
can be used in subsequent Alter Menu Item statements.
Alter Menu ID 1 Add
"Special" ID 300 Calling sub_procedure_name
The following example removes the custom item from the File menu.
Alter Menu ID 1 Remove sub_procedure_name
The sample program, TextBox, uses a Create Menu statement to create a menu called “TextBox,”
and then issues the following Alter Menu statement to add the TextBox menu as a hierarchical
menu located on the Tools menu:
Alter Menu "Tools" Add
"(-",
"TextBox" As "TextBox"
The following example adds a custom command to the Map window's shortcut menu (the menu that
appears when an MapInfo Professional user right-clicks on a Map window).
Alter Menu ID 17 Add
"Find Nearest Site" Calling sub_procedure_name
See Also
Alter Menu Bar statement, Alter Menu Item statement, Create Menu statement, Create Menu
Bar statement
Alter Menu Bar statement
Purpose
Adds or removes menus from the menu bar.
Syntax
Alter Menu Bar { Add | Remove }
{ menuname | ID menu_id }
[ , { menuname | ID menu_id } ... ]
menuname is the name of an available menu (e.g., “File”)
menu_id is a standard menu ID from one to fifteen; one represents the File menu.
Description
The Alter Menu Bar statement adds or removes one or more menus from the current menu bar.
The menuname parameter is a string representing the name of a menu, such as “File” or “Edit”. The
menuname parameter may also refer to the name of a custom menu created by a Create Menu
statement (see example below)
Note: If the application is running on a non-English language version of MapInfo, and if the menu
names have been translated, the Alter Menu Bar statement must specify the translated
version of the menu name. However, each of MapInfo Professional's standard menus (File,
88
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Edit, etc.) also has a menu ID, which you can use regardless of whether the menu names
have been translated. For example, specifying ID 2 always refers to the Edit menu,
regardless of whether the menu has been translated.
For a list of MapInfo Professional's standard menu names and their corresponding ID numbers, see
Alter Menu statement on page 85.
Adding Menus to the Menu Bar
An Alter Menu Bar Add statement adds a menu to the right end of the menu bar. If you need to
insert a menu at another position on the menu bar, use the Create Menu Bar statement to redefine
the entire menu bar.
If you add enough menus to the menu bar, the menu bar wraps down onto a second line of menu
names.
Removing Menus from the Menu Bar
An Alter Menu Bar Remove… statement removes a menu from the menu bar. However, the menu
remains part of the “pool” of available menus. Thus, the following pair of statements would first
remove the Query menu from the menu bar, and then add the Query menu back onto the menu bar
(at the right end of the bar).
Alter Menu Bar Remove "Query"
Alter Menu Bar Add "Query"
After an Alter Menu Bar Remove… statement removes a menu, MapInfo Professional ignores any
hotkey sequences corresponding to items that were on the removed menu. For example, a MapInfo
Professional user might ordinarily press Ctrl-O to bring up the File menu's Open dialog box;
however, if an Alter Menu Bar Remove statement removed the File menu, MapInfo Professional
would ignore any Ctrl-O key-presses.
Example
The following example creates a custom menu, called DataEntry, then uses an Alter Menu Bar Add
statement to add the DataEntry menu to MapInfo Professional's menu bar.
Declare Sub addsub
Declare Sub editsub
Declare Sub delsub
Create Menu "DataEntry" As
"Add" Calling addsub,
"Edit" Calling editsub,
"Delete" Calling delsub
'Remove the Window menu and Help menu
Alter Menu Bar Remove ID 6, ID 7
'Add the custom menu, then the Window & Help menus
Alter Menu Bar Add "DataEntry", ID 6, ID 7
Before adding the custom menu to the menu bar, this program removes the Help menu (menu ID 7)
and the Window menu (ID 6) from the menu bar. The program then adds the custom menu, the
Window menu, and the Help menu to the menu bar. This technique guarantees that the last two
menus will always be Window and Help.
Reference Guide
89
Alter Menu Item statement
See Also
Alter Menu statement, Alter Menu Item statement, Create Menu statement, Create Menu Bar
statement, Menu Bar statement
Alter Menu Item statement
Purpose
Alters the status of a specific menu item.
Syntax
Alter Menu Item { handler | ID menu_item_id }
{ [ Check | Uncheck ] |
[ Enable | Disable ] |
[ Text itemname ] |
[ Calling handler | As menuname ] }
handler is either the name of a Sub procedure or the code for a standard MapInfo Professional
command.
menu_item_id is an integer that identifies a menu item; this corresponds to the menu_item_id
parameter specified in the statement that created the menu item (Create Menu statement or Alter
Menu statement).
itemname is the new text for the menu item (may contain embedded codes).
menuname is the name of an existing menu.
Description
The Alter Menu Item statement alters one or more of the items that make up the available menus.
For example, you could use the Alter Menu Item statement to check or disable (gray out) a menu
item.
The statement must either specify a handler (e.g., the name of a procedure in the same program), or
an ID clause to indicate which menu item(s) to modify. Note that it is possible for multiple, separate
menu items to call the same handler procedure. If the Alter Menu Item statement includes the name
of a handler procedure, MapInfo Professional alters all menu items that call that handler. If the
statement includes an ID clause, MapInfo Professional alters only the menu item that was defined
with that ID.
The Alter Menu Item statement can only refer to a menu item ID if the statement which defined the
menu item included an ID clause. A MapBasic application cannot refer to menu item IDs created by
other MapBasic applications.
The Check clause and the Uncheck clause affect whether the item appears with a checkmark on
the menu. Note that a menu item may only be checked if it was defined as “checkable” (i.e. if the
Create Map statement included a “!” as the first character of the menu item name).
The Disable clause and the Enable clause control whether the item is disabled (grayed out) or
enabled. Note that MapInfo Professional automatically enables and disables various menu items
based on the current circumstances. For example, the File > Close command is disabled whenever
90
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
there are no tables open. Therefore, MapBasic applications should not attempt to enable or disable
standard MapInfo Professional menu items. Similarly, although you can treat specific tools as menu
items (by referencing defines from MENU.DEF, such as M_TOOLS_RULER), you should not
attempt to enable or disable tools through the Alter Menu Item statement.
The Text clause allows you to rename a menu item.
The Calling clause specifies a handler for the menu item. If the user chooses the menu item,
MapInfo Professional calls the item's handler.
Examples
The following example creates a custom “DataEntry” menu.
Declare Sub addsub
Declare Sub editsub
Declare Sub delsub
Create Menu "DataEntry" As
"Add" Calling addsub,
"Edit" Calling editsub,
"Delete" ID 100 Calling delsub,
"Delete All" ID 101 Calling delsub
'Remove the Help menu
Alter Menu Bar Remove ID 7
'Add both the new menu and the Help menu
Alter Menu Bar Add "DataEntry" , ID 7
The following Alter Menu Item statement renames the “Edit” item to read “Edit…”
Alter Menu Item editsub Text "Edit…"
The following statement disables the “Delete All” menu item.
Alter Menu Item ID 101 Disable
The following statement disables both the “Delete” and the “Delete All” items, because it identifies
the handler procedure delsub, which is the handler for both menu items.
Alter Menu Item delsub Disable
See Also
Alter Menu statement, Alter Menu Bar statement, Create Menu statement
Reference Guide
91
Alter Object statement
Alter Object statement
Purpose
Modifies the shape, position, or graphical style of an object.
Syntax
Alter Object obj
{ Info object_info_code, new_info_value |
Geography object_geo_code , new_geo_value |
Node { Add [ Position polygon_num, node_num ] ( x, y ) |
Set Position polygon_num, node_num ( x , y ) |
Remove Position polygon_num, node_num
}
}
obj is an object variable.
object_info_code is an integer code relating to the ObjectInfo( ) function (e.g., OBJ_INFO_PEN).
new_info_value specifies the new object_info_code attribute to apply (e.g., a new Pen style).
object_geo_code is an integer code relating to the ObjectGeography( ) function (e.g.,
OBJ_GEO_POINTX).
new_geo_value specifies the new object_geo_code value to apply (e.g., the new x-coordinate).
polygon_num is a integer value (one or larger), identifying one polygon from a region object or one
section from a polyline object.
node_num is a integer value (one or larger), identifying one node from a polyline or polygon.
x, y are x- and y-coordinates of a node.
Description
The Alter Object statement alters the shape, position, or graphical style of an object.
The effect of an Alter Object statement depends on whether the statement includes an Info clause,
a Node clause, or a Geography clause. If the statement includes an Info clause, MapBasic alters
the object's graphical style (e.g., the object's Pen and Brush styles). If the statement includes a
Node clause, MapBasic adds, removes, or repositions a node (this applies only to polyline or region
objects). If the statement includes a Geography clause, MapBasic alters a geographical attribute for
objects other than polylines and regions (e.g., the x- or y-coordinate of a point object).
92
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Info clause
By issuing an Alter Object statement with an Info clause, you can reset an object's style (e.g., the
Pen or Brush). The Info clause lets you modify the same style attributes that you can query through
the ObjectInfo( ) function. For example, you can determine an object's current Brush style by
calling the ObjectInfo( ) function:
Dim b_fillstyle As Brush
b_fillstyle = ObjectInfo(Selection.obj, OBJ_INFO_BRUSH)
Conversely, the following Alter Object statement allows you to reset the Brush style:
Alter Object obj_variable_name
Info OBJ_INFO_BRUSH, b_fillstyle
Note that you use the same code (e.g., OBJ_INFO_BRUSH) in both the ObjectInfo( ) function and
the Alter Object statement.
The table below summarizes the values you can specify in the Info clause to perform various types
of style alterations. Note that the obj_info_code values are defined in the standard MapBasic
definitions file, MAPBASIC.DEF. Accordingly, your program should Include “MAPBASIC.DEF” if you
intend to use the Alter Object…Info statement.
obj_info_code Value
Result of Alter Object
OBJ_INFO_PEN
Resets object's Pen style; new_info_value must be a Pen
expression.
OBJ_INFO_BRUSH
Resets object's Brush style; new_info_value must be a Brush
expression.
OBJ_INFO_TEXTFONT
Resets a Text object's Font style; new_info_value must be a Font
expression.
OBJ_INFO_SYMBOL
Resets a Point object's Symbol style; new_info_value must be a
Symbol expression.
OBJ_INFO_SMOOTH
Resets a Polyline object's smoothed/unsmoothed setting;
new_info_value must be a logical expression.
OBJ_INFO_FRAMEWIN
Changes which window is displayed in a Layout frame;
new_info_value must be an integer window ID.
OBJ_INFO_FRAMETITLE
Changes the title of a Frame object; new_info_value must be a
string.
OBJ_INFO_TEXTSTRING
Changes the text string that comprises a Text object;
new_info_value must be a string expression.
OBJ_INFO_TEXTSPACING
Changes a Text object's line spacing; new_info_value must be a
float value of 1, 1.5, or 2.
Reference Guide
93
Alter Object statement
obj_info_code Value
Result of Alter Object
OBJ_INFO_TEXTJUSTIFY
Changes a Text object's alignment; new_info_value must be 0 for
left-justified, 1 for center-justified, or 2 for right-justified.
OBJ_INFO_TEXTARROW
Changes a Text object's label line setting; new_info_value must
be 0 for no line, 1 for simple line, or 2 for a line with an arrow.
Geography clause
By issuing an Alter Object statement with a Geography clause, you can alter an object's
geographical coordinates. The Geography clause applies to all object types except for polylines and
regions. To alter the coordinates of a polyline or region object, use the Node clause (described
below) instead of the Geography clause.
The Geography clause lets you modify the same attributes that you can query through the
ObjectGeography( ) function. For example, you can obtain a line object's end coordinates by
calling the ObjectGeography( ) function:
Dim
Dim
x =
y =
o_cable As Object
x, y As Float
ObjectGeography(o_cable, OBJ_GEO_LINEENDX)
ObjectGeography(o_cable, OBJ_GEO_LINEENDY)
Conversely, the following Alter Object statements let you alter the line object's end coordinates:
Alter Object
Geography
Alter Object
Geography
o_cable
OBJ_GEO_LINEENDX, x
o_cable
OBJ_GEO_LINEENDY, y
Note: You use the same codes (e.g., OBJ_GEO_LINEENDX) in both the ObjectGeography( )
function and the Alter Object statement.
The table below summarizes the values you can specify in the Geography clause in order to perform
various types of geographic alterations. Note that the obj_geo_code values are defined in the
standard MapBasic definitions file, MAPBASIC.DEF. Your program should Include
“MAPBASIC.DEF” if you intend to use the Alter Object…Geography statement.
obj_geo_code Value
94
Result of Alter Object
OBJ_GEO_MINX
Alters object's minimum bounding rectangle.
OBJ_GEO_MINY
Alters object's MBR.
OBJ_GEO_MAXX
Alters object's MBR; does not apply to Point objects.
OBJ_GEO_MAXY
Alters object's MBR; does not apply to Point objects.
OBJ_GEO_ARCBEGANGLE
Alters beginning angle of an Arc object.
OBJ_GEO_ARCENDANGLE
Alters ending angle of an Arc object.
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
obj_geo_code Value
Result of Alter Object
OBJ_GEO_LINEBEGX
Alters a Line object's starting node.
OBJ_GEO_LINEBEGY
Alters a Line object's starting node.
OBJ_GEO_LINEENDX
Alters a Line object's ending node.
OBJ_GEO_LINEENDY
Alters a Line object's ending node.
OBJ_GEO_POINTX
Alters a Point object's x coordinate.
OBJ_GEO_POINTY
Alters a Point object's y coordinate.
OBJ_GEO_ROUNDRADIUS
Alters the diameter of the circle that defines the rounded corner of
a Rounded Rectangle object.
OBJ_GEO_TEXTLINEX
Alters x coordinate of the end of a Text object's label line.
OBJ_GEO_TEXTLINEY
Alters y coordinate of the end of a Text object's label line.
OBJ_GEO_TEXTANGLE
Alters rotation angle of a Text object.
Node clause
By issuing an Alter Object statement with a Node clause, you can add, remove, or reposition nodes
in a polyline or region object.
If the Node clause includes an Add sub-clause, the Alter Object statement adds a node to the
object. If the Node clause includes a Remove sub-clause, the statement removes a node. If the
Node clause includes a Set Position sub-clause, the statement repositions a node.
The Alter Object statement's Node clause is often used in conjunction with the Create Pline
statement and the Create Region statement. Create statements allow you to create new polyline
and region objects. However, Create statements are somewhat restrictive, because they force you
to state at compile time the number of nodes that will comprise the object. In some situations, you
may not know how many nodes should go into an object until run-time.
If your program will not know until run-time how many nodes should comprise an object, you can
issue a Create Pline statement or a Create Region statement which creates an “empty” object (an
object with zero nodes). Your program can then issue an appropriate number of Alter
Object…Node Add statements, to add nodes as needed.
Within the Node clause, the Position sub-clause includes two parameters, polygon_num and
node_num, that let you specify exactly which node you want to reposition or remove. The Position
sub-clause is optional when you are adding a node. The polygon_num and node_num parameters
should always be 1 (one) or greater.
The polygon_num parameter specifies which polygon in a multiple-polygon region (or which section
in a multiple-section polyline) should be modified.
Reference Guide
95
Alter Object statement
Region Centroids
The Centroid of a Region can be set by using the Alter Object command with the syntax noted
below:
Alter Object Obj Geography OBJ_GEO_CENTROID, PointObj
Note that PointObj is a point object. This differs from other values input by Alter Object Geography,
which are all scalars. A point is needed in this instance because we need two values which define a
point. The Point that is input is checked to make sure it is a valid Centroid (i.e., it is inside the
region). If the Obj is not a region, or if PointObj is not a point object, or if the point is not a valid
centroid, then an error is returned.
An easy way to center an X and Y value for a centroid is as follows:
Alter Object Obj Geography OBJ_GEO_CENTROID, CreatePoint(X, Y)
The user can also query the centroid by using the ObjectGeography( ) function as follows:
PointObj = ObjectGeography(Obj, OBJ_GEO_CENTROID)
There are other ways to get the Centroid, including the Centroid( ) function, CentroidX( )
function, and CentroidY( ) function.
OBJ_GEO_CENTROID is defined in MAPBASIC.DEF.
Multipoint Objects and Collections
The Alter Object statement has been extended to support the following new object types.
• Multipoint: sets a Multipoint symbol as shown in the following:
Alter Object obj_variable_mpoint
Info OBJ_INFO_SYMBOL, NewSymbol
• Collection: By issuing an Alter Object statement with an Info clause, you can reset collection
parts (Region, Polyline or Multipoint) inside the collection object. The Info clause allows you to
modify the same attributes that you can query through the ObjectInfo( ) function. For example,
you can determine a collection object's region part by calling the ObjectInfo( ) function:
Dim ObjRegion As Object
ObjRegion = ObjectInfo(Selection.obj, OBJ_INFO_REGION)
Also, the following Alter Object statement allows you to reset the region part of a collection
object:
Alter Object obj_variable_name
Info OBJ_INFO_REGION, ObjRegion
Note: You use the same code (e.g., OBJ_INFO_REGION) in both the ObjectInfo( ) function and
the Alter Object statement.
Support has also been added to the Alter Object statement that allows you to insert and delete
nodes to/from Multipoint objects.
Alter Object obj Node statement
To insert nodes within a Multipoint object:
Dim mpoint_obj as object
Create Multipoint Into Variable mpoint_obj 0
96
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Alter Object mpoint_obj Node Add (0,1)
Alter Object mpoint_obj Node Add (2,1)
Note: Nodes for Multipoint are always added at the end.
To delete nodes from a Multipoint object:
Alter Object mpoint_obj Node Remove Position polygon_num, node_num
mpoint_obj is a Multipoint object variable.
polygon_num is ignored for Multipoint, it is advisable to set it to 1.
node_num is the number of a node to be removed.
To set nodes inside a Multipoint object:
Alter Object mpoint_obj Node Set Position polygon_num, node_num (x,y)
mpoint_obj is a Multipoint object variable.
polygon_num is ignored for Multipoint, it is advisable to set it to 1.
node_num is the number of a node to be changed.
x and y are the new coordinates of the node node_num.
Example
Dim myobj As Object, i As Integer
Create Region Into Variable myobj 0
For i = 1 to 10
Alter Object myobj
Node Add (Rnd(1) * 100, Rnd(1) * 100)
Next
Note: After using the Alter Object statement to modify an object, use an Insert statement or an
Update statement to store the object in a table.
See Also
Create Pline statement, Create Region statement, Insert statement, ObjectGeography( )
function, ObjectInfo( ) function, Update statement
Reference Guide
97
Alter Table statement
Alter Table statement
Purpose
Alters the structure of a table. Cannot be used on linked tables.
Syntax
Alter Table table (
[ Add columnname columntype [, ...] ]
[ Modify columnname columntype [, ...] ]
[ Drop columnname [, ...] ]
[ Rename oldcolumnname newcolumnname [, ...] ]
[ Order columnname, columnname [,...] ] )
[ Interactive ]
table is the name of an open table.
columnname is the name of a column; column names can be up to 31 characters long, and can
contain letters, numbers, and the underscore character, and column names cannot begin with
numbers.
columntype indicates the datatype of a table column (including the field width if necessary).
oldcolumnname represents the previous name of a column to be renamed.
newcolumnname represents the intended new name of a column to be renamed.
Description
The Alter Table statement lets you modify the structure of an open table, allowing you to add
columns, change column widths or datatypes, drop (delete) columns, rename columns, and change
column ordering.
Note: If you have edited a table, you must save or discard your edits before you can use the Alter
Table statement.
Each columntype should be one of the following: integer, SmallInt, float, decimal( size, decplaces ),
char(size), date, or logical.
By including an Add clause in an Alter Table statement, you can add new columns to your table. By
including a Modify clause, you can change the datatypes of existing columns. A Drop clause lets
you delete columns, while a Rename clause lets you change the names of existing columns. The
Order clause lets you specify the order of the columns. Altogether, an Alter Table statement can
have up to five clauses. Note that each of these five clauses can operate on a list of columns; thus,
with a single Alter Table statement, you can make all of the structural changes that you need to
make (see example below).
The Order clause affects the order of the columns, not the order of rows in the table. Column order
dictates the relative positions of the columns when you browse the table; the first column appears at
the left edge of a Browser window, and the last column appears at the right edge. Similarly, a table's
first column appears at the top of an Info tool window.
98
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
If a MapBasic application issues an Alter Table statement affecting a table which has memo fields,
the memo fields will be lost. No warning will be displayed.
An Alter Table statement may cause map layers to be removed from a Map window, possibly
causing the loss of themes or cosmetic objects. If you include the Interactive keyword, MapInfo
Professional prompts the user to save themes and/or cosmetic objects (if themes or cosmetic
objects are about to be lost).
Example
In the following example, we have a hypothetical table, “gcpop.tab” which contains the following
columns: pop_88, metsize, fipscode, and utmcode. The Alter Table statement below makes several
changes to the gcpop table. First, a Rename clause changes the name of the pop_88 column to
population. Then the Drop clause deletes the metsize, fipscode, and utmcode columns. An Add
clause creates two new columns: a small (2-byte) integer column called schoolcode, and a floating
point column called federalaid. Finally, an Order clause specifies the order for the new set of
columns: the schoolcode column comes first, followed by the population column, etc.
Open Table "gcpop"
Alter Table gcpop
(Rename pop_88 population
Drop metsize, fipscode, utmcode
Add schoolcode SmallInt, federalaid Float
Order schoolcode, population, federalaid)
See Also
Add Column statement, Create Index statement, Create Map statement, Create Table
statement
ApplicationDirectory$( ) function
Purpose
Returns a string containing the path from which the current MapBasic application is executing.
Syntax
ApplicationDirectory$( )
Return Value
String expression, representing a directory path.
Description
By calling the ApplicationDirectory$( ) function from within a compiled MapBasic application, you
can determine the directory or folder from which the application is running. If no application is
running (e.g., if you call the function by typing into the MapBasic window), ApplicationDirectory$( )
returns a null string.
Reference Guide
99
Area( ) function
To determine the directory or folder where the MapInfo Professional software is installed, call the
ProgramDirectory$( ) function.
Example
Dim sAppPath As String
sAppPath = ApplicationDirectory$( )
' At this point, sAppPath might look like this:
'
' "C:\MAPBASIC\CODE\"
See Also
ProgramDirectory$( ) function
Area( ) function
Purpose
Returns the geographical area of an Object.
Syntax
Area( obj_expr, unit_name )
obj_expr is an object expression.
unit_name is a string representing the name of an area unit (e.g., “sq km”).
Return Value
Float
Description
The Area( ) function returns the area of the geographical object specified by obj_expr.
The function returns the area measurement in the units specified by the unit_name parameter; for
example, to obtain an area in acres, specify “acre” as the unit_name parameter. See Set Area Units
statement on page 579 for the list of available unit names.
Only regions, ellipses, rectangles, and rounded rectangles have any area. By definition, the area of
a point, arc, text, line, or polyline object is zero. The Area( ) function returns approximate results
when used on rounded rectangles. MapBasic calculates the area of a rounded rectangle as if the
object were a conventional rectangle.
For the most part, MapInfo Professional performs a Cartesian or Spherical operation. Generally, a
spherical operation is performed unless the coordinate system is NonEarth, in which case, a
Cartesian operation is performed.
100
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Examples
The following example shows how the Area( ) function can calculate the area of a single geographic
object. Note that the expression tablename.obj (as in states.obj) represents the geographical
object of the current row in the specified table.
Dim f_sq_miles As Float
Open Table "states"
Fetch First From states
f_sq_miles = Area(states.obj, "sq mi")
You can also use the Area( ) function within the SQL Select statement, as shown in the following
example.
Select state, Area(obj, "sq km")
From states Into results
See Also
ObjectLen( ) function, Perimeter( ) function, CartesianArea( ) function, SphericalArea( )
function, Set Area Units statement
AreaOverlap( ) function
Purpose
Returns the area resulting from the overlap of two closed objects.
Syntax
AreaOverlap( object1, object2 )
object1 and object2 are closed objects.
Return Value
A float value representing the area (in MapBasic's current area units) of the overlap of the two
objects.
See Also
Overlap( ) function, ProportionOverlap( ) function, Set Area Units statement
Reference Guide
101
Asc( ) function
Asc( ) function
Purpose
Returns the character code for the first character in a string expression.
Syntax
Asc( string_expr )
string_expr is a string expression.
Return Value
Integer
Description
The Asc( ) function returns the character code representing the first character in the string specified
by string_expr.
If string_expr is a null string, the Asc( ) function returns a value of zero.
Note: All MapInfo Professional environments have common character codes within the range of 32
(space) to 126 (tilde).
On a system that supports double-byte character sets (e.g., Windows Japanese): if the first
character of string_expr is a single-byte character, Asc( ) returns a number in the range 0 - 255; if
the first character of string_expr is a double-byte character, Asc( ) returns a value in the range 256 65,535.
On systems that do not support double-byte character sets, Asc( ) returns a number in the range 0 255.
Example
Dim code As SmallInt
code = Asc("Afghanistan")
' code will now be equal to 65,
' since 65 is the code for the letter A
See Also
Chr$( ) function
102
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Asin( ) function
Purpose
Returns the arc-sine value of a number.
Syntax
Asin( num_expr )
num_expr is a numeric expression from one to negative one, inclusive.
Return Value
Float
Description
The Asin( ) function returns the arc-sine of the numeric num_expr value. In other words, Asin( )
returns the angle whose sine is equal to num_expr.
The result returned from Asin( ) represents an angle, expressed in radians. This angle will be
somewhere between -Pi/2 and Pi/2 radians (given that Pi is approximately equal to 3.141593, and
given that Pi/2 radians represents 90 degrees).
To convert a degree value to radians, multiply that value by DEG_2_RAD. To convert a radian value
into degrees, multiply that value by RAD_2_DEG. (Note that your program will need to Include
“MAPBASIC.DEF” in order to reference DEG_2_RAD or RAD_2_DEG).
Since sine values range between one and negative one, the expression num_expr should represent
a value no larger than one (1) and no smaller than negative one (-1).
Example
Include "MAPBASIC.DEF"
Dim x, y As Float
x = 0.5
y = Asin(x) * RAD_2_DEG
' y will now be equal to 30,
' since the sine of 30 degrees is 0.5
See Also
Acos( ) function, Atn( ) function, Cos( ) function, Sin( ) function, Tan( ) function
Reference Guide
103
Ask( ) function
Ask( ) function
Purpose
Displays a dialog box, asking the user a yes or no (OK or Cancel) question.
Syntax
Ask( prompt, ok_text, cancel_text )
prompt is a string to appear as a prompt in the dialog box.
ok_text is a string (e.g., “OK”) that appears on the confirmation button.
cancel_text is a string (e.g., “Cancel”) that appears on the cancel button.
Return Value
Logical
Description
The Ask( ) function displays a dialog box, asking the user a yes-or-no question. The prompt
parameter specifies a message, such as “File already exists; do you want to continue?” The prompt
string can be up to 300 characters long.
The dialog box contains two buttons; the user can click one button to give a Yes answer to the
prompt, or click the other button to give a No answer. The ok_text parameter specifies the name of
the Yes-answer button (e.g., “OK” or “Continue”), and the cancel_text parameter specifies the name
of the No-answer button (e.g., “Cancel” or “Stop”).
If the user selects the ok_text button, the Ask( ) function returns TRUE. If the user clicks the
cancel_text button or otherwise cancels the dialog box (e.g., by pressing the Esc key), the Ask( )
function returns FALSE. Since the buttons are limited in size, the ok_text and cancel_text strings
should be brief. If you need to display phrases that are too long to fit in small dialog box buttons, you
can use the Dialog statement instead of calling the Ask( ) function. The ok_text button is the default
button (the button which will be selected if the user presses Enter instead of clicking with the
mouse).
Example
Dim more As Logical
more = Ask("Do you want to continue?", "OK", "Stop")
See Also
Dialog statement, Note statement, Print statement
104
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Atn( ) function
Purpose
Returns the arc-tangent value of a number.
Syntax
Atn( num_expr )
num_expr is a numeric expression.
Return Value
Float
Description
The Atn( ) function returns the arc-tangent of the numeric num_expr value. In other words, Atn( )
returns the angle whose tangent is equal to num_expr. The num_expr expression can have any
numeric value.
The result returned from Atn( ) represents an angle, expressed in radians, in the range -Pi/2 radians
to Pi/2 radians.
To convert a degree value to radians, multiply that value by DEG_2_RAD. To convert a radian value
into degrees, multiply that value by RAD_2_DEG. (Note that your program will need to Include
“MAPBASIC.DEF” in order to reference DEG_2_RAD or RAD_2_DEG).
Example
Include "MAPBASIC.DEF"
Dim val As Float
val = Atn(1) * RAD_2_DEG
'val is now 45, since the
'Arc tangent of 1 is 45 degrees
See Also
Acos( ) function, Asin( ) function, Cos( ) function, Sin( ) function, Tan( ) function
Reference Guide
105
AutoLabel statement
AutoLabel statement
Purpose
Draws labels in a Map window, and stores the labels in the Cosmetic layer.
Syntax
AutoLabel
[ Window window_id ]
[ { Selection | Layer layer_id } ]
[ Overlap [ { On | Off } ] ]
[ Duplicates [ { On | Off } ] ]
window_id is an integer window identifier for a Map window.
layer_id is a table name (e.g., World) or a SmallInt layer number (e.g., 1 to draw labels for the top
layer).
Description
The AutoLabel statement draws labels (text objects) in a Map window. Only objects that are
currently visible in the Map window are labeled. The Window clause controls which Map window is
labeled. If you omit the Window clause, MapInfo Professional draws labels in the front-most Map
window. If you specify Selection, only selected objects are labeled. If you omit both the Selection
and the Layer clause, all layers are labeled.
The Overlap clause controls whether MapInfo Professional draws labels that overlap other labels.
This setting defaults to Off (MapInfo Professional will not draw overlapping labels). To force MapInfo
Professional to draw a label for every map object, regardless of whether the labels overlap, specify
Overlap On. The Duplicates clause controls whether MapInfo Professional draws a new label for
an object that has already been labeled. This setting defaults to Off (duplicates not allowed). The
AutoLabel statement uses whatever font and position settings are in effect. Set label options by
choosing Map > Layer Control. To control font and position settings through MapBasic, issue a Set
Map statement.
Example
Open Table "world" Interactive
Open Table "worldcap" Interactive
Map From world, worldcap
AutoLabel
Window FrontWindow( )
Layer world
See Also
Set Map statement
106
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Beep statement
Purpose
Makes a beeping sound.
Syntax
Beep
Description
The Beep statement sends a sound to the speaker.
Browse statement
Purpose
Opens a new Browser window.
Syntax
Browse expression_list From table
[ Position ( x, y ) [ Units paper_units ] ]
[ Width window_width [ Units paper_units ] ]
[ Height window_height [ Units paper_units ] ]
[ Row n ]
[ Column n ]
[ Min | Max ]
expression_list is either an asterisk or a comma-separated list of column expressions.
table is a string representing the name of an open table.
x, y specifies the position of the upper left corner of the Browser, in paper_units.
paper_units is a string representing a paper unit name (for example, “cm” for centimeters).
window_width and window_height specify the size of the Browser, in paper_units.
n is a positive integer value.
Reference Guide
107
Browse statement
Description
The Browse statement opens a Browse window to display a table.
If the expression_list is simply an asterisk (*), the new Browser includes all fields in the table.
Alternately, the expression_list clause can consist of a comma-separated list of expressions, each of
which defines one column that is to appear in the Browser. Expressions in the list can contain
column names, operators, functions, and variables. Each column's name is derived from the
expression that defines the column. Thus, if a column is defined by the expression population /
area(obj, “acre”), that expression will appear on the top row of the Browser, as the column
name. To assign an alias to an expression, follow the expression with a string; see the example
below.
An optional Position clause lets you specify where on the screen to display the Browser. The x
coordinate specifies the distance (in paper units) from the left edge of the MapInfo Professional
application window to the left edge of the Browser. The y coordinate specifies the distance from the
top of the MapInfo Professional window down to the top of the Browser. The optional Width and
Height clauses specify the size of the Browser window, in paper units. If no Width and Height
clauses are provided, MapInfo Professional assigns the Browser window a default size which
depends on the table in question: the Browser height will generally be one quarter of the screen
height, unless the table does not have enough rows to fill a Browser window that large; and the
Browser width will depend on the widths of the fields in the table.
If the Browse statement includes the optional Max keyword, the resultant Browser window is
maximized, taking up all of the screen space available to MapInfo. Conversely, if the Browse
statement includes the Min keyword, the Browser window is minimized immediately.
The Row clause dictates which row of the table should appear at the top of the Browser. If the
Browse statement does not include a Row clause, the first row of the table will be the top row in the
Browser.
Similarly, the Column clause dictates which of the table's columns should appear at the left edge of
the Browser. If the Browse statement does not include a Column clause, the table's first column will
appear at the left edge of the Browser window.
Example
The following example opens the World table and displays all columns from the table in a Browser
window.
Open Table "world"
Browse * From world
The next example specifies exactly which column expressions from the World table should be
displayed in the Browser.
Open Table "world"
Browse
country,
population,
population/area(obj, "sq km") "Density"
From world
108
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
The resultant Browser has three columns. The first two columns represent data as it is stored in the
World table, while the third column is derived. Through the third expression, MapBasic divides the
population of each country record with the geographic area of the region associated with that record.
The derived column expression has an alias (“Density”) which appears on the top row of the Browse
window.
See Also
Set Browse statement, Set Window statement
Brush clause
Purpose
Specifies a fill style for graphic objects.
Syntax
Brush brush_expr
brush_expr is a Brush expression, such as MakeBrush( pattern, fgcolor, bgcolor ). (See
MakeBrush( ) function on page 374 for more information.) or a Brush variable.
Description
The Brush clause specifies a brush style—in other words, a set of color and pattern settings that
dictate the appearance of a filled object, such as a circle or rectangle. Brush is a clause, not a
complete MapBasic statement. Various object-related statements, such as Create Ellipse
statement, allow you to specify a brush value. The keyword Brush may be followed by an
expression which evaluates to a Brush value. This expression can be a Brush variable:
Brush br_var
or a call to a function which returns a Brush value:
Brush MakeBrush(64, CYAN, BLUE)
With some MapBasic statements (e.g., Set Map statement), the keyword Brush can be followed
immediately by the three parameters that define a Brush style (pattern, foreground color, and
background color) within parentheses:
Brush(64, CYAN, BLUE)
Some MapBasic statements take a Brush expression as a parameter (e.g., the name of a Brush
variable), rather than a full Brush clause (the keyword Brush followed by the name of a Brush
variable). The Alter Object statement is one example.
The following table summarizes the three components (pattern, foreground color, background color)
that define a Brush:
Reference Guide
109
Brush clause
Component
Description
pattern
Integer value from 1 to 8 or from 12 to 71; see table below.
foreground color
Integer RGB color value; see RGB( ) function. The definitions file,
MAPBASIC.DEF, includes Define statements for BLACK, WHITE, RED,
GREEN, BLUE, CYAN, MAGENTA, and YELLOW.
background color
Integer RGB color value.
To specify a transparent background, use pattern 3 or larger, and omit the background color from the
Brush clause. For example, specify Brush(5, BLUE) to see thin blue stripes with no background
fill color. Omitting the background parameter is like clearing the Background check box in MapInfo
Professional's Region Style dialog box.
To specify a transparent background when calling the MakeBrush( ) function specify -1 as the
background color.
The available patterns appear below. Pattern 2 produces a solid fill; pattern 1 produces no fill.
Note: A more comprehensive list of the fill patterns available in MapInfo Professional is in the
MapInfo Professional User Guide Unabridged, which is available on the MapInfo
Professional installation CD or
http://extranet.mapinfo.com/documentation/software/mapinfo_pro/english/8.0/MI_UG.
pdf.
110
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
See Also
CurrentBrush( ) function, MakeBrush( ) function, Pen clause, Font clause, Symbol clause
Buffer( ) function
Purpose
Returns a region object that represents a buffer region (the area within a specified buffer distance of
an existing object).
Syntax
Buffer( inputobject, resolution, width, unit_name )
inputobject is an object expression.
resolution is a SmallInt value representing the number of nodes per circle at each corner.
Reference Guide
111
ButtonPadInfo( ) function
width is a float value representing the radius of the buffer; if width is negative, and if inputobject is a
closed object, the object returned represents an object smaller than the original object. If the width is
negative, and the object is a linear object (line, polyline, arc) or a point, then the absolute value of
width is used to produce a positive buffer.
unit_name is the name of the distance unit (e.g., “mi” for miles, “km” for kilometers) used by width.
Return Value
Returns a region object.
Description
The Buffer( ) function returns a region representing a buffer.
The Buffer( ) function operates on one single object at a time. To create a buffer around a set of
objects, use the Create Object As Buffer statement. The object will be created using the current
MapBasic coordinate system. The method used to calculate the buffer depends on the coordinate
system. If it is NonEarth, then a Cartesian method will be used. Otherwise, a spherical method will
be used.
Example
The following program creates a line object, then creates a buffer region surrounding the line. The
buffer region extends ten miles in all directions from the line.
Dim o_line, o_region As Object
o_line = CreateLine(-73.5, 42.5, -73.6, 42.8)
o_region = Buffer( o_line, 20, 10, "mi")
See Also
Create Object statement
ButtonPadInfo( ) function
Purpose
Returns information about a ButtonPad.
Syntax
ButtonPadInfo( pad_name, attribute )
pad_name is a string representing the name of an existing ButtonPad; use “Main”, “Drawing”, “Tools”
or “Standard” to query the standard pads, or specify the name of a custom pad.
attribute is a code indicating which information to return; see table below.
Return Value
Depends on the attribute parameter specified.
112
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Description
The attribute parameter specifies what to return. Codes are defined in MAPBASIC.DEF
attribute code
ButtonPadInfo( ) returns:
BTNPAD_INFO_FLOATING
Logical. TRUE means the pad is floating, FALSE means the pad is
docked.
BTNPAD_INFO_NBTNS
SmallInt. The number of buttons on the pad.
BTNPAD_INFO_WIDTH
SmallInt: The width of the pad, expressed as a number of buttons
(not including separators).
BTNPAD_INFO_WINID
Integer. The window ID of the specified pad.
BTNPAD_INFO_X
A number indicating the x-position of the upper-left corner of the
pad. If pad is docked, this is an integer, zero or greater; if pad is
floating, this is a float value, in paper units such as inches.
BTNPAD_INFO_Y
A number indicating the y-position of the upper-left corner of the
pad.
Example
Include "mapbasic.def"
If ButtonPadInfo("Main", BTNPAD_INFO_FLOATING) Then
'...then the Main pad is floating; now let's dock it.
Alter ButtonPad "Main" ToolbarPosition(0,0) Fixed
End If
See Also
Alter ButtonPad statement
Call statement
Purpose
Calls a sub procedure or an external routine (DLL, XCMD).
Restrictions
You cannot issue a Call statement through the MapBasic window.
Syntax
Call subproc [ ( [ parameter ] [ , ... ] ) ]
subproc is the name of a sub procedure.
parameter is a parameter expression to pass to the sub procedure.
Reference Guide
113
Call statement
Description
The Call statement calls a procedure. The procedure is usually a conventional MapBasic sub
procedure (defined through the Sub…End Sub statement). Alternately, a program running under
MapInfo Professional can call a Windows Dynamic Link Library (DLL) routine through the Call
statement.
When a Call statement calls a conventional MapBasic procedure, MapBasic begins executing the
statements in the specified sub procedure, and continues until encountering an End Sub or an Exit
Sub statement. At that time, MapBasic returns from the sub procedure, then executes the
statements following the Call statement. The Call statement can only access sub procedures which
are part of the same application.
A MapBasic program must issue a Declare Sub statement to define the name and parameter list of
any procedure which is to be called. This requirement is independent of whether the procedure is a
conventional MapBasic Sub procedure, a DLL procedure or an XCMD.
Parameter Passing
Sub procedures may be defined with no parameters. If a particular sub procedure has no
parameters, then calls to that sub procedure may appear in either of the following forms:
Call subroutine
or
Call subroutine( )
By default, each sub procedure parameter is defined “by reference.” When a sub procedure has a
by-reference parameter, the caller must specify the name of a variable to pass as the parameter.
If the procedure then alters the contents of the by-reference parameter, the caller's variable is
automatically updated to reflect the change. This allows the caller to examine the results returned by
the sub procedure.
Alternately, any or all sub procedure parameters may be passed “by value” if the keyword ByVal
appears before the parameter name in the Sub and Declare Sub declarations. When a parameter is
passed by value, the sub procedure receives a copy of the value of the parameter expression; thus,
the caller can pass any expression, rather than having to pass the name of a variable.
A sub procedure can take an entire array as a single parameter. When a sub procedure expects an
array as a parameter, the caller should specify the name of an array variable, without parentheses.
Calling External Routines
When a Call statement calls a DLL routine, MapBasic executes the routine until the routine returns.
The specified DLL routine is actually located in a separate file (e.g., “KERNEL.EXE”). The specified
DLL file must be present at run-time for MapBasic to complete a DLL Call.
Similarly, if a Call statement calls an XCMD, the file containing the XCMD must be present at runtime. When calling XCMDs, you cannot specify array variables or variables of custom data Types as
parameters.
114
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Example
In the following example, the sub procedure Cube cubes a number (raises the number to the power
of three), and returns the result. The sub procedure takes two parameters; the first parameter
contains the number to be cubed, and the second parameter passes the results back to the caller.
Declare Sub Cube(ByVal original As Float, cubed As Float)
Dim x, result As Float
Call Cube( 2, result)
' result now contains the value: 8 (2 x 2 x 2)
x = 1
Call Cube( x + 2, result)
' result now contains the value: 27 (3 x 3 x 3)
End Program
Sub Cube (ByVal original As Float, cubed As Float)
' Cube the "original" parameter, and store
' the result in the "cubed" parameter.
cubed = original ^ 3
End Sub
See Also
Declare Sub statement, Exit Sub statement, Global statement, Sub…End Sub statement
CartesianArea( ) function
Purpose
Returns the area as calculated in a flat, projected coordinate system using a Cartesian algorithm.
Syntax
CartesianArea( obj_expr, unit_name )
obj_expr is an object expression.
unit_name is a string representing the name of an area unit (e.g., “sq km”).
Return Value
Float
Description
The CartesianArea( ) function returns the Cartesian area of the geographical object specified by
obj_expr.
The function returns the area measurement in the units specified by the unit_name parameter; for
example, to obtain an area in acres, specify “acre” as the unit_name parameter. See the Set Area
Units statement for the list of available unit names.
The CartesianArea( ) function will always return the area using a cartesian algorithm. A value of -1
will be returned for data that is in a Latitude/Longitude since the data is not projected.
Reference Guide
115
CartesianBuffer( ) function
Only regions, ellipses, rectangles, and rounded rectangles have any area. By definition, the
CartesianArea( ) of a point, arc, text, line, or polyline object is zero. The CartesianArea( ) function
returns approximate results when used on rounded rectangles. MapBasic calculates the area of a
rounded rectangle as if the object were a conventional rectangle.
Examples
The following example shows how the CartesianArea( ) function can calculate the area of a single
geographic object. Note that the expression tablename.obj (as in states.obj) represents the
geographical object of the current row in the specified table.
Dim f_sq_miles As Float
Open Table "counties"
Fetch First From counties
f_sq_miles = CartesianArea(counties.obj, "sq mi")
You can also use the CartesianArea( ) function within the Select statement, as shown in the
following example.
Select lakes, CartesianArea(obj, "sq km")
From lakes Into results
See Also
Area( ) function, SphericalArea( ) function
CartesianBuffer( ) function
Purpose
Returns a region object that represents a buffer region (the area within a specified buffer distance of
an existing object).
Syntax
CartesianBuffer( inputobject, resolution, width, unit_name )
inputobject is an object expression.
resolution is a SmallInt value representing the number of nodes per circle at each corner.
width is a float value representing the radius of the buffer; if width is negative, and if inputobject is a
closed object, the object returned represents an object smaller than the original object.
unit_name is the name of the distance unit (e.g., “mi” for miles, “km” for kilometers) used by width.
Return Value
Region Object
Description
The CartesianBuffer( ) function returns a region representing a buffer and operates on one single
object at a time.
116
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
To create a buffer around a set of objects, use the Create Object As Buffer statement. If width is
negative, and the object is a linear object (line, polyline, arc) or a point, then the absolute value of
width is used to produce a positive buffer.
The CartesianBuffer( ) function calculates the buffer by assuming the object is in a flat projection
and using the width to calculate a cartesian distance calculated buffer around the object.
If the inputobject is in a Latitude/Longitude Projection, then Spherical calculations will be used
regardless of the Buffer function used.
Example
The following program creates a line object, then creates a buffer region that extends 10 miles
surrounding the line.
Dim o_line, o_region As Object
o_line = CreateLine(-73.5, 42.5, -73.6, 42.8)
o_region = CartesianBuffer( o_line, 20, 10, "mi")
See Also
Buffer( ) function, Creating Map Objects
CartesianConnectObjects( ) function
Purpose
Returns an object representing the shortest or longest distance between two objects.
Syntax
CartesianConnectObjects(object1, object2, min)
object1 and object2 are object expressions.
min is a logical expression where TRUE calculates the minimum distance between the objects, and
FALSE calculates the maximum distance between objects.
Return Value
This statement returns a single section, two-point Polyline object representing either the closest
distance (min == TRUE) or farthest distance (min == FALSE) between object1 and object2.
Description
One point of the resulting Polyline object is on object1 and the other point is on object2. Note that the
distance between the two input objects can be calculated using the ObjectLen( ) function. If there
are multiple instances where the minimum or maximum distance exists (e.g., the two points returned
are not uniquely the shortest distance and there are other points representing “ties”) then these
functions return one of the instances. There is no way to determine if the object returned is uniquely
the shortest distance.
Reference Guide
117
CartesianDistance( ) function
CartesianConnectObjects( ) returns a Polyline object connecting object1 and object2 in the
shortest (min == TRUE) or longest (min == FALSE) way using a cartesian calculation method. If
the calculation cannot be done using a cartesian distance method (e.g., if the MapBasic Coordinate
System is Lat/Long), then this function will produce an error.
CartesianDistance( ) function
Purpose
Returns the distance between two locations.
Syntax
CartesianDistance( x1, y1, x2, y2, unit_name )
x1 and x2 are x-coordinates.
y1 and y2 are y-coordinates.
unit_name is a string representing the name of a distance unit (e.g., “km”).
Return Value
Float
Description
The CartesianDistance( ) function calculates the Cartesian distance between two locations. It
returns the distance measurement in the units specified by the unit_name parameter; for example, to
obtain a distance in miles, specify “mi” as the unit_name parameter. See Set Distance Units
statement for the list of available unit names.
The CartesianDistance( ) function always returns a value using a cartesian algorithm. A value of -1
is returned for data that is in a Latitude/Longitude coordinate system, since Latitude/Longitude data
is not projected and not cartesian.
The x- and y-coordinate parameters must use MapBasic's current coordinate system. By default,
MapInfo Professional expects coordinates to use a Latitude/Longitude coordinate system. You can
reset MapBasic's coordinate system through the Set CoordSys statement.
Example
Dim dist, start_x, start_y, end_x, end_y As Float
Open Table "cities"
Fetch First From cities
start_x = CentroidX(cities.obj)
start_y = CentroidY(cities.obj)
Fetch Next From cities
end_x = CentroidX(cities.obj)
end_y = CentroidY(cities.obj)
dist = CartesianDistance(start_x,start_y,end_x,end_y,"mi")
118
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
See Also
Math Functions, CartesianDistance( ) function, Distance( ) function
CartesianObjectDistance( ) function
Purpose
Returns the distance between two objects.
Syntax
CartesianObjectDistance(object1, object2, unit_name)
object1 and object2 are object expressions.
unit_name is a string representing the name of a distance unit.
Return Value
Float
Description
CartesianObjectDistance( ) returns the minimum distance between object1 and object2 using a
cartesian calculation method with the return value in unit_name. If the calculation cannot be done
using a cartesian distance method (e.g., if the MapBasic Coordinate System is Lat/Long), then this
function will produce an error.
CartesianObjectLen( ) function
Purpose
Returns the geographic length of a line or polyline object.
Syntax
CartesianObjectLen( obj_expr, unit_name )
obj_expr is an object expression.
unit_name is a string representing the name of a distance unit (e.g., “km”).
Return Value
Float
Description
The CartesianObjectLen( ) function returns the length of an object expression. Note that only line
and polyline objects have length values greater than zero; to measure the circumference of a
rectangle, ellipse, or region, use the Perimeter( ) function.
Reference Guide
119
CartesianOffset( ) function
The CartesianObjectLen( ) function will always return a value using a cartesian algorithm. A value
of -1 will be returned for data that is in a Latitude/Longitude coordinate system, since
Latitude/Longitude data is not projected and not cartesian.
The CartesianObjectLen( ) function returns a length measurement in the units specified by the
unit_name parameter; for example, to obtain a length in miles, specify “mi” as the unit_name
parameter. See the Set Distance Units statement for the list of valid unit names.
Example
Dim geogr_length As Float
Open Table "streets"
Fetch First From streets
geogr_length = CartesianObjectLen(streets.obj, "mi")
' geogr_length now represents the length of the
' street segment, in miles
See Also
SphericalObjectLen( ) function, CartesianObjectLen( ) function, ObjectLen( ) function
CartesianOffset( ) function
Purpose
Returns a copy of the input object offset by the specified distance and angle using a Cartesian
DistanceType.
Syntax
CartesianOffset( object, angle, distance, units )
object is the object being offset.
angle is the angle to offset the object.
distance is the distance to offset the object.
units is a string representing the unit in which to measure distance.
Return Value
Object
Description
This function produces a new object that is a copy of the input object offset by distance along angle
(in degrees with horizontal in the positive X-axis being 0 and positive being counterclockwise). The
unit string, similar to that used for ObjectLen( ) function or Perimeter( ) function, is the unit for the
distance value. The DistanceType used is Cartesian. If the coordinate system of the input object is
Lat/Long, an error will occur, since Cartesian DistanceTypes are not valid for Lat/Long. This is
signified by returning a NULL object. The coordinate system used is the coordinate system of the
input object.
120
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (e.g.,
the center of the bounding box), and then that value is converted from the input units into the
coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses the
fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
CartesianOffset(Rect, 45, 100, "mi")
See Also
CartesianOffsetXY( ) function
CartesianOffsetXY( ) function
Purpose
Returns a copy of the input object offset by the specified X and Y offset values using a cartesian
DistanceType.
Syntax
CartesianOffsetXY( object, xoffset, yoffset, units )
object is the object being offset.
xoffset and yoffset are the distance along the x and y axes to offset the object.
units is a string representing the unit in which to measure distance.
Return Value
Object
Description
This function produces a new object that is a copy of the input object offset by xoffset along the Xaxis and yoffset along the Y-axis. The unit string, similar to that used for ObjectLen( ) function or
Perimeter( ) function, is the unit for the distance values. The DistanceType used is Cartesian. If the
coordinate system of the input object is Lat/Long, an error will occur, since Cartesian DistanceTypes
are not valid for Lat/Long. This is signified by returning a NULL object. The coordinate system used
is the coordinate system of the input object.
Reference Guide
121
CartesianPerimeter( ) function
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (e.g.,
the center of the bounding box), and then that value is converted from the input units into the
coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses the
fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
CartesianOffset(Rect, 45, 100, "mi")
See Also
CartesianOffset( ) function
CartesianPerimeter( ) function
Purpose
Returns the perimeter of a graphical object.
Syntax
CartesianPerimeter( obj_expr , unit_name )
obj_expr is an object expression.
unit_name is a string representing the name of a distance unit (e.g., “km”).
Return Value
Float
Description
The CartesianPerimeter( ) function calculates the perimeter of the obj_expr object. The
Perimeter( ) function is defined for the following object types: ellipses, rectangles, rounded
rectangles, and polygons. Other types of objects have perimeter measurements of zero.
The CartesianPerimeter( ) function will always return a value using a Cartesian algorithm. A value
of -1 will be returned for data that is in a Latitude/Longitude coordinate system, since
Latitude/Longitude data is not projected and not Cartesian.
The CartesianPerimeter( ) function returns a length measurement in the units specified by the
unit_name parameter; for example, to obtain a length in miles, specify “mi” as the unit_name
parameter. See the Set Distance Units statement for the list of valid unit names.
CartesianPerimeter( ) returns approximate results when used on rounded rectangles. MapBasic
calculates the perimeter of a rounded rectangle as if the object were a conventional rectangle.
122
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Example
The following example shows how you can use the CartesianPerimeter( ) function to determine the
perimeter of a particular geographic object.
Dim perim As Float
Open Table "world"
Fetch First From world
perim = CartesianPerimeter(world.obj, "km")
' The variable perim now contains
' the perimeter of the polygon that's attached to
' the first record in the World table.
You can also use the CartesianPerimeter( ) function within the Select statement. The following
Select statement extracts information from the States table, and stores the results in a temporary
table called Results. Because the Select statement includes the CartesianPerimeter( ) function,
the Results table will include a column showing each state's perimeter.
Open Table "states"
Select state, CartesianPerimeter(obj, "mi")
From states
Into results
See Also
CartesianPerimeter( ) function, SphericalPerimeter( ) function, Perimeter( ) function
Centroid( ) function
Purpose
Returns the centroid (center point) of an object.
Syntax
Centroid( obj_expr )
obj_expr is an object expression.
Return Value
Point object
Description
The Centroid( ) function returns a point object, which is located at the centroid of the specified
obj_expr object. A region's centroid does not represent its center of mass. Instead, it represents the
location used for automatic labeling, geocoding, and placement of thematic pie and bar charts. If you
edit a map in reshape mode, you can reposition region centroids by dragging them.
If the obj_expr parameter represents a point object, the Centroid( ) function returns the position of
the point. If the obj_expr parameter represents a line object, the Centroid( ) function returns the
point midway between the ends of the line.
Reference Guide
123
CentroidX( ) function
If the obj_expr parameter represents a polyline object, the Centroid( ) function returns a point
located at the mid point of the middle segment of the polyline.
If the obj_expr parameter represents any other type of object, the Centroid( ) function returns a
point located at the true centroid of the original object. For rectangle, arc, text, and ellipse objects,
the centroid position is halfway between the upper and lower extents of the object, and halfway
between the left and right extents. For region objects, however, the centroid position is always on the
object in question, and therefore may not be located halfway between the object's extents.
Example
Dim pos As Object
Open Table "world"
Fetch First From world
pos = Centroid(world.obj)
See Also
Alter Object statement, CentroidX( ) function, CentroidY( ) function
CentroidX( ) function
Purpose
Returns the x-coordinate of the centroid of an object.
Syntax
CentroidX( obj_expr )
obj_expr is an object expression
Return Value
Float
Description
The CentroidX( ) function returns the X coordinate (e.g., Longitude) component of the centroid of
the specified object. See the Centroid( ) function for a discussion of what the concept of a centroid
position means with respect to different types of graphical objects (lines vs. regions, etc.).
The coordinate information is returned in MapBasic's current coordinate system; by default,
MapBasic uses a Longitude/Latitude coordinate system. The Set CoordSys statement allows you
to change the coordinate system used.
124
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Examples
The following example shows how the CentroidX( ) function can calculate the longitude of a single
geographic object.
Dim x As Float
Open Table "world"
Fetch First From world
x = CentroidX(world.obj)
You can also use the CentroidX( ) function within the Select statement. The following Select
statement extracts information from the World table, and stores the results in a temporary table
called Results. Because the Select statement includes the CentroidX( ) function and the
CentroidY( ) function, the Results table will include columns which display the longitude and
latitude of the centroid of each country.
Open Table "world"
Select country, CentroidX(obj), CentroidY(obj)
From world Into results
See Also
Centroid( ) function, CentroidY( ) function, Set CoordSys statement
CentroidY( ) function
Purpose
Returns the y-coordinate of the centroid of an object.
Syntax
CentroidY( obj_expr )
obj_expr is an object expression.
Return Value
Float
Description
The CentroidY( ) function returns the Y-coordinate (e.g., latitude) component of the centroid of the
specified object. See the Centroid( ) function for a discussion of what the concept of a centroid
position means, with respect to different types of graphical objects (lines vs. regions, etc.).
The coordinate information is returned in MapBasic's current coordinate system; by default,
MapBasic uses a Longitude/Latitude coordinate system. The Set CoordSys statement allows you
to change the coordinate system used.
Reference Guide
125
CharSet clause
Example
Dim y As Float
Open Table "world"
Fetch First From world
y = CentroidY(world.obj)
See Also
Centroid( ) function, CentroidX( ) function, Set CoordSys statement
CharSet clause
Purpose
Specifies which character set MapBasic uses for interpreting character codes.
Note: See the MapInfo Professional 9.0 User Guide documentation for changes affecting this
clause.
Syntax
CharSet char_set
char_set is a string that identifies the name of a character set; see table below.
Description
The CharSet clause specifies which character set MapBasic should use when reading or writing
files or tables. Note that CharSet is a clause, not a complete statement. Various file-related
statements, such as the Open File statement, can incorporate optional CharSet clauses.
What Is A Character Set?
Every character on a computer keyboard corresponds to a numeric code. For example, the letter “A”
corresponds to the character code 65. A character set is a set of characters that appear on a
computer, and a set of numeric codes that correspond to those characters.
Different character sets are used in different countries. For example, in the version of Windows for
North America and Western Europe, character code 176 corresponds to a degrees symbol;
however, if Windows is configured to use a different character set, character code 176 may
represent a different character.
Call SystemInfo(SYS_INFO_CHARSET) to determine the character set in use at run-time.
How Do Character Sets Affect MapBasic Programs?
If your files use only standard ASCII characters in the range of 32 (space) to 126 (tilde), you do not
need to worry about character set conflicts, and you do not need to use the CharSet clause.
Even if your files include “special” characters (i.e., characters outside the range 32 to 126), if you do
all of your work within one environment (e.g., Windows) using only one character set, you do not
need to use the CharSet clause.
126
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
If your program needs to read an existing file that contains “special” characters, and if the file was
created in a character set that does not match the character set in use when you run your program,
your program should use the CharSet clause. The CharSet clause should indicate what character
set was in use when the file was created.
The CharSet clause takes one parameter: a string expression which identifies the name of the
character set to use. The following table lists all character sets available.
Character Set
Comments
“Neutral”
No character conversions performed.
“ISO8859_1”
ISO 8859-1 (UNIX)
“ISO8859_2”
ISO 8859-2 (UNIX)
“ISO8859_3”
ISO 8859-3 (UNIX)
“ISO8859_4”
ISO 8859-4 (UNIX)
“ISO8859_5”
ISO 8859-5 (UNIX)
“ISO8859_6”
ISO 8859-6 (UNIX)
“ISO8859_7”
ISO 8859-7 (UNIX)
“ISO8859_8”
ISO 8859-8 (UNIX)
“ISO8859_9”
ISO 8859-9 (UNIX)
“PackedEUCJapanese”
UNIX, standard Japanese implementation.
“WindowsLatin2”
“WindowsArabic”
“WindowsCyrillic”
“WindowsGreek”
“WindowsHebrew”
“WindowsTurkish”
Windows Eastern Europe
“WindowsTradChinese”
Windows Traditional Chinese
“WindowsSimpChinese”
Windows Simplified Chinese
“WindowsJapanese”
“WindowsKorean”
“CodePage437”
DOS Code Page 437 = IBM Extended ASCII
“CodePage850”
DOS Code Page 850 = Multilingual
“CodePage852”
DOS Code Page 852 = Eastern Europe
Reference Guide
127
CharSet clause
Character Set
“CodePage855”
Comments
DOS Code Page 855 = Cyrillic
“CodePage857”
“CodePage860”
DOS Code Page 860 = Portuguese
“CodePage861”
DOS Code Page 861 = Icelandic
“CodePage863”
DOS Code Page 863 = French Canadian
“CodePage864”
DOS Code Page 864 = Arabic
“CodePage865”
DOS Code Page 865 = Nordic
“CodePage869”
DOS Code Page 869 = Modern Greek
“LICS”
Lotus worksheet release 1,2 character set
“LMBCS”
Lotus worksheet release 3,4 character set
Note: You never need to specify a CharSet clause in an Open Table statement. Each table's .TAB
file contains information about the character set used by the table. When opening a table,
MapInfo Professional reads the character set information directly from the .TAB file, then
automatically performs any necessary character translations.
To force MapInfo Professional to save a table in a specific character set, include a CharSet clause in
the Commit Table statement.
MapBasic 2.x CharSet Syntax
MapBasic version 2.x supported three character sets: “XASCII”, “ANSI” and “MAC”. Older programs
that refer to those three character-set names will still compile and run in later versions of MapBasic;
however, continued use of the 2.x-era character set names is discouraged.
CharSet “XASCII” specifies the same character set as CharSet “CodePage437”.
CharSet “MAC” specifies the same character set as CharSet “MacRoman”.
When a program runs on Windows, CharSet “ANSI” specifies whatever character set Windows is
currently using. Example: When reading a file created by a DOS application, you should specify the
“CodePage437” character set, as shown in the following example.
Open File "parcel.txt"
For INPUT As #1
CharSet "CodePage437"
See Also
Commit Table statement, Create Table statement, Export statement, Open File statement,
Register Table statement
128
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
ChooseProjection$( ) function
Purpose
Displays the Choose Projection dialog box and returns the coordinate system selected by the user.
Syntax
ChooseProjection$( initial_coordsys, get_bounds )
initial_coordsys is a string value in the form of a CoordSys clause. It is used to set which coordinate
system is selected when the dialog box is first displayed. If initial_coordsys is empty or an invalid
CoordSys clause, then the default Longitude/Latitude coordinate system is used as the initial
selection.
get_bounds is a logical value that determines whether the users is prompted for boundary values
when a non-earth projection is selected. If get_bounds is true then the boundary dialog box is
displayed. If false, then the dialog box is not displayed and the default boundary is used.
Description
This function displays the Choose Projection dialog box and returns the selected coordinate system
as a string. The returned string is in the same format as the CoordSys clause. Use this function if
you wish to allow the user to set a projection within your application.
Example
Dim strNewCoordSys As String
strNewCoordSys = ChooseProjection$( "", True)
strNewCoordSys = "Set " + strNewCoordSys
Run Command strNewCoordSys
See Also
MapperInfo( ) function
Chr$( ) function
Purpose
Returns a one-character string corresponding to a specified character code.
Syntax
Chr$( num_expr )
num_expr is an integer value from 0 to 255 (or, if a double-byte character set is in use, from 0 to
65,535), inclusive.
Return Value
String
Reference Guide
129
Close All statement
Description
The Chr$( ) function returns a string, one character long, based on the character code specified in
the num_expr parameter. On most systems, num_expr should be a positive integer value between 0
and 255. On systems that support double-byte character sets (e.g., Windows Japanese), num_expr
can have a value from 0 to 65,535.
Note: All MapInfo Professional environments have common character codes within the range of 32
(space) to 126 (tilde).
If the num_expr parameter is fractional, MapBasic rounds to the nearest integer.
Character 12 is the form-feed character. Thus, you can use the statement Print Chr$(12) to
clear the Message window. Character 10 is the line-feed character; see example below.
Character 34 is the double-quotation mark ("). If a string expression includes the function call
Chr$(34), MapBasic embeds a double-quote character in the string.
Error Conditions
The ERR_FCN_ARG_RANGE error is generated if an argument is outside of the valid range.
Example
Dim s_letter As String * 1
s_letter = Chr$(65)
Note s_letter ' This displays the letter "A"
Note "This message spans" + Chr$(10) + "two lines."
See Also
Asc( ) function
Close All statement
Purpose
Closes all open tables.
Syntax
Close All [ Interactive ]
Description
If a MapBasic application issues a Close All statement, and the affected table has edits pending
(the table has been modified but the modifications have not yet been saved to disk), the edits will be
discarded before the table is closed. No warning will be displayed. If you do not want to discard
pending edits, use the optional Interactive clause to prompt the user to save or discard changes.
See Also
Close Table statement
130
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Close Connection statement
Purpose
Closes a connection opened with the Open Connection statement.
Syntax
Close Connection connection_handle
connection_handle is an integer expression representing the value returned from the Open
Connection statement.
Description
The Close Connection statement closes the specified connection using the connection handle that is
returned from an Open Connection statement. Any service specific properties associated with the
connection are lost.
See Also
Open Connection statement
Close File statement
Purpose
Closes an open file.
Syntax
Close File [ # ] filenum
filenum is an integer number identifying which file to close.
Description
The Close File statement closes a file which was opened through the Open File statement.
Note: The Open File statement and Close File statement operate on files in general, not on
MapInfo Professional tables. MapBasic provides a separate set of statements (e.g., Open
Table statement) for manipulating MapInfo tables.
Example
Open File "cxdata.txt" For INPUT As #1
'
' read from the file... then, when done:
'
Close File #1
Reference Guide
131
Close Table statement
See Also
Open File statement
Close Table statement
Purpose
Closes an open table.
Syntax
Close Table table [ Interactive ]
table is the name of a table that is open
Description
The Close Table statement closes an open table. To close all tables, use the Close All statement.
If a table is displayed in one or more Grapher or Browser windows, those windows disappear
automatically when the table is closed. If the Close Table statement closes the only table in a Map
window, the window closes. If you use the Close Table statement to close a linked table that has
edits pending, MapInfo Professional keeps the edits pending until a later session.
Saving Edits
If you omit the optional Interactive keyword, MapBasic closes the table regardless of whether the
table has unsaved edits; any unsaved edits are discarded. If you include the Interactive keyword,
and if the table has unsaved edits, MapBasic displays a dialog box allowing the user to save or
discard the edits or cancel the close operation.
To guarantee that pending edits are discarded, omit the Interactive keyword or issue a Rollback
statement before calling Close Table. To guarantee that pending edits are saved, issue a Commit
Table statement before the Close Table statement. To determine whether a table has unsaved
edits, call the TableInfo( table, TAB_INFO_EDITED) function.
Saving Themes and Cosmetic Objects
When you close the last table in a Map window, the window closes. However, the user may want to
save thematic layers or cosmetic objects before closing the window. To prompt the user to save
themes or cosmetic objects, include the Interactive keyword.
If you omit the Interactive keyword, the Close Table statement will not prompt the user to save
themes or cosmetic objects. If you include the Interactive keyword, dialog boxes will prompt the
user to save themes and/or cosmetic objects, if such prompts are appropriate. (The user is not
prompted if the window has no themes or cosmetic objects.)
132
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Examples
Open Table "world"
' ... when done using the WORLD table,
' close it by saying:
Close Table world
To deselect the selected rows, close the Selection table.
Close Table Selection
See Also
Close All statement, Commit Table statement, Open Table statement, Rollback statement,
TableInfo( ) function
Close Window statement
Purpose
Closes or hides a window.
Syntax
Close Window window_spec [ Interactive ]
window_spec is a window name (e.g., Ruler), a window code (e.g., WIN_RULER), or an integer
window identifier.
Description
The Close Window statement closes or hides a MapInfo Professional window.
To close a document window (Map, Browse, Graph, or Layout), specify an integer window identifier
as the window_spec parameter. You can obtain integer window identifiers through the
FrontWindow( ) function and the WindowID( ) function.
To close a special MapInfo Professional window, specify one of the window names from the table
below as the window_spec parameter. You can identify a special window by name (e.g., Ruler) or by
code (e.g., WIN_RULER).
The following table lists the available window_spec values:
window_spec value
Window description
MapBasic
The MapBasic window. You can also refer to this window by its define
code: WIN_MAPBASIC.
Help
The Help window. Its define code: WIN_HELP.
Statistics
The Statistics window. Its define code: WIN_STATISTICS.
Legend
The Theme Legend window. Its define code: WIN_LEGEND.
Reference Guide
133
ColumnInfo( ) function
window_spec value
Window description
Info
The Info tool window. Its define code: WIN_INFO.
Ruler
The Ruler tool window. Its define code: WIN_RULER.
Message
The Message window (which appears when you issue a Print
statement). Its define code: WIN_MESSAGE.
Saving Themes and Cosmetic Objects
The user may want to save thematic layers or cosmetic objects before closing the window. To
prompt the user to save themes or cosmetic objects, include the Interactive keyword.
If you omit the Interactive keyword, the Close Window statement will not prompt the user to save
themes or cosmetic objects. If you include the Interactive keyword, dialog boxes will prompt the
user to save themes and/or cosmetic objects, if such prompts are appropriate. (The user will not be
prompted if the window has no themes or cosmetic objects.)
Example
Close Window Legend
See Also
Open Window statement, Print statement, Set Window statement
ColumnInfo( ) function
Purpose
Returns information about a column in an open table.
Syntax
ColumnInfo( { tablename | tablenum } ,
{ columnname | "COLn"} , attribute )
tablename is a string representing the name of an open table.
tablenum is an integer representing the number of an open table.
columnname is the name of a column in that table.
n is the number of a column in the table.
attribute is a code indicating which aspect of the column to read.
Return Value
Depends on the attribute parameter specified.
134
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Description
The ColumnInfo( ) function returns information about one column in an open table.
The function's first parameter specifies either the name or the number of an open table. The second
parameter specifies which column to query. The attribute parameter dictates which of the column's
attributes the function should return. The attribute parameter can be any value from this table.
attribute setting
ColumnInfo( ) returns:
COL_INFO_NAME
String identifying the column name.
COL_INFO_NUM
SmallInt indicating the number of the column.
COL_INFO_TYPE
SmallInt indicating the column type (see table below).
COL_INFO_WIDTH
SmallInt indicating the column width; applies to Character or
Decimal columns only.
COL_INFO_DECPLACES
SmallInt indicating the number of decimal places in a Decimal
column.
COL_INFO_INDEXED
Logical value indicating if column is indexed.
COL_INFO_EDITABLE
Logical value indicating if column is editable.
If the ColumnInfo( ) function call specifies COL_INFO_TYPE as its attribute parameter, MapBasic
returns one of the values from the table below:
ColumnInfo( ) returns:
Type of column indicated:
COL_TYPE_CHAR
Character.
COL_TYPE_DECIMAL
Fixed-point decimal.
COL_TYPE_FLOAT
Floating-point decimal.
COL_TYPE_INTEGER
Integer (4-byte).
COL_TYPE_SmallInt
Small integer (2-byte).
COL_TYPE_DATE
Date.
COL_TYPE_LOGICAL
Logical (TRUE or FALSE).
COL_TYPE_GRAPHIC
special column type Obj; this represents the graphical objects
attached to the table.
The codes listed in both of the above tables are defined in the standard MapBasic definitions file,
MAPBASIC.DEF. Your program must Include “MAPBASIC.DEF” if you intend to reference these
codes.
Reference Guide
135
Combine( ) function
Error Conditions
ERR_TABLE_NOT_FOUND error generated if the specified table is not available.
ERR_FCN_ARG_RANGE error generated if an argument is outside of the valid range.
Example
Include "MAPBASIC.DEF"
Dim s_col_name As String, i_col_type As SmallInt
Open Table "world"
s_col_name = ColumnInfo("world","col1",COL_INFO_NAME)
i_col_type = ColumnInfo("world","col1",COL_INFO_TYPE)
See Also
NumCols( ) function, TableInfo( ) function
Combine( ) function
Purpose
Returns a region or polyline representing the union of two objects. The objects cannot be Text
objects.
Syntax
Combine( object1, object2 )
object1, object2 are two object expressions; both objects can be closed (e.g., a region and a circle),
or both objects can be linear (e.g., a line and a polyline)
Return Value
An object that is the union of object1 and object2.
Description
The Combine( ) function returns an object representing the geographical union of two object
expressions. The union of two objects represents the entire area that is covered by either object.
The Combine( ) function has been updated to allow heterogeneous combines, and to allow Points,
MultiPoints, and Collections as input objects. Previously, both objects had to be either linear objects
(Lines, Polylines, or Arcs) and produce Polylines as output; or both input objects had to be closed
(Regions, Rectangles, Rounded Rectangles, or Ellipses) and produce Regions as output.
Heterogeneous combines are not allowed, as are combines containing Point, MultiPoint and
Collection objects. Text objects are still not allowed as input to Combine( ).
MultiPoint and Collection objects, introduced in MapInfo Professional 6.5, extend the Combine
operation. The following table details the possible combine options available and the output results:
136
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
Input Object Type
Input Object Type
OutputObject
Type
Point or MultiPoint
Point or MultiPoint
MultiPoint
Linear (Line, Polyline, Arc)
Linear
Polyline
Closed (Region, Rectangle, Rounded
Rectangle, Ellipse)
Closed
Region
Point, MultiPoint, Linear, Closed, Collection
Point, MultiPoint, Linear,
Closed, Collection
Collection
The results returned by Combine( ) are similar to the results obtained by choosing MapInfo
Professional's Objects > Combine menu item, except that the Combine menu item modifies the
original objects; the Combine( ) function does not alter the object1 or object2 expressions. Also, the
Combine( ) function does not perform data aggregation.
The object returned by the Combine( ) function retains the styles (e.g., color) of the object1
parameter when possible. Collection objects produced as output will get those portions of style that
are possible from object1, and the remaining portions of style from objects2. For example, if object1
is a Region and object2 is a Polyline, then the output collection will use the brush and boarder pen of
object1 for the Region style contained in the collection, and the pen from object2 for the Polyline
style in the collection.
See Also
Objects Combine statement
CommandInfo( ) function
Purpose
Returns information about recent events.
Syntax
CommandInfo( attribute )
attribute is an integer code indicating what type of information to return.
Return Value
Logical, float, integer, or string, depending on circumstances.
Description
The CommandInfo( ) function returns information about recent events that affect MapInfo
Professional—for example, whether the “Selection” table has changed, where the user clicked with
the mouse, or whether it was a simple click or a “shift click.”
Reference Guide
137
CommandInfo( ) function
After Displaying a Dialog Box
When you call CommandInfo( ) after displaying a custom dialog box, the attribute parameter can be
one of these codes:
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_DLG_OK
Logical value: TRUE if the user dismissed a custom dialog box by
clicking OK; FALSE if user canceled by clicking Cancel, pressing
Esc, etc. (This call is only valid following a Dialog statement.)
CMD_INFO_STATUS
Logical value: TRUE if the user allowed a progress-bar operation
to complete, or FALSE if the user pressed the Cancel button to
halt.
Within a Custom Menu or Dialog Handler
When you call CommandInfo( ) from within the handler procedure for a custom menu command or
a custom dialog box, the attribute parameter can be one of these codes:
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_MENUITEM
Integer value, representing the ID of the menu item the user
chose. This call is only valid within the handler procedure of a
custom menu item.
CMD_INFO_DLG_DBL
Logical value: TRUE if the user double-clicked on a ListBox or
MultiListBox control within a custom dialog box. This call is only
valid within the handler procedure of a custom dialog box.
Within a Standard Handler Procedure
When you call CommandInfo( ) from within a standard system handler procedure (such as
SelChangedHandler), the attribute parameter can be any of the codes from the following table. For
details, see the separate discussions of SelChangedHandler, RemoteMsgHandler procedure,
WinChangedHandler and WinClosedHandler. From within SelChangedHandler:
attribute code
CMD_INFO_SELTYPE
138
CommandInfo( attribute ) returns:
1 if one row was added to the selection;
2 if one row was removed from the selection;
3 if multiple rows were added to the selection;
4 if multiple rows were de-selected.
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_ROWID
Integer value: The number of the row that was selected or deselected (only applies if a single row was selected or deselected).
CMD_INFO_INTERRUPT
Logical value: TRUE if the user interrupted a selection by
pressing Esc, FALSE otherwise.
From within the RemoteMsgHandler procedure, the RemoteQueryHandler( ) function, or the
RemoteMapGenHandler procedure:
attribute code
CMD_INFO_MSG
CommandInfo( attribute ) returns:
String value, representing the execute string or the item name
sent to MapInfo Professional by a client program. For details, see
RemoteMsgHandler procedure, RemoteQueryHandler( )
function, or RemoteMapGenHandler procedure.
From within WinChangedHandler procedure or WinClosedHandler procedure:
attribute code
CMD_INFO_WIN
CommandInfo( attribute ) returns:
Integer value, representing the ID of the window that changed
or the window that closed. For details, see
WinChangedHandler procedure or WinClosedHandler
procedure.
From within ForegroundTaskSwitchHandler procedure:
attribute code
CMD_INFO_TASK_SWITCH
Reference Guide
CommandInfo( attribute ) returns:
Integer value, indicating whether MapInfo Professional just
became the active application or just stopped being the active
application. The return value matches one of these codes:
SWITCHING_INTO_MI Pro (If MapInfo Professional received
the focus) SWITCHING_OUT_OF_MapInfo Professional (If
MapInfo Professional lost the focus).
139
CommandInfo( ) function
After a Find Operation
Following a Find statement, the attribute parameter can be one of these codes:
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_FIND_RC
Integer value, indicating whether the Find statement found a
match.
CMD_INFO_FIND_ROWID
Integer value, indicating the Row ID number of the row that
was found.
CMD_INFO_X or CMD_INFO_Y
Floating-point number, indicating x- or y-coordinates of the
location that was found.
Within a Custom ToolButton's Handler Procedure
Within a custom ToolHandler procedure, you can specify any of these codes:
attribute code
CMD_INFO_X
CommandInfo( attribute ) returns:
x coordinate of the spot where the user clicked:
•
•
•
CMD_INFO_Y
y-coordinate of the spot where the user clicked:
•
•
•
140
If the user clicked on a Map, the return value represents a map
coordinate (e.g., longitude), in the current coordinate system
unit.
If the user clicked on a Browser, the value represents the
number of a column in the Browser (e.g., one for the leftmost
column, or zero for the select-box column).
If the user clicked in a Layout, the value represents the
distance from the left edge of the Layout (e.g., zero represents
the left edge), in MapBasic's current paper units.
If the user clicked on a map, the value represents a map
coordinate (e.g., Latitude).
If the user clicked on a Browser, the value represents a row
number; a value of one represents the top row, and a value of
zero represents the row of column headers at the top of the
window.
If the user clicked on a Layout, the value represents the
distance from the top edge of the Layout.
CMD_INFO_X2
x-coordinate of the spot where the user released the mouse
button. This only applies if the toolbutton was defined with a draw
mode that allows dragging, e.g., DM_CUSTOM_LINE.
CMD_INFO_Y2
y-coordinate of the spot where the user released the mouse
button.
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_SHIFT
Logical value: TRUE if the user held down the Shift key while
clicking.
CMD_INFO_CTRL
Logical value: TRUE if the user held down the Ctrl key while
clicking.
CMD_INFO_TOOLBTN
Integer value, representing the ID of the button the user clicked.
CMD_INFO_CUSTOM_OBJ
Object value: a polyline or polygon drawn by the user. Applies to
drawing modes DM_CUSTOM_POLYLINE or
DM_CUSTOM_POLYGON.
Hotlink Support
MapBasic applications launched via the Hotlink Tool can use the CommandInfo( ) function to obtain
information about the object that was activated. The following is a table of the attributes that can be
queried:
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_HL_WINDOW_ID
ID of map or browser window.
CMD_INFO_HL_TABLE_NAME
Name of table associated with the map layer or browser.
CMD_INFO_HL_ROWID
ID of the table row corresponding to the map object or
browser row.
CMD_INFO_HL_LAYER_ID
Layer ID, if the program was launched from a map window.
CMD_INFO_HL_FILE_NAME
Name of file launched.
See Also
FrontWindow( ) function, SelectionInfo( ) function, Set Command Info statement,
WindowInfo( ) function
Reference Guide
141
Commit Table statement
Commit Table statement
Purpose
Saves recent edits to disk, or saves a copy of a table.
Syntax
Commit Table table
[ As
filespec
[ Type { NATIVE |
DBF [ Charset
char_set ] |
Access Database database_filespec
Version version
Table tablename
[ Password pwd ] [ Charset char_set ] |
QUERY |
ODBC Connection ConnectionNumber Table tablename
[ ConvertDateTime {ON | OFF | INTERACTIVE}]
}]
[ CoordSys... ]
[ Version version ] ]
[ { Interactive | Automatic commit_keyword } ]
[ ConvertObjects {ON | OFF | INTERACTIVE}]
tableName is the name of the table as you want it to appear in database. Starting release 9.0, the
name can include a schema name which specifies the schema that the table belongs to. If no
schema name is provided, the table belongs to the default schema as in 8.5 and earlier versions.
The user is responsible for providing an eligible schema name and must know if the login user has
the proper permissions on the given schema. This extension is for SQL Server 2005 only.
filespec is a file specification (optionally including directory path). This is where the MapInfo .TAB file
is saved.
ConvertDateTime If the source table contains Time or Date type columns, these columns will be
converted to DATETIME or TIMESTAMP depending on whether the server supports the data types.
However, you can control this behavior using the clause ConvertDateTime. If the source table does
not contain a Time or Date type, this clause is a non-operational. If ConvertDateTime is set to ON
(which is the default setting), Time or Date type columns will be converted to DATETIME or
TIMESTAMP. If ConvertDateTime is set to OFF, the conversion is not done and the operation will be
cancelled if necessary. If ConvertDateTime is set to INTERACTIVE a dialog box will pop up to
prompt the user and the operation will depend on the user's choice. If the user chooses to convert,
then the operation will convert and continue; if the user chooses to cancel, the operation will be
cancelled.
The Time type requires conversion for all supported servers (Oracle, IBM Informix, MS SQL Server
and Access) and the Date type requires conversion for MS SQL Server and Access database
servers.
Note: For MS SQL Server and Access database servers, this restriction could be an backward
compatibility issue. In previous releases, we did the conversion without explaining it. In this
release, we suggest you use the DateTime data type instead of Date data type. If you still use
the Date data type, the conversion operation will fail.
142
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
version is an expression that specifies the version of the Microsoft Jet database format to be used by
the new database. Acceptable values are 4.0 (for Access 2000) or 3.0 (for Access '95/'97). If
omitted, the default version is 4.0. If the database in which the table is being created already exists,
the specified database version is ignored.
ConvertObjects ON automatically converts any unsupported objects encountered in supported
objects.
ConvertObjects OFF This does not convert any unsupported objects. If they are encountered, an
error message is displayed saying the table can not be saved. (Before implementation of this feature
this was the only behavior.)
ConvertObjects Interactive If any unsupported objects are encountered in a table, ask the user what
she wants to do.
char_set is the name of a character set; see CharSet clause on page 126.
database_filespec is a string that identifies the name and path of a valid Access database. If the
specified database does not exist, MapInfo Professional creates a new Access .MDB file.
pwd is the database-level password for the database, to be specified when database security is
turned on.
ODBC indicates a copy of the Table will be saved on the DBMS specified by ConnectionNumber.
ConnectionNumber is an integer value that identifies the specific connection to a database.
CoordSys is a coordinate system clause; see CoordSys clause on page 163.
version is 100 (to create a table that can be read by versions of MapInfo Professional) or 300
(MapInfo Professional 3.0 format) for non-Access tables. For Access tables, version is 410.
commit_keyword is one of the following keywords: NoCollision, ApplyUpdates, DiscardUpdates
ConvertDateTime Examples
Example 1
Commit Table DATETIME90 As "D:\MapInfo\Data\Remote\DATETIME90CPY.TAB"
Type ODBC Connection 1 Table """EAZYLOADER"".""DATETIME90CPY"""
ConvertDateTime Interactive
Reference Guide
143
Commit Table statement
Example 2
Server 1 Create Table """EAZYLOADER"".""CITY_125AA""" (Field1
Char(10),Field2 Char(10),Field3 Char(10),MI_STYLE Char(254)) KeyColumn
SW_MEMBER ObjectColumn SW_GEOMETRY
or
Server 1 Create Table "EAZYLOADER.CITY_125AA" (Field1 Char(10),Field2
Char(10),Field3 Char(10),MI_STYLE Char(254)) KeyColumn SW_MEMBER
ObjectColumn SW_GEOMETRY
Commit Table City_125aa As
"C:\Projects\Data\TestScripts\English\remote\City_125aacpy.tab" Type ODBC
Connection 1 Table """EAZYLOADER"".""CITY_125AACPY"""
or
Commit Table City_125aa As
"C:\Projects\Data\TestScripts\English\remote\City_125aacpy.tab" Type ODBC
Connection 1 Table "EAZYLOADER.CITY_125AACPY"
Description
If no As clause is specified, the Commit Table statement saves any pending edits to the table. This
is analogous to the user choosing File > Save.
A Commit Table statement that includes an As clause has the same effect as a user choosing File
> Save Copy As. The As clause can be used to save the table with a different name, directory, file
type, or projection.
To save the table under a new name, specify the new name in the filespec string. To save the table
in a new directory path, specify the directory path at the start of the filespec string.
To save the table using a new file type, include a Type clause within the As clause. By default, the
type of the new table is NATIVE, but can also be saved as DBF.
The CharSet clause specifies a character set. The char_set parameter should be a string constant,
such as “WindowsLatin1”. If no CharSet clause is specified, MapBasic uses the default character
set for the hardware platform that is in use at runtime. See CharSet clause on page 126 for more
information.
To save the table using a different coordinate system or projection, include a CoordSys clause
within the As clause. Note that only a mappable table may have a coordinate system or a projection.
To save a Query use the QUERY type for the table. Only queries made from the user interface and
queries created from Run Command statements in MapBasic can be saved. The Commit Table
statement creates a .TAB file and a .QRY file.
The Version clause controls the table's format. If you specify Version 100, MapInfo Professional
stores the table in a format readable by versions of MapInfo Professional. If you specify Version 300,
MapInfo Professional stores the table in MapInfo Professional 3.0 format. Note that region and
polyline objects having more than 8,000 nodes and multiple-segment polyline objects require
version 300. If you omit the Version clause, the table is saved in the version 300 format.
Note: If a MapBasic application issues a Commit Table…As statement affecting a table which has
memo fields, the memo fields will not be retained in the new table. No warning will be
displayed. If the table is saved to a new table through MapInfo Professional's user interface
144
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
(by choosing File > Save Copy As), MapInfo Professional warns the user about the loss of
the memo fields. However, when the table is saved to a new table name through a MapBasic
program, no warning appears.
Saving Linked Tables
Saving a linked table can generate a conflict, when another user may have edits the same data in
the same table MapInfo Professional will detect if there were any conflicts and allows the user to
resolve them. The following clauses let you control what happens when there is a conflict. (These
clauses have no effect on saving a conventional MapInfo table.)
Interactive
In the event of a conflict, MapInfo Professional displays the Conflict Resolution dialog box. After a
successful Commit Table Interactive statement, MapInfo Professional displays a dialog box
allowing the user to refresh.
Automatic NoCollision
In the event of a conflict, MapInfo Professional does not perform the save. (This is the default
behavior if the statement does not include an Interactive clause or an Automatic clause.)
Automatic ApplyUpdates
In the event of a conflict, MapInfo Professional saves the local updates. (This is analogous to
ignoring conflicts entirely.)
Automatic DiscardUpdates
In the event of a conflict, MapInfo Professional saves the local updates already in the RDBMS
(discards your local updates). You can copy a linked table by using the As clause; however, the new
copy is not a linked table and no changes are updated to the server.
ODBC Connection
The length of tablename varies with databases. We recommend 14 or fewer characters for a table
name in order to work correctly for all databases. The statement limits the length of the tablename to
a maximum of 31 characters.
If the As clause is used and ODBC is the Type, a copy of the table will be saved on the database
specified by ConnectionNumber and named as tablename. If the source table is mappable, three
more columns, Key column, Object column, and Style column, may be added to the destination
database table, tablename, whether or not the source table has those columns. If the source table is
not mappable, one more column, Key column, may be added to the database table, tablename,
even if the source table does not have a Key column. The Key column will be used to create a
unique index.
A spatial index will be created on the Object column if one is present. The supported databases
include Oracle, SQL Server, IIS (Informix Universal Server), and Microsoft Access. However, to save
a table with a spatial geometry/object, (including saving a point-only table) the SpatialWare/Blade is
required for SQL Server and IUS, in addition to the spatial option for Oracle. The XY schema is not
supported in this statement.
Reference Guide
145
ConnectObjects( ) function
Example
The following example opens the table STATES, then uses the Commit Table statement to make a
copy of the states table under a new name (ALBERS). The optional CoordSys clause causes the
ALBERS table to be saved using the Albers equal-area projection.
Open Table "STATES"
Commit Table STATES
As "ALBERS"
CoordSys Earth
Projection 9,7, "m", -96.0, 23.0, 20.0, 60.0, 0.0, 0.0
The following example illustrates an ODBC connection:
dim hodbc as integer
hodbc = server_connect("ODBC", "dlg=1")
Open table "C:\MapInfo\USA"
Commit Table USA
as "c:\temp\as\USA"
Type ODBC Connection hodbc Table "USA"
See Also
Rollback statement
ConnectObjects( ) function
Purpose
Returns an object representing the shortest or longest distance between two objects.
Syntax
ConnectObjects( object1, object2, min )
object1 and object2 are object expressions.
min is a logical expression where TRUE calculates the minimum distance between the objects, and
FALSE calculates the maximum distance between objects.
Return Value
This statement returns a single section, two-point Polyline object representing either the closest
distance (min == TRUE) or farthest distance (min == FALSE) between object1 and object2.
Description
One point of the resulting Polyline object is on object1 and the other point is on object2. Note that the
distance between the two input objects can be calculated using the ObjectLen( ) function. If there
are multiple instances where the minimum or maximum distance exists (e.g., the two points returned
are not uniquely the shortest distance and there are other points representing “ties”) then these
functions return one of the instances. There is no way to determine if the object returned is uniquely
the shortest distance.
146
MapBasic 9.0
Chapter 3: A – Z MapBasic Language Reference
ConnectObjects( ) returns a Polyline object connecting object1 and object2 in the shortest (min ==
TRUE) or longest (min == FALSE) way using a spherical calculation method. If the calculation
cannot be done using a spherical distance method (e.g., if the MapBasic coordinate system is
NonEarth), then a Cartesian method will be used.
Continue statement
Purpose
Resumes the execution of a MapBasic program (following a Stop statement).
Syntax
Continue
Restrictions
The Continue statement may only be issued from the MapBasic window; it may not be included as
part of a compiled program.
Description
The Continue statement resumes the execution of a MapBasic application which was suspended
because of a Stop statement.
You can include Stop statements in a program for debugging purposes. When a MapBasic program
encounters a Stop statement, the program is suspended, and the File menu automatically changes
to include a Continue Program option instead of a Run option. You can resume the suspended
application by choosing File > Continue Program. Typing the Continue statement into the
MapBasic window has the same effect as choosing Continue Program.
Reference Guide
147
Continue statement
148
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Control Button / OKButton / CancelButton clause
Purpose
Part of a Dialog statement; adds a push-button control to a dialog box.
Syntax
Control { Button | OKButton | CancelButton }
[ Position x, y ] [ Width w ] [ Height h ]
[ ID control_ID ]
[ Calling handler ]
[ Title title_string ]
[ Disable ] [ Hide ]
x, y specifies the button's position in dialog box units.
w specifies the width of the button in dialog box units; default width is 40.
h specifies the height of the button in dialog box units; default height is 18.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a procedure to call if the user clicks on the button.
title_string is a text string to appear on the button.
Description
If a Dialog statement includes a Control Button clause, the dialog box includes a push-button
control. If the OKButton keyword appears in place of the Button keyword, the control is a special
type of button; the user chooses an OKButton control to “choose OK” and dismiss the dialog box.
Similarly, the user chooses a CancelButton control to “choose Cancel” and dismiss the dialog box.
Each dialog box should have no more than one OKButton control, and have no more than one
CancelButton control. Disable makes the control disabled (grayed out) initially. Hide makes the
control hidden initially.
Use the Alter Control statement to change a control's status (e.g., whether the control is enabled
or hidden).
Example
Control Button
Title "&Reset"
Calling reset_sub
Position 10, 190
See Also
Alter Control statement, Dialog statement
Reference Guide
149
Control CheckBox clause
Control CheckBox clause
Purpose
Part of a Dialog statement; adds a check box control to a dialog box
Syntax
Control CheckBox
[ Position x, y ] [ Width w ]
[ ID control_ID ]
[ Calling handler ]
[ Title title_string ]
[ Value log_value ]
[ Into log_variable ]
[ Disable ] [ Hide ]
x, y specifies the control's position in dialog box units.
w specifies the width of the control in dialog box units.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a procedure to call if the user clicks on the control.
title_string is a text string to appear in the label to the right of the check-box.
log_value is a logical value: FALSE sets the control to appear un-checked initially.
log_variable is the name of a logical variable.
Description
If a Dialog statement includes a Control CheckBox clause, the dialog box includes a check-box
control.
The Value clause controls the initial appearance. If the Value clause is omitted, or if it specifies a
value of TRUE, the check-box is checked initially. If the Value clause specifies a FALSE value,
check-box is clear initially. Disable makes the control disabled (grayed out) initially. Hide makes the
control hidden initially.
Example
Control CheckBox
Title "Include &Legend"
Into showlegend
ID 6
Position 115, 155
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function
150
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Control DocumentWindow clause
Purpose
Part of a Dialog statement; adds a document window control to a dialog box which can be
re-parented for integrated mapping.
Syntax
Control DocumentWindow
[ Position x, y ]
[ Width w ] [ Height h ]
[ ID control_ID ]
[ Disable ] [ Hide ]
x, y specifies the control's position in dialog box units.
w specifies the width of the control in dialog units; default width is 100.
h specifies the height of the control in dialog units; default height is 100.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
Disable grays out the control initially.
Hide initially hides the control.
Description
If a Dialog statement includes a Control DocumentWindow clause, the dialog box includes a
document window control that can be re-parented using the Set Next Document statement.
Example
The following example draws a legend in a dialog box:
Control DocumentWindow
ID ID_LEGENDWINDOW
Position 160, 20
Width 120 Height 150
The dialog box handler will need to re-parent the window as in the following example:
Sub DialogHandler
OnError Goto HandleError
Dim iHwnd As Integer
Alter Control ID_LEGENDWINDOW Enable Show
' draw the legend
iHwnd = ReadControlValue(ID_LEGENDWINDOW)
Set Next Document Parent iHwnd Style WIN_STYLE_CHILD
Create Legend
Exit Sub
HandleError:
Note "DialogHandler: " + Error$( )
End Sub
Reference Guide
151
Control EditText clause
See Also
Dialog statement
Control EditText clause
Purpose
Part of a Dialog statement; adds an EditText control box (input text) to a dialog box.
Syntax
Control EditText
[ Position x, y ] [ Width w ] [ Height h ]
[ ID control_ID ]
[ Value initial_value ]
[ Into variable ]
[ Disable ] [ Hide ] [ Password ]
x, y specifies the control's position in dialog box units.
w specifies the width of the control in dialog box units.
h specifies the height of the control in dialog box units; if the height is greater than 20, the control
becomes a multiple-line control, and text wraps down onto successive lines.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
initial_value is a string or a numeric expression that initially appears in the dialog box.
variable is the name of a string variable or a numeric variable; MapInfo Professional stores the final
value of the field in the variable if the user clicks OK.
The Disable keyword makes the control disabled (grayed out) initially.
The Hide keyword makes the control hidden initially.
The Password keyword creates a password field, which displays asterisks as the user types.
Description
If the user types more text than can fit in the box at one time, MapInfo Professional automatically
scrolls the text to make room. An EditText control can hold up to 32,767 characters.
If the height is large enough to fit two or more lines of text (for example, if the height is larger than
20), MapInfo Professional automatically wraps text down to successive lines as the user types. If the
user enters a line-feed into the EditText box (for example, on Windows, if the user presses CtrlEnter while in the EditText box), the string associated with the EditText control will contain a
Chr$(10) value at the location of each line-feed. If the initial_value expression contains embedded
Chr$(10) values, the text appears formatted when the dialog box appears.
To make an EditText control the active control, use an Alter Control…Active statement.
152
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Control EditText
Value "Franchise Locations"
Position 65, 8 Width 90
ID 1
Into s_map_title
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function
Control GroupBox clause
Purpose
Part of a Dialog statement; adds a rectangle with a label to a dialog box.
Syntax
Control GroupBox
[ Position x, y ] [ Width w ] [ Height h ]
[ ID control_ID ]
[ Title title_string ]
[ Hide ]
x, y specifies the control's position in dialog box units.
w specifies the width of the control in dialog box units.
h specifies the height of the control in dialog box units.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
title_string is a text string to appear at the upper-left corner of the box
The Hide keyword makes the control hidden initially.
Example
Control GroupBox
Title "Level of Detail"
Position 5, 30
Height 40 Width 70
See Also
Alter Control statement, Dialog statement
Reference Guide
153
Control ListBox / MultiListBox clause
Control ListBox / MultiListBox clause
Purpose
Part of a Dialog statement; adds a list to a dialog box
Syntax
Control { ListBox | MultiListBox }
[ Position x, y ] [ Width w ] [ Height h ]
[ ID control_ID ]
[ Calling handler ]
[ Title { str_expr | From Variable str_array_var } ]
[ Value i_selected ]
[ Into i_variable ]
[ Disable ] [ Hide ]
x, y specifies the control's position in dialog box units.
w specifies the width of the control in dialog box units; default width is 80.
h specifies the height of the control in dialog box units; default height is 70.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a procedure to call if the user clicks or double-clicks on the list.
str_expr is a string expression, containing a semicolon-delimited list of items to appear in the control.
str_array_var is the name of an array of string variables.
i_selected is a SmallInt value indicating which list item should appear selected when the dialog box
first appears: a value of one selects the first list item; if the clause is omitted, no items are selected
initially.
i_variable is the name of a SmallInt variable which stores the user's final selection.
The Disable keyword makes the control disabled (grayed out) initially.
The Hide keyword makes the control hidden initially.
Description
If a Dialog statement includes a Control ListBox clause, the dialog box includes a listbox control.
If the list contains more items than can be shown in the control at one time, MapBasic automatically
adds a scroll-bar at the right side of the control.
A MultiListBox control is identical to a ListBox control, except that the user can shift-click to select
multiple items from a MultiListBox control.
The Title clause specifies the contents of the list. If the Title clause specifies a string expression
containing a semicolon-delimited list of items, each item appears as one item in the list. The
following sample Title clause demonstrates this syntax:
Title "1st Quarter;2nd Quarter;3rd Quarter;4th Quarter"
154
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Alternately, if the Title clause specifies an array of string variables, each entry in the array appears
as one item in the list. The following sample Title clause demonstrates this syntax:
Title From Variable s_optionlist
Processing a MultiListBox control
To read what items the user selected from a MultiListBox control, assign a handler procedure that is
called when the user dismisses the dialog box (for example, assign a handler to the OKButton
control). Within the handler procedure, set up a loop to call the ReadControlValue( ) function
repeatedly.
The first call to the ReadControlValue( ) function returns the number of the first selected item; the
second call to the ReadControlValue( ) function returns the number of the second selected item;
etc. When the ReadControlValue( ) function returns zero, you have exhausted the list of selected
items. If the first call to the ReadControlValue( ) function returns zero, there are no list items
selected.
Processing Double-click events
If you assign a handler procedure to a list control, MapBasic calls the procedure every time the user
clicks or double-clicks an item in the list. In some cases, you may want to provide special handling
for double-click events. For example, when the user double-clicks a list item, you may want to
dismiss the dialog box as if the user had clicked on a list item and then clicked OK.
To see an example, refer to the sample application NVIEWS.MB in <Your MapBasic Installation
Directory>\SAMPLES\MAPBASIC\SNIPPETS.
To determine whether the user clicked or double-clicked, call the CommandInfo( ) function within
the list control's handler procedure, as shown in the following sample handler procedure:
Sub lb_handler
Dim i As SmallInt
If CommandInfo(CMD_INFO_DLG_DBL) Then
' ... then the user double-clicked.
i = ReadControlValue( TriggerControl( ) )
Dialog Remove
' at this point, the variable i represents
' the selected list item...
End If
End Sub
Example
Control ListBox
Title "1st Quarter;2nd Quarter;3rd Quarter;4th Quarter"
ID 3
Value 1
Into i_quarter
Position 10, 92 Height 40
Reference Guide
155
Control ListBox / MultiListBox clause
The NVIEWS.MB sample program demonstrates how to create a dialog box which provides special
handling for when the user double-clicks. The NVIEWS program displays a dialog box with a ListBox
control. To complete the dialog box, the user can click on a list item and then choose OK, or the user
can double-click an item in the list.
The following Control ListBox clause adds a list to the Named Views dialog box. Note that the
ListBox control has a handler routine, “listbox_handler.”
Control ListBox
Title desc_list
ID 1
Position 10, 20 Width 245 Height
Calling listbox_handler
64
If the user clicks or double-clicks on the ListBox control, MapBasic calls the sub procedure
“listbox_handler.” The procedure calls the CommandInfo( ) function to determine whether the user
clicked or double-clicked. If the user double-clicked, the procedure issues a Dialog Remove
statement to dismiss the dialog box. If not for the Dialog Remove statement, the dialog box would
remain on the screen until the user clicked OK or Cancel.
Sub listbox_handler
Dim i As SmallInt
' First, since user clicked on the name of a view,
' we can enable the OK button and the Delete button.
Alter Control 2 Enable
Alter Control 3 Enable
If CommandInfo(CMD_INFO_DLG_DBL) = TRUE Then
' ...then the user DOUBLE-clicked.
' see which list item the user clicked on.
i = ReadControlValue(1) ' read user's choice.
Dialog Remove
Call go_to_view(i) ' act on user's choice.
End If
End Sub
MapBasic calls the handler procedure whether the user clicks or double-clicks. The handler
procedure must check to determine whether the event was a single- or double-click.
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function, CommandInfo( )
function
156
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Control PenPicker/BrushPicker/SymbolPicker/FontPicker clause
Purpose
Part of a Dialog statement; adds a button showing a pen (line), brush (fill), symbol (point), or font
(text) style.
Syntax
Control { PenPicker | BrushPicker | SymbolPicker | FontPicker }
[ Position x, y ] [ Width w ] [ Height h ]
[ ID control_ID ]
[ Calling handler ]
[ Value style_expr ]
[ Into style_var ]
[ Disable ] [ Hide ]
x, y specifies the control's position, in dialog box units.
w specifies the control's width, in dialog box units; default width is 20.
h specifies the control's height, in dialog box units; default height is 20.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a handler procedure; if the user clicks on the Picker control, and then clicks
OK on the style dialog box which appears, MapBasic calls the handler procedure.
style_expr is a Pen, Brush, Symbol, or Font expression, specifying what style will appear initially in
the control; this expression type must match the type of control (for example, must be a Pen
expression if the control is a PenPicker).
style_var is the name of a Pen, Brush, Symbol, or Font variable; this variable type must match the
type of control (for example, must be a Pen variable if the control is a PenPicker control).
The Disable keyword makes the control disabled (grayed out) initially.
The Hide keyword makes the control hidden initially.
Description
A Picker control (PenPicker, BrushPicker, SymbolPicker, or FontPicker) is a button showing a pen,
brush, symbol, or font style. If the user clicks on the button, a dialog box appears to allow the user to
change the style.
Example
Control SymbolPicker
Position 140,42
Into sym_storemarker
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function
Reference Guide
157
Control PopupMenu clause
Control PopupMenu clause
Purpose
Part of a Dialog statement; adds a popup menu control to the dialog box.
Syntax
Control PopupMenu
[ Position x, y ]
[ Width w ]
[ ID control_ID ]
[ Calling handler ]
[ Title { str_expr | From Variable str_array_var } ]
[ Value i_selected ]
[ Into i_variable ]
[ Disable ]
x, y specifies the control's position in dialog box units.
w specifies the control's width, in dialog box units; default width is 80.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a procedure to call when the user chooses an item from the menu.
str_expr is a string expression, containing a semicolon-delimited list of items to appear in the control.
str_array_var is the name of an array of string variables.
i_selected is a SmallInt value indicating which item should appear selected when the dialog box first
appears: a value of one selects the first item; if the clause is omitted, the first item appears selected.
i_variable is the name of a SmallInt variable which stores the user's final selection (one, if the first
item selected, etc.).
The Disable keyword makes the control disabled (grayed out) initially.
Description
If a Dialog statement includes a Control PopupMenu clause, the dialog box includes a pop-up
menu. A pop-up menu is a list of items, one of which is selected at one time. Initially, only the
selected item appears on the dialog box.
If the user clicks on the control, the entire menu appears, and the user can choose a different item
from the menu.
The Title clause specifies the list of items that appear in the menu. If the Title clause specifies a
string expression containing a semicolon-delimited list of items, each item appears as one item in
the menu. The following sample Title clause demonstrates this syntax:
Title "Town;County;Territory;Region;Entire state"
Alternately, the Title clause can specify an array of string variables, in which case each entry in the
array appears as one item in the popup menu.
158
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The following sample Title clause demonstrates this syntax:
Title From Variable s_optionlist
Example
Control PopupMenu
Title "Town;County;Territory;Region;Entire state"
Value 2
ID 5
Into i_map_scope
Position 10, 150
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function
Control RadioGroup clause
Purpose
Part of a Dialog statement; adds a list of radio buttons to the dialog box.
Syntax
Control RadioGroup
[ Position x, y ]
[ ID control_ID ]
[ Calling handler ]
[ Title { str_expr | From Variable str_array_var } ]
[ Value i_selected ]
[ Into i_variable ]
[ Disable ] [ Hide ]
x, y specifies the control's position in dialog box units.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
handler is the name of a procedure to call if the user clicks or double-clicks on any of the radio
buttons.
str_expr is a string expression, containing a semicolon-delimited list of items to appear in the control.
str_array_var is the name of an array of string variables.
i_selected is a SmallInt value indicating which item should appear selected when the dialog box first
appears: a value of one selects the first item; if the clause is omitted, the first item appears selected.
i_variable is the name of a SmallInt variable which stores the user's final selection (one, if the first
item selected, etc.).
The Disable keyword makes the control disabled (grayed out) initially.
The Hide keyword makes the control hidden initially.
Reference Guide
159
Control StaticText clause
Description
If a Dialog statement includes a Control RadioGroup clause, the dialog box includes a group of
radio buttons. Each radio button is a label to the right of a hollow or filled circle. The currentlyselected item is indicated by a filled circle. Only one of the radio buttons may be selected at one
time.
The Title clause specifies the list of labels that appear in the dialog box. If the Title clause specifies
a string expression containing a semicolon-delimited list of items, each item appears as one item in
the list.
The following sample Title clause demonstrates this syntax:
Title "&Full Details;&Partial Details"
Alternately, the Title clause can specify an array of string variables, in which case each entry in the
array appears as one item in the list. The following sample Title clause demonstrates this syntax:
Title From Variable s_optionlist
Example
Control RadioGroup
Title "&Full Details;&Partial Details"
Value 2
ID 2
Into i_details
Calling rg_handler
Position 15, 42
See Also
Alter Control statement, Dialog statement, ReadControlValue( ) function
Control StaticText clause
Purpose
Part of a Dialog statement; adds a label to a dialog box.
Syntax
Control StaticText
[ Position x, y ]
[ Width w ] [ Height h ]
[ ID control_ID ]
[ Title title_string ]
[ Hide ]
x, y specifies the control's position, in dialog box units.
w specifies the control's width, in dialog box units.
h specifies the control's height, in dialog box units.
control_ID is an integer; cannot be the same as the ID of another control in the dialog box.
160
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
title_string is a text string to appear in the dialog box as a label.
The Hide keyword makes the control hidden initially.
Description
If you want the text string to wrap down onto multiple lines, include the optional Width and Height
clauses. If you omit the Width and Height clauses, the static text control shows only one line of text.
Example
Control StaticText
Title "Enter map title:"
Position 5, 10
See Also
Alter Control statement, Dialog statement
ConvertToPline( ) function
Purpose
Returns a polyline object that approximates the shape of another object.
Syntax
ConvertToPline( object )
object is the object to convert; may not be a point object or a text object.
Return Value
A polyline object
Description
The ConvertToPline( ) function returns a polyline object which approximates the object parameter.
Thus, if the object parameter represents a region object, ConvertToPline( ) returns a polyline that
has the same shape and same number of nodes as the region.
The results obtained by calling ConvertToPline( ) are similar to the results obtained by choosing
MapInfo Professional's Objects > Convert To Polyline command. However, the function
ConvertToPline( ) does not alter the original object.
See Also
Objects Enclose statement
Reference Guide
161
ConvertToRegion( ) function
ConvertToRegion( ) function
Purpose
Returns a region object that approximates the shape of another object.
Syntax
ConvertToRegion( object )
object is the object to convert; may not be a point, line, or text object.
Return Value
A region object
Description
Retains most style attributes. Other attributes are determined by the current pens or brushes. A
polyline whose first and last nodes are identical will not have the last node duplicated. Otherwise,
MapInfo Professional adds a last node whose vertices are the same as the first node.
The ConvertToRegion( ) function returns a region object which approximates the object parameter.
Thus, if the object parameter represents a rectangle, ConvertToRegion( ) returns a region that
looks like a rectangle.
The results obtained by calling ConvertToRegion( ) are similar to the results obtained by choosing
MapInfo Professional's Objects > Convert To Region command. However, the
ConvertToRegion( ) function does not alter the original object.
See Also
Objects Enclose statement
ConvexHull( ) function
Purpose
Returns a region object that represents the convex hull polygon based on the nodes from the input
object. The convex hull polygon can be thought of as an operator that places a rubber band around
all of the points. It will consist of the minimal set of points such that all other points lie on or inside the
polygon. The polygon will be convex—no interior angle can be greater than 180 degrees.
Syntax
ConvexHull( inputobject )
inputobject is an object expression.
Return Value
Returns a region object.
162
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The ConvexHull( ) function returns a region representing the convex hull of the set of points
comprising the input object. The ConvexHull( ) function operates on one single object at a time. To
create a convex hull around a set of objects, use the Create Object As ConvexHull statement.
Example
The following program selects New York from the States file, then creates a ConvexHull surrounding
the selection.
Dim Resulting_object as object
select * from States
where State_Name = "New York"
Resulting_object = ConvexHull(selection.obj)
Insert Into States(obj) Values (Resulting_object)
See Also:
Create Object statement
CoordSys clause
Purpose
Specifies a coordinate system.
Syntax 1
CoordSys Earth
[ Projection type, datum, unitname
[ , origin_longitude ] [ , origin_latitude ]
[ , standard_parallel_1 [ , standard_parallel_2 ] ]
[ , azimuth ] [ , scale_factor ]
[ , false_easting ] [ , false_northing ]
[ , range ] ]
[ Affine Units unitname, A, B, C, D, E, F ]
[ Bounds ( minx, miny ) ( maxx, maxy ) ]
Syntax 2
CoordSys Nonearth
[ Affine Units unitname, A, B, C, D, E, F ]
Units unitname
[ Bounds ( minx, miny ) ( maxx, maxy ) ]
Syntax 3
CoordSys Layout Units paperunitname
Syntax 4
CoordSys Table tablename
Reference Guide
163
CoordSys clause
Syntax 5
CoordSys Window window_id
type is a positive integer value representing which coordinate system to use.
datum is a positive integer value identifying which datum to reference.
unitname is a string representing a distance unit of measure (for example, “m” for meters); for a list
of unit names, see Set Distance Units statement on page 592.
origin_longitude is a float longitude value, in degrees.
origin_latitude is a float latitude value, in degrees.
standard_parallel_1 and standard_parallel_2 are float latitude values, in degrees.
azimuth is a float angle measurement, in degrees.
scale_factor is a float scale factor.
range is a float value from 1 to 180, dictating how much of the Earth will be seen.
minx is a float specifying the minimum x value.
miny is a float specifying the minimum y value.
maxx is a float specifying the maximum x value.
maxy is a float specifying the maximum y value.
paperunitname is a string representing a paper unit of measure (for example, “in” for inches); for a
list of unit names, see Set Paper Units statement on page 628.
tablename is the name of an open table.
window_id is an integer window identifier corresponding to a Map or Layout window.
A performs scaling or stretching along the X axis.
B performs rotation or skewing along the X axis.
C performs shifting along the X axis.
D performs scaling or stretching along the Y axis.
E performs rotation or skewing along the Y axis.
F performs shifting along the Y axis.
Description
The CoordSys clause specifies a coordinate system, and, optionally, specifies a map projection to
use in conjunction with the coordinate system. Note that CoordSys is a clause, not a complete
MapBasic statement. Various statements may include the CoordSys clause; for example, a Set
Map statement can include a CoordSys clause, in which case the Set Map statement will reset the
map projection used by the corresponding Map window.
Use syntax 1 to explicitly define a coordinate system for an Earth map (a map having coordinates
which are specified with respect to a location on the surface of the Earth). The optional Projection
parameters dictate what map projection, if any, should be used in conjunction with the coordinate
164
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
system. If the Projection clause is omitted, MapBasic uses datum 0. The Affine clause describes
the affine transformation for producing the derived coordinate system. If the Projection clause is
omitted, the base coordinate system is Longitude/Latitude. Since the derived coordinates may be in
different units than the base coordinates, the Affine clause requires you to specify the derived
coordinate units.
Use syntax 2 to explicitly define a non-Earth coordinate system, such as the coordinate system used
in a floor plan or other CAD drawing. In the CoordSys Non-Earth case, the base coordinate system
is an arbitrary Cartesian grid. The Units clause specifies the base coordinate units, and the Affine
clause specifies the derived coordinate units.
Use syntax 3 (CoordSys Layout) to define a coordinate system which represents a MapInfo
Professional Layout window. A MapBasic program must issue a Set CoordSys Layout statement
before querying, creating or otherwise manipulating Layout objects. The unitname parameter is the
name of a paper unit, such as “in” for inches or “cm” for centimeters. The following Set CoordSys
statement assigns a Layout window's coordinate system, using inches as the unit of measure:
Set CoordSys Layout Units "in"
Use syntax 4 (CoordSys Table) to refer to the coordinate system in which a table has been saved.
Use syntax 5 (CoordSys Window) to refer to the coordinate system already in use in a window.
When a CoordSys clause appears as part of a Set Map statement or Set Digitizer statement, the
Bounds subclause is ignored. The Bounds subclause is required for non-Earth maps when the
CoordSys clause appears in any other statement, but only for non-Earth maps.
Versions of MapInfo Professional prior to MapInfo Professional 4.1.2 do not recognize the affine
transformation constants in the CoordSys clause, Mapinfow.prj, or any MAP file. If a MAP file is
created using an affine transformation, older versions of MapInfo Professional will use the base
coordinate system instead of the derived coordinate system.
The Bounds clause defines the map's limits; objects may not be created outside of those limits.
When specifying an Earth coordinate system, you may omit the Bounds clause, in which case
MapInfo Professional uses default bounds that encompass the entire Earth.
Note: In a Create Map statement, you can increase the precision of the coordinates in the map by
specifying narrower Bounds.
Every map projection is defined as an equation; and since the different projection equations have
different sets of parameters, different CoordSys clauses may have varying numbers of parameters
in the optional Projection clause. For example, the formula for a Robinson projection uses the
datum, unitname, and origin_latitude parameters, while the formula for a Transverse Mercator
projection uses the datum, unitname, origin_longitude, origin_latitude, scale_factor, false_easting,
and false_northing parameters.
For more information on projections and coordinate systems, see the MapInfo Professional
documentation.
Each MapBasic application has its own CoordSys setting that specifies the coordinate system used
by the application. If a MapBasic application issues a Set CoordSys statement, other MapBasic
applications which are also in use will not be affected.
Reference Guide
165
CoordSys clause
Examples
The Set Map statement controls the settings of an existing Map window. The Set Map statement
below tells MapInfo Professional to display the Map window using the Robinson projection:
Set Map CoordSys Earth Projection 12, 12, "m", 0.
The first 12 specifies the Robinson projection; the second 12 specifies the Sphere datum; the “m”
specifies that the coordinate system should use meters; and the final zero specifies that the origin of
the map should be at zero degrees longitude.
The following statement tells MapInfo Professional to display the Map window without any
projection.
Set Map CoordSys Earth
The following example opens the table World, then uses a Commit Table statement to save a copy
of World under the name RWorld. The new RWorld table will be saved with the Robinson projection.
Open Table "world" As World
Table world As "RWORLD.TAB"
CoordSys Earth Projection 12, 12, "m", 0.
The following example sets one Map window's projection to match the projection of another Map
window. This example assumes that two integer variables (first_map_id and second_map_id)
already contain the window IDs of the two Map windows.
Set Map
Window second_map_winid
CoordSys Window first_map_winid
The following example defines a coordinate system called DCS that is derived from UTM Zone 10
coordinate system using the affine transformation.
x1 = 1.57x - 0.21y + 84120.5
y1 = 0.19x + 2.81y - 20318.0
In this transformation, (x1, y1) represents the DCS derived coordinates, and (x, y) represents the
UTM Zone 10 base coordinates. If the DCS coordinates are measured in feet, the CoordSys clause
for DCS would be as follows:
CoordSys Earth
Projection 8, 74, "m", -123, 0, 0.9996, 500000, 0
Affine Units "ft", 1.57, -0.21, 84120.5, 0.19, 2.81, -20318.0
See Also
Commit Table statement, Set CoordSys statement, Set Map statement
166
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
CoordSysName$() function
Purpose
Returns coordinate system name string from MapBasic Coordinate system clause.
Syntax
CoordSysName$ ( string )
Return Value
String
Example
Note CoordSysName$("Coordsys Earth Projection 1, 62")
Returns this string in the MapInfo dialog box:
Longitude / Latitude (NAD 27 for Continental US)
Note: If a coordinate system name does not exist in the MapInfow.prj file, such as when the map is
in NonEarth system in Survey Feet, then function will return an empty string.
Note CoordSysName$("CoordSys NonEarth Units " + """survey ft""" +
"Bounds (0, 0) (10, 10)")
If an invalid CoordSys clause is passed such as this (using invalid units):
Note CoordSysName$("CoordSys Earth Projection 3, 74, " + """foo""" +
"-90, 42, 42.7333333333, 44.0666666667, 1968500, 0")
Then an Error regarding the Invalid Coordinate System should be returned (Error #727).
Invalid Coordinate System: CoordSys Earth Projection <content>
Cos( ) function
Purpose
Returns the cosine of a number.
Syntax
Cos( num_expr )
num_expr is a numeric expression representing an angle in radians.
Return Value
Float
Reference Guide
167
Create Arc statement
Description
The Cos( ) function returns the cosine of the numeric num_expr value, which represents an angle in
radians. The result returned from Cos( ) will be between one and negative one.
To convert a degree value to radians, multiply that value by DEG_2_RAD. To convert a radian value
into degrees, multiply that value by RAD_2_DEG. (Note that your program will need to Include
“MAPBASIC.DEF” in order to reference DEG_2_RAD or RAD_2_DEG).
Example
Include "MAPBASIC.DEF"
Dim x, y As Float
x = 60 * DEG_2_RAD
y = Cos(x)
' y will now be equal to 0.5
' since the cosine of 60 degrees is 0.5
See Also
Acos( ) function, Asin( ) function, Atn( ) function, Sin( ) function, Tan( ) function
Create Arc statement
Purpose
Creates an arc object.
Syntax
Create Arc
[ Into { Window window_id | Variable var_name } ]
( x1, y1 ) ( x2, y2 )
start_angle end_angle
[ Pen... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x1, y1 specifies one corner of the minimum bounding rectangle (MBR) of an ellipse; the arc
produced will be a section of this ellipse.
x2, y2 specifies the opposite corner of the ellipse's MBR.
start_angle specifies the arc's starting angle, in degrees.
end_angle specifies the arc's ending angle, in degrees.
The Pen clause specifies a line style.
168
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Create Arc statement creates an arc object.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If the Into
clause is not provided, MapBasic will attempt to store the object in the topmost window; if objects
may not be stored in the topmost window (for example, if the topmost window is a grapher) no object
will be created.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, use the Set
Paper Units statement. Before creating objects on a Layout window, you must issue a Set
CoordSys Layout statement.
The optional Pen clause specifies a line style; see Pen clause on page 461 for more details. If no
Pen clause is specified, the Create Arc statement uses the current MapInfo Professional line style
(the style which appears in the Options > Line Style dialog box).
See Also
Insert statement, Pen clause, Update statement, Set CoordSys statement
Create ButtonPad statement
Purpose
Creates a ButtonPad (toolbar).
Syntax
Create ButtonPad { title_string | ID pad_num } As
button_definition [ button_definition ... ]
[ Title title_string ]
[ Width w ]
[ Position ( x, y ) [ Units unit_name ] ]
[ ToolbarPosition ( row, column ) ]
[ { Show | Hide } ]
[ { Fixed | Float } ]
title_string is the ButtonPad title (for example, “Drawing”).
pad_num is the ID number for the standard toolbar you want to re-define:
•
•
•
1 for Main
2 for Drawing
3 for Tools
Reference Guide
169
Create ButtonPad statement
•
•
4 for Standard
5 for ODBC
w is the pad width, in terms of the number of buttons across.
x, y specify the pad's position when it is floating; specified in paper units (for example, inches).
unit_name is a string representing paper units name (for example, “in” for inches, “cm” for
centimeters).
row, column specify the pad's position when it is docked as a toolbar (for example, 0, 0 places the
pad at the left edge of the top row of toolbars, and 0, 1 represents the second pad on the top row).
Each button_definition clause can consist of the keyword Separator, or it can have the following
syntax:
{ PushButton | ToggleButton | ToolButton }
Calling { procedure | menu_code | OLE methodname | DDE server, topic }
[ ID button_id ]
[ Icon n [ File file_spec ] ]
[ Cursor n [ File file_spec ] ]
[ DrawMode dm_code ]
[ HelpMsg msg ]
[ ModifierKeys { On | Off } ]
[ Enable ] [ Disable ]
[ Check ] [ Uncheck ]
procedure is the handler procedure to call when a button is used.
menu_code is a standard MapInfo Professional menu code from MENU.DEF (for example,
M_FILE_OPEN); MapInfo Professional runs the menu command when the user uses the button.
methodname is a string specifying an OLE method name.
server, topic are strings specifying a DDE server and topic name.
ID button_id specifies a unique button number. This number can be used as a parameter to allow a
handler to determine which button is in use (in situations where different buttons call the same
handler) or as a parameter to be used with the Alter Button statement.
Icon n specifies the icon to appear on the button; n can be one of the standard MapInfo icon codes
listed in ICONS.DEF (for example, MI_ICON_RULER). If the File sub-clause specifies the name of a
file containing icon resources, n is an integer resource ID identifying a resource in the file.
Cursor n specifies the shape the mouse cursor should adopt whenever the user chooses a
ToolButton tool; n is a cursor code (for example, MI_CURSOR_ARROW) from ICONS.DEF. This
clause applies only to ToolButtons. If the File sub-clause specifies the name of a file containing icon
resources, n is an integer resource ID identifying a resource in the file.
DrawMode dm_code specifies whether the user can click and drag, or only click with the tool;
dm_code is a code (for example, DM_CUSTOM_LINE) from ICONS.DEF. The DrawMode clause
applies only to ToolButtons.
HelpMsg msg specifies the button's status bar help and, optionally, ToolTip help. The first part of the
msg string is the status bar help message. If the msg string includes the letters \n then the text
following the \n is used as the button's ToolTip help.
170
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
ModifierKeys clause controls whether the shift and control keys affect “rubber-band” drawing if the
user drags the mouse while using a ToolButton. Default is Off, meaning that the shift and control
keys have no effect.
Description
Use the Create ButtonPad statement to create a custom ButtonPad. Once you have created a
custom ButtonPad, you can modify it using Alter Button statement and Alter ButtonPad
statement.
Each toolbar can be hidden. To create a toolbar in the hidden state, include the Hide keyword. Each
toolbar can be floating or fixed to the top of the screen (“docked”). A floating toolbar resembles a
window, such as the Info tool window. To create a fixed toolbar, include the keyword Fixed. To create
a floating toolbar, include the keyword Float. When a toolbar is floating, its position is controlled by
the Position clause; when it is docked, its position is controlled by the ToolbarPosition clause.
For more information on ButtonPads, see the MapBasic User Guide. For additional information
about the capabilities of ToolButtons, see Alter ButtonPad statement on page 75.
Calling Clause Options
The Calling clause specifies what should happen when the user acts on the custom button. The
following table describes the available syntax.
Calling clause example
Description
Calling M_FILE_NEW
If Calling is followed by a numeric code from
MENU.DEF, the event runs a standard MapInfo
Professional menu command (the File > New command,
in this example).
Calling my_procedure
If you specify a procedure name, the event calls the
procedure. The procedure must be part of the same
MapBasic program.
Calling OLE "methodname"
Makes a method call to the OLE Automation object set
by MapInfo Professional's SetCallback method. See the
MapBasic User Guide.
Calling DDE "server","topic"
Connects through DDE to “server|topic” and sending an
Execute message to the DDE server.
In the last two cases, the string sent to OLE or DDE starts with the three letters “MI:” so that the
server can detect that the message came from MapInfo. The remainder of the string contains a
comma-separated list of the values returned from the function calls CommandInfo(1) through
CommandInfo(8). For complete details on the string syntax, see the MapBasic User Guide.
Reference Guide
171
Create ButtonPads As Default statement
Example
Create ButtonPad "Utils" As
PushButton
HelpMsg "Choose this button to display query dialog"
Calling button_sub_proc
Icon MI_ICON_ZOOM_QUESTION
ToolButton
HelpMsg "Use this tool to draw a new route"
Calling tool_sub_proc
Icon MI_ICON_CROSSHAIR
DrawMode DM_CUSTOM_LINE
ToggleButton
HelpMsg "Turn proximity checking on/off"
Calling toggle_prox_check
Icon MI_ICON_RULER
Check
Title "Utilities"
Width 3
Show
See Also
Alter Button statement, Alter ButtonPad statement
Create ButtonPads As Default statement
Purpose
Restores standard ButtonPads (for example, the Main ButtonPad) to their default state.
Syntax
Create ButtonPads As Default
Description
This statement destroys any custom ButtonPads and returns MapInfo Professional's standard
ButtonPads (Main, Drawing, and Tools) to their default states.
Use this statement with caution. The Create ButtonPads As Default statement destroys all custom
buttons, even buttons defined by other MapBasic applications.
See Also
Alter Button statement, Alter ButtonPad statement, Create ButtonPad statement
172
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Create Cartographic Legend statement
Purpose
Creates and displays cartographic style legends as well as theme legends for an active map
window.
Syntax
Create Cartographic Legend
[ From Window map_window_id ]
[ Behind ]
[ Position ( x, y ) [ Units paper_units ] ]
[ Width win_width [ Units paper_units ] ]
[ Height win_height [ Units paper_units ] ]
[ Window Title { legend_window_title }
[ ScrollBars { On | Off } ]
[ Portrait | Landscape | Custom ]
[ Style Size { Small | Large }
[ Default Frame Title { def_frame_title } [ Font... ] } ]
[ Default Frame Subtitle { def_frame_subtitle } [ Font... ] } ]
[ Default Frame Style { def_frame_style } [ Font... ] } ]
[ Default Frame Border Pen [ [ pen_expr ]
Frame From Layer { map_layer_id | map_layer_name
[ Using
[ Column { column | Object } [ FromMapCatalog { On | Off }]]
[ Label { expression | Default } ]
[ Position ( x, y ) [ Units paper_units ] ]
[ Title { frame_title [ Font... ] }
[ SubTitle { frame_subtitle [ Font... ] } ]
[ Border Pen pen_expr ]
[ Style [ Font...] [ Norefresh ] [ Text { style_name }
{ Line Pen... | Region Pen... Brush...| Symbol Symbol... } |
Collection [ Symbol ... ]
[ Line Pen... ] [ Region Pen... Brush ...] } ]
[ , ... ]
map_window_id is an integer window identifier which you can obtain by calling the FrontWindow( )
function and WindowID( ) function.
x states the desired distance from the top of the workspace to the top edge of the window.
y states the desired distance from the left of the workspace to the left edge of the window.
paper_units is a string representing a paper unit name (for example, “cm” for centimeters).
win_width is the desired width of the window.
win_height is the desired height of the window.
legend_window_title is a string expression representing a title for the window, defaults to “Legend of
xxx” where xxx is the map window title.
Reference Guide
173
Create Cartographic Legend statement
def_frame_title is a string which defines a default frame title. It can include the special character “#”
which will be replaced by the current layer name.
def_frame_subtitle is a string which defines a default frame subtitle. It can include the special
character “#” which will be replaced by the current layer name.
def_frame_style is a string that displays next to each symbol in each frame. The “#” character will be
replaced with the layer name. The % character will be replaced by the text “Line”, “Point, “Region”, as
appropriate for the symbol. For example, “% of #” will expand to “Region of States” for the
states.tab layer.
pen_expr is a Pen expression, for example, MakePen( width, pattern, color ). If a default border pen
is defined, then it will be become the default for the frame. If a border pen clause exists at the frame
level, then it is used instead of the default.
map_layer_id or map_layer_name identifies a map layer; can be a SmallInt (for example, use 1 to
specify the top map layer other than Cosmetic) or a string representing the name of a table
displayed in the map. For a theme layer you must specify the map_layer_id.
frame_title is a string which defines a frame title. If a Title clause is defined here for a frame, then it
will be used instead of the def_frame_title.
frame_subtitle is a string which defines a frame subtitle. If a Subtitle clause is defined here for a
frame, then it will be used instead of the def_frame_subtitle.
column is an attribute column name from the frame layer's table.
style_name is a string which displays next to a symbol, line, or region in a custom frame.
Description
The Create Cartographic Legend statement allows you to create and display cartographic style
legends as well as theme legends for an active map window. Each cartographic and thematic styles
legend will be connected to one, and only one, Map window so that there can be more than one
Legend window open at a time.
You can create a frame for each cartographic or thematic map layer you want to include on the
legend. The cartographic and thematic frames will include a legend title and subtitle. Cartographic
frames display a map layer's styles; legend frames display the colors, symbols, and sizes
represented by the theme. You can create frames that have styles based on the Map window's style
or you can create your own custom frames.
At least one Frame clause is required.
All clauses pertaining to the entire legend (scrollbars, width, etc.) must proceed the first Frame
clause.
The From Layer clause must be the first clause after the Frame clause.
The optional Behind clause places the legend behind the Thematic Map window.
The optional Position clause controls the window's position on MapInfo Professional's workspace.
The upper left corner of MapInfo Professional's workspace has the position 0, 0. The optional Width
and Height clauses control the window's size. Window position and size values use paper units
settings, such as “in” (inches) or “cm” (centimeters). MapBasic has a current paper units setting,
174
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
which defaults to inches; a MapBasic program can change this setting through the Set Paper Units
statement. A Create Cartographic Legend statement can override the current paper units by
including the optional Units subclause within the Position, Width, and/or Height clauses.
Use the ScrollBars clause to show or hide scroll-bars on a Map window.
Portrait or Landscape describes the orientation of the legend frames in the window. Portrait results
in an orientation that is down and across. Landscape results in an orientation that is across and
down.
If Custom is specified, you can specify a custom Position clause for a frame.
The Position clause at the frame level specifies the position of a frame if Custom is specified.
The optional Style Size clause controls the size of the samples that appear in legend windows. If
you specify Style Size Small, small-sized legend samples are used in Legend windows. If you
specify Style Size Large, larger-sized legend samples are used.
The Position, Title, SubTitle, Border Pen, and Style clauses at the frame level are used only for
map layers. They are not used for thematic layers. For a thematic layer, this information is gotten
automatically from the theme.
The Font clause specifies a text style. If a default frame title, subtitle, or style name font is defined,
then it will become the default for the frame. If a frame level Title, Subtitle, or Style clause exists
and includes a Font clause, then the frame level font is used. If no font is specified at any level, then
the current text style is used and the point sizes are 10, 9, and 8 for title, subtitle and style name.
The Style clause and the NoRefresh keyword allow you to create custom frames that are not
overwritten when the legend is refreshed. If the NoRefresh keyword is used in the Style clause,
then the table is not scanned for styles. Instead, the Style clause must contain your custom list of
definitions for the styles displayed in the frame. This is done with the Text clause and appropriate
Line, Region, or Symbol clause. Multipoint objects are treated as Point objects.
Collection objects are treated separately. When MapInfo Professional creates a Legend based on
object types, it draws Point symbols first, then Lines, then Regions. Collection objects are drawn
last. Inside collection objects the order of drawing is point, line, and then region samples.
If Column is defined, column is the name of an attribute column in the frame layer's table, or Object
denotes the object column (meaning that legend styles are based on the unique styles in the map
file). The default is Object.
FromMapCatalog ON retrieves styles from the MapCatalog for a live access table. If the table is not
a live access table, MapBasic reverts to the default behavior for a non-live access table instead of
throwing an error. The default behavior for a non-access table is FromMapCatalog Off (i.e., map
styles).
FromMapCatalog OFF retrieves the unique map styles for the live table from the server. This table
must be a live access table that supports per record styles for this to occur. If the live table does not
support per record styles than the behavior is to revert to the default behavior for live tables, which is
to get the default styles from the MapCatalog (FromMapCatalog ON).
If a Label is defined, specify expression as a valid expression, or Default (meaning that the default
frame style pattern is used when creating each style's text, unless the style clause contains text).
The default is Default.
Reference Guide
175
CreateCircle( ) function
Initially, each frame layer's TAB file is searched for metadata values for the title, subtitle, column and
label. If no metadata value exists for the column, the default is Object. If no metadata value exists
for Label, the default is the default frame style pattern. If legend metadata keys exist and you want to
override them, you must use the corresponding MapBasic syntax.
Example
The following example shows how to create a frame for a Map window's cartographic legend.
Legend windows are a special case: To create a frame for a Legend window, you must use the Title
clause instead of the From Window clause.
Dim i_layout_id, i_map_id As Integer
Dim s_title As String
' here, you would store the Map window's ID in i_map_id,
' and store the Layout window's ID in i_layout_id.
' To obtain an ID, call FrontWindow( ) or WindowID( ).
s_title = "Legend of " + WindowInfo(i_map_id, WIN_INFO_NAME)
Set CoordSys Layout Units "in"
Create Frame
Into Window i_layout_id
(1,2) (4, 5)
Title s_title
This creates a frame for a Cartographic Legend window. To create a frame for a Thematic Legend
window, change the title to the following.
S_title="Theme Legend of " + WindowInfo (I_map_id, WW_INFO_NAME)
See Also
Set Cartographic Legend statement, Alter Cartographic Frame statement, Add Cartographic
Frame statement, Remove Cartographic Frame statement, Create Legend statement, Set
Window statement, WindowInfo( ) function
CreateCircle( ) function
Purpose
Returns an Object value representing a circle.
Syntax
CreateCircle( x, y, radius )
x is a float value, indicating the x-position (for example, Longitude) of the circle's center.
y is a float value, indicating the y-position (for example, Latitude) of the circle's center.
radius is a float value, indicating the circle radius.
Return Value
Object
176
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The CreateCircle( ) function returns an Object value representing a circle.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system.
Note: MapBasic's coordinate system is independent of the coordinate system of any Map window.
The radius parameter specifies the circle radius, in whatever distance unit MapBasic is currently
using. By default, MapBasic uses miles as the distance unit, although the Set Distance Units
statement can re-configure MapBasic to use a different distance unit.
The circle uses whatever Brush style is currently selected. To create a circle object with a specific
Brush, you can issue a Set Style statement before calling CreateCircle( ). Alternately, instead of
calling CreateCircle( ), you can issue a Create Ellipse statement, which has optional Pen and
Brush clauses.
The circle object created through the CreateCircle( ) function could be assigned to an Object
variable, stored in an existing row of a table (through the Update statement), or inserted into a new
row of a table (using an Insert statement).
Note: Before creating objects on a Layout window, you must issue a Set CoordSys Layout
statement.
Error Conditions
ERR_FCN_ARG_RANGE is generated if an argument is outside of the valid range.
Examples
The following example uses the Insert statement to insert a new row into the table Sites. The
CreateCircle( ) function is used within the body of the Insert statement to specify the graphic object
that is attached to the new row.
Open Table "sites"
Insert Into sites (obj)
Values ( CreateCircle(-72.5, 42.4, 20) )
The following example assumes that the table Towers has three columns: Xcoord, Ycoord, and
Radius. The Xcoord column contains longitude values, the Ycoord column contains latitude values,
and the Radius column contains radius values. Each row in the table describes a radio broadcast
tower, and the Radius column indicates each tower's broadcast area.
The Update statement uses the CreateCircle( ) function to build a circle object for each row in the
table. Following this Update statement, each row in the Towers table will have a circle object
attached. Each circle object will have a radius derived from the Radius column, and each circle will
be centered at the position indicated by the Xcoord and Ycoord columns.
Open Table "towers"
Update towers
Set obj = CreateCircle(xcoord, ycoord, radius)
Reference Guide
177
Create Collection statement
See Also
Create Ellipse statement, Insert statement, Update statement
Create Collection statement
Purpose
Combines points, linear objects, and closed objects into a single object. The collection object
displays in the Browser as a single record.
Syntax
Create Collection [ num_parts ]
[ Into { Window window_id | Variable var_name } ]
Multipoint
[ num_points ]
( x1, y1 ) ( x2, y2 ) [ ... ]
[ Symbol... ]
Region
num_polygons
[ num_points1 ( x1, y1 ) ( x2, y2 ) [ ... ] ]
[ num_points2 ( x1, y1 ) ( x2, y2 ) [ ... ] ... ]
[ Pen... ]
[ Brush... ]
[ Center ( center_x, center_y ) ]
Pline
[ Multiple num_sections ]
num_points
( x1, y1 ) ( x2, y2 ) [ ... ]
[ Pen... ]
[ Smooth... ]
num_parts is the number of non-empty parts inside a collection. This number is from 0 to 3 and is
optional for MapBasic code (it is mandatory for MIF files).
num_polygons is the number of polygons inside the Collection object.
num_sections specifies how many sections the multi-section polyline will contain.
Example
create collection multipoint 2 (0,0) (1,1) region 3 3 (1,1) (2,2) (3,4) 4
(11,11) (12,12) (13,14) (19,20) 3 (21,21) (22,22) (23,24) pline 3 (-1,1)
(3,-2) (4,3)
dim a as object
create collection into variable a multipoint 2 (0,0) (1,1) region 1 3
(1,1) (2,2) (3,4) pline 3 (-1,1) (3,-2) (4,3)
insert into test (obj) values (a)
create collection region 2 4 (-5,-5) (5,-5) (5,5) (-5,5) 4 (-3,-3) (3,-3)
(3,3) (-3,3) pline multiple 2 2 (-6,-6) (6,6) 2 (-6,6) (6,-6) multipoint 6
(2,2) (-2,-2) (2,-2) (-2,2) (4,1) (-1,-4)
178
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Create MultiPoint statement
Create Cutter statement
Purpose
Produces a Region object that can be used as a cutter for an Object Split operation, as well as a new
set of Target objects which may be a subset of the original set of Target objects. You need to provide
a set of Target objects, and a set of polylines as a selection object.
Syntax
Create Cutter Into Target
Description
Before using Create Cutter, one or more Polyline objects must be selected, and an editable target
must exist. This is set by choosing Objects > Set Target, or using the Set Target statement. The
Polyline objects contained in the selection must represent a single, contiguous section. The Polyline
selection must contain no breaks or self intersections.
The Polyline must intersect the Minimum Bounding Rectangle (MBR) of the Target in order for the
Target to be a valid object to split. The Polyline, however, does not have to intersect the Target
object itself. For example, the Target object could be a series of islands (for example, Hawaii), and
the Polyline could be used to divide the islands into two sets without actually intersecting any of the
islands. If the MBR of a Target does not intersect the Polyline, then that Target will be removed from
the Target list.
Given this revised set of Target objects, a cumulative MBR of all of these objects is calculated and
represents the overall space to be split. The polyline is then extended, if necessary, so that it covers
the MBR. This is done by taking the direction of the last two points on each end of the polyline and
extending the polyline in that Cartesian direction until it intersects with the MBR. The extended
Polyline should divide the Target space into two portions. One Region object will be created and
returned which represents one of these two portions.
This statement returns the revised set of Target objects (still set as the Target), as well as this new
Region cutter object. This Region object will be inserted into the Target table (which must be an
editable table). The original Polyline object(s) will remain, but will no longer be selected. The new
Region object will now be the selected object. If the resulting Region object is suitable, then this
operation can be immediately followed by an Object Split operation, as appropriate Target objects
are set, and a suitable Region cutter object is selected.
Note: The cutter object still remains in the target layer. You will have to delete the cutter object
manually from your editable layer.
Reference Guide
179
Create Ellipse statement
Example
Open Table "C:\MapInfo_data\TUT_USA\USA\STATES.TAB"
Open Table "C:\MapInfo_data\TUT_USA\USA\US_HIWAY.TAB"
Map from States, Us_hiway
select * from States where state = "NY"
Set target On
select * from Us_hiway where highway = "I 90"
Create Cutter Into Target
Objects Split Into Target
See Also
Set Target statement
Create Ellipse statement
Purpose
Creates an ellipse or circle object.
Syntax
Create Ellipse
[ Into { Window window_id | Variable var_name } ]
( x1, y1 ) ( x2, y2 )
[ Pen... ]
[ Brush... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x1, y1 specifies one corner of the rectangle which the ellipse will fill.
x2, y2 specifies the opposite corner of the rectangle.
The Pen clause specifies a line style.
The Brush clause specifies a fill style.
Description
The Create Ellipse statement creates an ellipse or circle object. If the object's Minimum Bounding
Rectangle (MBR) is defined in such a way that the x-radius equals the y-radius, the object will be a
circle; otherwise, the object will be an ellipse.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If the Into
clause is not provided, MapBasic attempts to store the object in the topmost window; if objects may
not be stored in the topmost window (for example, if the topmost window is a grapher) no object will
be created.
180
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Lat6itiude/Longitude coordinate system, although the Set CoordSys statement
can re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, use the Set
Paper Units statement. Before creating objects on a Layout window, you must issue a Set
CoordSys Layout statement.
The optional Pen clause specifies a line style; see Pen clause on page 461 for more details. If no
Pen clause is specified, the Create Ellipse statement uses the current MapInfo Professional line
style (the style which appears in the Options > Line Style dialog box). Similarly, the optional Brush
clause specifies a fill style; see Brush clause on page 109 for more details.
See Also
Brush clause, CreateCircle( ) function, Insert statement, Pen clause, Update statement
Create Frame statement
Purpose
Creates a new frame in a Layout window.
Syntax
Create Frame
[ Into { Window layout_win_id | Variable var_name } ]
( x1, y1 ) ( x2, y2 )
[ Pen... ]
[ Brush... ]
[ Title title ]
[ From Window contents_win_id ]
[ FillFrame { On | Off } ]
x1, y1 specifies one corner of the new frame to create.
x2, y2 specifies the other corner.
layout_win_id is a Layout window's integer window identifier.
var_name is the name of an Object variable.
The Pen clause specifies a line style.
The Brush clause specifies a fill style.
title is a string identifying the frame contents (for example, “WORLD Map”); not needed if the From
Window clause is used.
contents_win_id is an integer window ID indicating which window will appear in the frame.
Reference Guide
181
Create Frame statement
Description
The Create Frame statement creates a new frame within an existing Layout window. If no
layout_win_id is specified, the new frame is added to the topmost Layout window. Before creating
objects on a Layout window, you must issue a Set CoordSys Layout statement.
Between sessions, MapInfo Professional preserves Layout window settings by storing Create
Frame statements in the workspace file. To see an example of the Create Frame statement, create
a Layout, save the workspace, and examine the workspace file in a text editor.
The Pen clause dictates what line style will be used to display the frame, and the Brush clause
dictates the fill style used to fill the frame window.
Use the From Window clause to specify which window should appear inside the frame. For
example, to make a Map window appear inside the frame, specify From Window i_map (where
i_map is an integer variable containing the Map's window identifier). A window must already be open
before you can create a frame containing the window.
The Title clause provides an alternate syntax for specifying which window appears in the frame. For
example, to identify a Map window which displays the table WORLD, the Title clause should read
Title "WORLD Map". If the title string does not refer to an existing window, or if title is an empty
string (""), the frame will be empty. If you specify both the Title clause and the From Window
clause, the latter clause takes effect.
The FillFrame clause controls how the window fills the frame. If you specify FillFrame On, the
entire frame is filled with an image of the window. (This is analogous to checking the Fill Frame
With Contents check box in MapInfo Professional's Frame Object dialog box, which appears if you
double-click a frame.) If you specify FillFrame Off (or if you omit the FillFrame clause entirely), the
aspect ratio of the window affects the appearance of the frame; in other words, re-sizing a Map
window to be tall and thin causes the frame to appear tall and thin.
Example
The following examples show how to create a frame for a Map window's thematic legend, or
Cartographic Legend window.
Theme Legend windows are a special case. To create a frame for a Theme Legend window, you
must use the Title clause instead of the From Window clause.
Dim i_layout_id, i_map_id As Integer
Dim s_title As String
' here, you would store the Map window's ID in i_map_id,
' and store the Layout window's ID in i_layout_id.
' To obtain an ID, call FrontWindow( ) or WindowID( ).
s_title = "Theme Legend of " + WindowInfo(i_map_id, WIN_INFO_NAME)
Set CoordSys Layout Units "in"
Create Frame
Into Window i_layout_id
(1,2) (4, 5)
Title s_title
182
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
To create a frame for a Map window's cartographic legend, you should use the From Window
clause since there may be more than one cartographic legend window per map.
Dim i_cartlgnd_id As Integer
' here, you would store the Cartographic Legend window's ID
' in i_cartlgnd _id,
' To obtain an ID, call FrontWindow( ) or WindowID( ).
Create Frame
Into Window i_layout_id
(1,2) (4, 5)
From Window i_cartlgnd_id
See Also
Brush clause, Insert statement, Layout statement, Pen clause, Set CoordSys statement, Set
Layout statement, Update statement
Create Grid statement
Purpose
Produces a raster grid file, which MapBasic displays as a raster table in a Map window.
Syntax
Create Grid
From tablename
With expression [ Ignore value_to_ignore ]
Into filespec [ Type grid_type ]
[ Coordsys... ]
[ Clipping { Object obj } | { Table tablename } ]
Inflect num_inflections By Percent at
color : inflection_value [ color : inflection_value ...]
[ Round rounding_factor ]
{[ Cell Size cell_size [ Units distance_unit ]] | [ Cell Min n_cells ]}
[ Border numcells ]
Interpolate With interpolator_name Version version_string
Using num_parameters parameter_name : parameter_value
[ parameter_name : parameter_value ... ]
tablename is the “alias” name of an open table from which to get data points.
expression is the expression by which the table will be shaded, such as a column name.
value_to_ignore is a value to be ignored; this is usually zero. No grid theme will be created for a row
if the row's value matches the value to be ignored.
filespec specifies the fully qualified path and name of the new grid file. It will have a .MIG extension.
grid_type is a string expression that specifies the type of grid file to create. By default, .MIG files are
created.
Reference Guide
183
Create Grid statement
Coordsys is an optional CoordSys clause which is the coordinate system that the grid will be
created in. If not provided, the grid will be created in the same coordinate system as the source
table. Refer to CoordSys clause on page 163 for more information.
obj is an object to clip grid cells to. Only the portion of the grid theme within the object will display. If
a grid cell is not within the object, that cell value will not be written out and a null cell is written in its
place.
tablename is the name of a table of region objects which will be combined into a single region object
and then used for clipping grid cells.
num_inflections is a numeric expression, specifying the number of color:inflection_value pairs.
color is a color expression of, part of a color:value inflection pair.
inflection_value is a numeric expression, specifying the value of a color:inflection_value pair.
cell_size is a numeric expression, specifying the size of a grid cell in distance units.
n_cells is a numeric expression that specifies the height or width of the grid in cells.
numcells defines the number of cells to be added around the edge of the original grid bounds.
numcells will be added to the left, right, top, and bottom of the original grid dimensions.
distance_unit is a string expression, specifying the units for the preceding cell size. This is an
optional parameter. If not present, the distance units from the table's coordinate system are used.
interpolator_name is a string expression, specifying the name of the interpolator to use to create the
grid.
version_string is a string expression, specifying the version of the interpolator that the parameters
are meant for.
num_parameters is a numeric expression, specifying the number of interpolator parameter
name:value pairs.
parameter_name is a string expression, specifying the name part of a
parameter_name:parameter_value pair.
parameter_value is a numeric expression, specifying the value part of a
parameter_name:parameter_value pair.
By Percent at specifies that the subsequent color:Inflection_value pairs represent a color value and
percentage value.
Round is a numeric expression, specifying the rounding factor applied to the inflection values.
Description
A grid surface theme is a continuous raster grid produced by an interpolation of point data. The
Create Grid statement takes a data column from a table of points, and passes those points and their
data values to an interpolator. The interpolator produces a raster grid file, which MapBasic displays
as a raster table in a Map window.
The Create Grid statement reads (x, y, z) values from the table specified in the From clause. It gets
the z values by evaluating the expression specified in the With clause with respect to the table.
184
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The dimensions of the grid can be specified in two ways. One is by specifying the size of a grid cell
in distance units, such as miles. The other is by specifying a minimum height or width of the grid in
terms of grid cells. For example, if you wanted the grid to be at least 200 cells wide by 200 cells high,
you would specify “cell min 200". Depending on the aspect ratio of the area covered by the grid, the
actual grid dimensions would not be 200 by 200, but it would be at least that wide and high.
Example
Open Table "C:\States.tab" Interactive
Map From States
Open Table "C:\Us_elev.tab" Interactive
Add Map Auto Layer Us_elev
set map redraw off
Set Map Layer 1 Display Off
set map redraw on
create grid
from Us_elev
with Elevation_FT
into "C:\Us_elev_grid"
clipping table States
inflect 5 at
RGB(0, 0, 255) : 13
RGB(0, 255, 255) : 3632.5
RGB(0, 255, 0) : 7252
RGB(255, 255, 0) : 10871.5
RGB(255, 0, 0) : 14491
cell min 200
interpolate
with "IDW" version "100"
using 4
"EXPONENT": "2"
"MAX POINTS": "25"
"MIN POINTS": "1"
"SEARCH RADIUS": "100"
See Also
Set Map statement
Create Index statement
Purpose
Creates an index for a column in an open table.
Syntax
Create Index On table ( column )
table is the name of an open table.
column is the name of a column in the open table.
Reference Guide
185
Create Legend statement
Description
The Create Index statement creates an index on the specified column. MapInfo Professional uses
Indexes in operations such as Query > Find. Indexes also improve the performance of queries in
general.
Note: MapInfo Professional cannot create an index if the table has unsaved edits. Use the Commit
Table statement to save edits.
Example
The following example creates an index for the “Capital” field of the World table.
Open Table "world" Interactive
Create Index on World(Capital)
See Also
Alter Table statement, Create Table statement, Drop Index statement, Commit Table statement
Create Legend statement
Purpose
Creates a new Theme Legend window tied to the specified Map window.
For MapInfo Professional versions 5.0 and later, the Create Cartographic Legend statement allows
you to create and display cartographic style legends. Refer to the Create Cartographic Legend
statement on page 173 for more information.
Syntax
Create Legend
[ From Window window_ID ]
[ { Show | Hide } ]
window_ID is an integer, representing a MapInfo Professional window ID for a Map window.
Description
This statement creates a special floating, Thematic Legend window, in addition to the standard
MapInfo Professional Legend window. (To open MapInfo Professional's standard Legend window,
use the Open Window Legend statement.)
The Create Legend statement is useful if you want the Legend of a Map window to always be
visible, even when the Map window is not active. Also, this statement is useful in “Integrated
Mapping” applications, where MapInfo Professional windows are integrated into another application,
such as a Visual Basic application. For information about Integrated Mapping, see the MapBasic
User Guide.
If you include the From Window clause, the new Theme Legend window is tied to the window that
you specify; otherwise, the new window is tied to the most recently used Map.
186
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If you include the optional Hide keyword, the window is created in a hidden state. You can then show
the hidden window by using the Set Window…Show statement.
After you issue the Create Legend statement, determine the new window's integer ID by calling
WindowID( 0 ). Use that window ID in subsequent statements (such as the Set Window
statement).
The new Theme Legend window is created according to the parent and style settings that you
specify through the Set Next Document statement.
See Also
Create Cartographic Legend statement, Open Window statement, Set Next Document
statement, Set Window statement
CreateLine( ) function
Purpose
Returns an Object value representing a line.
Syntax
CreateLine( x1, y1, x2, y2 )
x1 is a float value, indicating the x-position (for example,) of the line's starting point.
y1 is a float value, indicating the y-position (for example, Latitude) of the line's starting point.
x2 is a float value, indicating the x-position of the line's ending point.
y2 is a float value, indicating the y-position of the line's ending point.
Return Value
Object
Description
The CreateLine( ) function returns an Object value representing a line. The x and y parameters use
the current coordinate system. By default, MapBasic uses a Longitude/Latitude coordinate system.
Use the Set CoordSys statement to choose a new system.
The line object will use whatever Pen style is currently selected. To create a line object with a
specific Pen style, you could issue the Set Style statement before calling CreateLine( ) or you
could issue a Create Line statement, with an optional Pen clause.
The line object created through the CreateLine( ) function could be assigned to an Object variable,
stored in an existing row of a table (through the Update statement), or inserted into a new row of a
table (through an Insert statement). If you need to create objects on a Layout window, you must first
issue a Set CoordSys Layout statement.
Reference Guide
187
Create Line statement
Example
The following example uses the Insert statement to insert a new row into the table Routes. The
CreateLine( ) function is used within the body of the Insert statement.
Open Table "Routes"
Insert Into routes (obj)
Values (CreateLine(-72.55, 42.431, -72.568, 42.435))
See Also
Create Line statement, Insert statement, Update statement
Create Line statement
Purpose
Creates a line object.
Syntax
Create Line
[ Into { Window window_id | Variable var_name } ]
( x1, y1) ( x2, y2)
[ Pen... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x1, y1 specifies the starting point of a line.
x2, y2 specifies the ending point of the line.
The Pen clause specifies a line style.
Description
The Create Line statement creates a line object.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If the Into
clause is not provided, MapBasic will attempt to store the object in the topmost window; if objects
may not be stored in the topmost window (for example, if the topmost window is a grapher) no object
will be created.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
188
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, use the Set
Paper Units statement.
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
Layout statement.
The optional Pen clause specifies a line style; see Pen clause on page 461 for more details. If no
Pen clause is specified, the Create Line statement will use the current MapInfo Professional line
style.
See Also
CreateLine( ) function, Insert statement, Pen clause, Update statement
Create Map statement
Purpose
Modifies the structure of a table, making the table mappable.
Syntax
Create Map
For table
[ CoordSys... ] Using from_table]
table is the name of an open table.
from_table is the name of an open table from where to copy a coordinate system.
Description
The Create Map statement makes an open table mappable, so that it can be displayed in a Map
window. This statement does not open a new Map window. To open a new Map window, use the
Map statement.
You should not perform a Create Map statement on a table that is already mappable; doing so will
delete all map objects from the table. If a table already has a map attached, and you wish to
permanently change the projection of the map, use a Table As statement. Alternately, if you wish to
temporarily change the projection in which a map is displayed, issue a Set Map statement with a
CoordSys clause. The Create Map statement does not work on linked tables. To make a linked
table mappable, use the Server Create Map statement.
Specifying the Coordinate System
Use one of the following two methods to specify a coordinate system:
•
Provide the name of an already open mappable table as the from_table portion of the Using
clause. In this case, the coordinate system used will be identical to that used in the from_table.
The from_table must be a currently open table, and must be mappable or an error will occur.
Reference Guide
189
Create Map3D statement
•
Explicitly supply the coordinate system information through a CoordSys clause (set in
preferences).If you omit both the CoordSys clause and the Using clause, the table will use the
current MapBasic coordinate system.
Note that the CoordSys clause affects the precision of the map. The CoordSys clause includes a
Bounds clause, which sets limits on the minimum and maximum coordinates that can be stored in
the map. If you omit the Bounds clause, MapInfo Professional uses default bounds that encompass
the entire Earth (in which case, coordinates are precise to one millionth of a degree, or
approximately 4 inches). If you know in advance that the map you are creating is limited to a finite
area (for example, a specific metropolitan area), you can increase the precision of the map's
coordinates by specifying bounds that confine the map to that area. For a complete listing of the
CoordSys syntax, see CoordSys clause on page 163.
See Also
Commit Table statement, CoordSys clause, Create Table statement, Drop Map statement, Map
statement, Server Create Map statement, Set Map statement
Create Map3D statement
Purpose
Creates a 3DMap with the desired parameters.
Syntax
Create Map3D
[ From Window window_id | MapString mapper_creation_string ]
[ Camera [ Pitch angle | Roll angle | Yaw angle | Elevation angle ] |
[ Position ( x, y, z ) | FocalPoint ( x, y, z ) ] |
[ Orientation ( vu_1, vu_2, vu_3, vpn_1, vpn_2, vpn_3,
clip_near, clip_far )]]
[ Light [ Position ( x, y, z ) | Color lightcolor ] ]
[ Resolution ( res_x, res_y ) ]
[ Scale grid_scale ]
[ Background backgroundcolor ]
[ Units unit_name ]
window_id is a window identifier a for a Map window which contains a Grid layer. An error message
is displayed if a Grid layer is not found.
mapper_creation_string specifies a command string that creates the mapper textured on the grid.
Camera specifies the camera position and orientation.
angle is an angle measurement in degrees. The horizontal angle in the dialog box ranges from 0360 degrees and rotates the maps around the center point of the grid. The vertical angle in the
dialog box ranges from 0-90 and measures the rotation in elevation from the start point directly over
the map.
Pitch adjusts the camera's current rotation about the x axis centered at the camera's origin.
Roll adjusts the camera's current rotation about the z axis centered at the camera's origin.
190
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Yaw adjusts the camera's current rotation about the y axis centered at the camera's origin.
Elevation adjusts the current camera's rotation about the x axis centered at the camera's focal
point.
Position indicates the camera/light position.
FocalPoint indicates the camera/light focal point
Orientation specifies the cameras ViewUp (vu_1, vu_2, vu_3), ViewPlane Normal (vpn_1, vpn_2,
vpn_3), and Clipping Range (clip_near, clip_far) (used specifically for persistence of view).
Resolution is the number of samples to take in the x and y directions. These values can increase to
a maximum of the grid resolution. The resolution values can increase to a maximum of the grid x, y
dimension. If the grid is 200x200 then the resolution values will be clamped to a maximum of
200x200. You cannot increase the grid resolution, only specify a subsample value.
grid_scale is the amount to scale the grid in the z direction. A value >1 will exaggerate the topology
in the z direction, a value <1 will scale down the topological features in the z direction.
backgroundcolor is a color to be used to set the background and is specified using the RGB( )
function.
unit_name specifies the units the grid values are in. Do not specify this for unit-less grids (i.e., grids
generated using temperature or density). This option needs to be specified at creation time. You
cannot change them later with the Set Map3D statement or the Properties dialog box.
Description
Once it is created, the 3DMap window is a standalone window. Since it is based on the same tables
as the original Map window, if these tables are changed and the 3DMap window is manually
“refreshed” or re-created from a workspace, these changes are displayed on the grid. The creation
fails if the window_id is not a Map window or if the Map window does not contain a Grid layer. If there
are multiple grids in the Map window, each will be represented in the 3DMap window.
A 3DMap keeps a Mapper creation string as its texture generator. This string will also be prevalent in
the workspace when the 3DMap window is persisted. The initialization will read in the grid layer to
create 3D geometry and topology objects.
Example
Create Map3D Resolution(75,75)
Creates a 3DMap window of the most recent Map window. It will fail if the window does not contain
any Continuous Grid layers. Another example is:
Create Map3D From Window FrontWindow( ) Resolution(100,100) Scale 2
Background RGB(255,0,0) Units "ft".
Creates a 3DMap window with a Red background, the z units set to feet, a Z scale factor of 2, and
the grid resolution set to 100x100.
See Also
Set Map3D statement
Reference Guide
191
Create Menu statement
Create Menu statement
Purpose
Creates a new menu, or redefines an existing menu.
Syntax 1
Create Menu newmenuname [ ID menu_id ] As
menuitem [ ID menu_item_id ] [ HelpMsg help ]
{ Calling handler | As menuname }
[ , menuitem ... ]
Syntax 2
Create Menu newmenuname As Default
newmenuname is a string representing the name of the menu to define or redefine.
menuitem is a string representing the name of an item to include on the new menu.
menu_id is a SmallInt ID number from one to fifteen, identifying a standard menu.
menu_item_id is an integer ID number that identifies a custom menu item.
help is a string that appears on the status bar whenever the menu item is highlighted.
handler is the name of a procedure, or a code for a standard menu command, or a special syntax for
handling the menu event by calling OLE or DDE; see Calling Clause Options on page 171. If you
specify a command code for a standard MapInfo Professional Show/Hide command (such as
M_WINDOW_STATISTICS), the menuitem string must start with an exclamation point and include a
caret (^), to preserve the item's Show/Hide behavior.
menuname is the name of an existing menu to include as a hierarchical submenu.
Description
If the newmenuname parameter matches the name of an existing MapInfo Professional menu (such
as File), the statement re-defines that menu. If the newmenuname parameter does not match the
name of an existing menu, the Create Menu statement defines an entirely new menu. For a list of
the standard MapInfo Professional menu names, see Alter Menu statement on page 85.
The Create Menu statement does not automatically display a newly-created menu; a new menu will
only display as a result of a subsequent Alter Menu Bar statement or Create Menu Bar
statement. However, if a Create Menu statement modifies an existing menu, and if that existing
menu is already part of the menu bar, the change will be visible immediately.
Note: MapInfo Professional can maintain no more than 96 menu definitions at one time, including
the menus defined automatically by MapInfo Professional (File, etc.). This limit is
independent of the number of menus displayed on the menu bar at one time.
The menuitem parameter identifies the name of the menu item. The item's name can contain special
control characters to define menu item attributes (for example, whether a menu item is checkable).
See tables below for details.
192
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The following characters require special handling: slash (/), back slash(\), and less than (<). If you
want to display any of these special characters in the menu or the status bar help, you must include
an extra back slash in the menuitem string or the help string. For example, the following statement
creates a menu item that reads, “Client/Server.”
Create Menu "Data" As
"Client\/Server" Calling cs_proc
If a menuitem parameter begins with the character @, the custom menu breaks into two columns.
The item whose name starts with @ is the first item in the second column.
Assigning Handlers to Custom Menu Items
Most menu items include the Calling handler clause; where handler is either the name of a
MapBasic procedure or a numeric code identifying an MapInfo Professional operation (such as
M_FILE_SAVE to specify the File > Save command). If the user chooses a menu item which has a
handler, MapBasic automatically calls the handler (whether the handler is a sub procedure or a
command code). Your program must Include the file MENU.DEF if you plan to refer to menu codes
such as M_FILE_SAVE.
The optional ID clause lets you assign a unique integer ID to each custom menu item. Menu item
IDs are useful if you want to allow multiple menu items to call the same handler procedure. Within
the handler procedure, you can determine which menu item the user chose by calling
CommandInfo(CMD_INFO_MENUITEM). Menu item IDs can also be used by other statements,
such as the Alter Menu Item statement. If a menu item has neither a handler nor a menuname
associated with it, that menu item is inert. Inert menu items are used for cosmetic purposes, such as
displaying horizontal lines which break up a menu.
Creating Hierarchical Menus
To include a hierarchical menu on the new menu, use the As sub-clause instead of the Calling subclause. The As sub-clause must specify the name of the existing menu which should be attached to
the new menu. The following example creates a custom menu containing one conventional menu
item and one hierarchical menu.
Create Menu "Special" As
"Configure" Calling config_sub_proc,
"Objects" As "Objects"
When you add a hierarchical menu to the menu, the name of the hierarchical menu appears on the
parent menu instead of the menuitem string.
Properties of a Menu Item
Menu items can be enabled or disabled; disabled items appear grayed out. Some menu items are
checkable, meaning that the menu can display a check mark next to the item. At any given time, a
checkable menu item is either checked or unchecked.
To set the properties of a menu item, include control codes (from the table below) at the start of the
menuitem parameter.
Reference Guide
193
Create Menu statement
Control code
Effect
(
The menu item is initially disabled. Example: (Close
(-
The menu item is a horizontal separator line; such a menu item cannot have a
handler. Example: (-
($
This special code represents the File menu's most-recently-used (MRU) list. It
may only appear once in the menu system, and it may not be used on a shortcut
menu. To eliminate the MRU list from the File menu, either delete this code from
MAPINFOW.MNU or re-create the File menu by issuing a Create Menu
statement.
(>
This special code represents the Window menu's list of open windows. It may
only appear once in the menu system.
!
Menu item is checkable, but it is initially unchecked.
Example: !Confirm Deletion
! … ^ …
If a caret (^) appears within the text string of a checkable menu item, the item
toggles between alternate text (for example, Show… vs. Hide…) instead of
toggling between checked and unchecked. The text before the caret appears
when the item is “checked.” Example: !Hide Status Bar^Show Status
Bar
!+
Menu item is checkable, and it is initially checked.
Example: !+Confirm Deletions
Defining Keyboard Shortcuts
Menu items can have two different types of keyboard shortcuts, which let the user choose menu
items through the keyboard rather than by clicking with the mouse.
One type of keyboard shortcut lets the user drop down a menu or choose a menu item by pressing
keys. For example, on MapInfo Professional, the user can press Alt-W to show the Window menu,
then press M (or Alt-M) to choose New Map Window. To create this type of keyboard shortcut,
include the ampersand character (&) in the newmenuname or menuitem string (for example, specify
“&Map” as the menuitem parameter in the Create Menu statement). Place the ampersand
immediately before the character to be used as the shortcut.
The other type of keyboard shortcut allows the user to activate an option without going through the
menu at all. If a menu item has a shortcut key sequence of Alt-F5, the user can activate the menu
item by pressing Alt-F5. To create this type of shortcut, use the following key sequences.
Note: The codes in the following tables must appear at the end of a menu item name.
194
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Windows Accelerator Code
/W {letter | %number}
Effect
Defines a Windows shortcut key which can be activated by
pressing the appropriate key.
Examples: Zap /WZ or Zap /W%120
/W# {letter | %number}
Defines a Windows shortcut key which also requires the shift key.
Examples: Zap /W#Z or Zap /W#%120
/W@ {letter | %number}
Defines a Windows shortcut key which also requires the Alt key.
Examples: Zap /W@Z or Zap /W@%120
/W^ {letter | %number}
Defines a Windows shortcut key which also requires the Ctrl key.
Examples: Zap /W^Z or Zap /W^%120
To specify a function key as a Windows accelerator, the accelerator code must include a percent
sign (%) followed by a number. The number 112 corresponds to F1, 113 corresponds to F2, etc.
Note: The Create Menu Bar As Default statement removes and un-defines all custom menus
created through the Create Menu statement. Alternately, if you need to un-define one, but
not all, of the custom menus that your application has added, you can issue a statement of
the form Create Menu menuname As Default.
After altering a standard MapInfo Professional menu (for example, “File”), you can restore the menu
to its original state by issuing a Create Menu menuname As Default statement.
Calling Clause Options
The Calling clause specifies what should happen when the user chooses the custom menu
command. The following table describes the available syntax.
Calling clause example
Description
Calling M_FILE_NEW
If Calling is followed by a numeric code from
MENU.DEF, MapInfo Professional handles the event by
running a standard MapInfo Professional menu
command (the File > New command, in this example).
Calling my_procedure
If you specify a procedure name, MapInfo Professional
handles the event by calling the procedure.
Reference Guide
195
Create Menu statement
Calling clause example
Description
Calling OLE "methodname"
MapInfo Professional handles the event by making a
method call to the OLE Automation object set by the
SetCallback method.
Calling DDE "server","topic"
Windows only. MapInfo Professional handles the event
by connecting through DDE to “server|topic” and sending
an Execute message to the DDE server.
In the last two cases, the string sent to OLE or DDE starts with the three letters “MI:” (so that the
server can detect that the message came from MapInfo Professional). The remainder of the string
contains a comma-separated list of the values returned from relevant CommandInfo( ) function
calls. For complete details on the string syntax, see the MapBasic User Guide.
Examples
The following example uses the Create Menu statement to create a custom menu, then adds the
custom menu to MapInfo Professional's menu bar. This example removes the Window menu (ID 6)
and the Help menu (ID 7), and then adds the custom menu, the Window menu, and the Help menu
back to the menu bar. This technique guarantees that the last two menus will always be Window,
and Help.
Declare Sub Main
Declare Sub addsub
Declare Sub editsub
Declare Sub delsub
Sub Main
Create Menu "DataEntry" As
"Add" Calling addsub,
"Edit" Calling editsub,
"Delete" Calling delsub
Alter Menu Bar Remove ID 6, ID 7
Alter Menu Bar Add "DataEntry", ID 6, ID 7
End Sub
The following example creates an abbreviated version of the File menu. The “(” control character
specifies that the Close, Save, and Print options will be disabled initially. The Open and Save
options have Windows accelerator key sequences (Ctrl+O and Ctrl+S, respectively). Note that both
the Open and Save options use the Chr$(9) function to insert a Tab character into the menu item
name, so that the remaining text is shifted to the right.
196
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Include "MENU.DEF"
Create Menu "File" As
"New" Calling M_FILE_NEW,
"Open" +Chr$(9)+"Ctrl+O/W^O" Calling M_FILE_OPEN,
"(-",
"(Close" Calling M_FILE_CLOSE,
"(Save" +Chr$(9)+"Ctrl+S /W^S" Calling M_FILE_SAVE,
"(-",
"(Print" Calling M_FILE_PRINT,
"(-",
"Exit" Calling M_FILE_EXIT
If you want to prevent the user from having access to MapInfo Professional's shortcut menus, use a
Create Menu statement to re-create the appropriate menu, and define the menu as just a separator
control code: “(-”. The following example uses this technique to disable the Map window's shortcut
menu.
Create Menu "MapperShortcut" As "(-"
See Also
Alter Menu Item statement, Create Menu Bar statement
Create Menu Bar statement
Purpose
Rebuilds the entire menu bar, using the available menus.
Syntax 1
Create Menu Bar As
{ menu_name | ID menu_number }
[ , { menu_name | ID menu_number } ... ]
Syntax 2
Create Menu Bar As Default
menu_name is the name of a standard MapInfo Professional menu, or the name of a custom menu
created through a Create Menu statement.
menu_number is the number associated with a standard MapInfo Professional menu (for example, 1
for the File menu).
Description
A Create Menu Bar statement tells MapInfo Professional which menus should appear on the menu
bar, and in what order. If the statement omits one or more of the standard menu names, the resultant
menu may be shorter than the standard MapInfo Professional menu. Conversely, if the statement
Reference Guide
197
Create Menu Bar statement
includes the names of one or more custom menus (which were created through the Create Menu
statement), the Create Menu Bar statement can create a menu bar that is longer than the standard
MapInfo Professional menu.
Any menu can be identified by its name (for example, “File”), regardless of whether it is a standard
menu or a custom menu. Each of MapInfo Professional's standard menus can also be referred to by
its menu ID; for example, the File menu has an ID of 1.
See Alter Menu Item statement on page 90 for a listing of the names and ID numbers of MapInfo
Professional's menus.
After the menu bar has been customized, the following statement:
Create Menu Bar As Default
restores the standard MapInfo Professional menu bar. Note that the Create Menu Bar As Default
statement removes any custom menu items that may have been added by other MapBasic
applications that may be running at the same time. For the sake of not accidentally disabling other
MapBasic applications, you should exercise caution when using the Create Menu Bar As Default
statement.
Examples
The following example shortens the menu bar so that it includes only the File, Edit, Query, and
window-specific (for example, Map, Browse, etc.) menus.
Create Menu Bar As
"File", "Edit", "Query", "WinSpecific"
Ordinarily, the MapInfo Professional menu bar only displays a Map menu when a Map window is the
active window. Similarly, MapInfo Professional only displays a Browse menu when a Browse window
is the active window. The following example redefines the menu bar so that it always includes both
the Map and Browse menus, even when no windows are on the screen. However, all items on the
Map menu will be disabled (grayed out) whenever the current window is not a Map window, and all
items on the Browse menu will be disabled whenever the current window is not a Browse window.
Create Menu Bar As
"File", "Edit", "Query", "Map", "Browse"
The following example creates a custom menu, called DataEntry, and then redefines the menu bar
so that it includes only the File, Edit, and DataEntry menus.
Declare Sub AddSub
Declare Sub EditSub
Declare Sub DelSub
Create Menu "DataEntry" As
"Add" calling AddSub,
"Edit" calling EditSub,
"Delete" calling DelSub
Create Menu Bar As
"File", "Edit", "DataEntry"
198
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Alter Menu Bar statement, Create Menu statement, Menu Bar statement
Create MultiPoint statement
Purpose
Combines a number of points into a single object. All points have the same symbol. The Multipoint
object displays in the Browser as a single record.
Syntax
Create Multipoint
[ Into { Window window_id | Variable var_name } ]
[ num_points ]
( x1, y1 ) ( x2, y2 ) [ ... ]
[ Symbol... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
num_points is the number of points inside Multipoint object.
x y specifies the location of the point.
The Symbol clause specifies a symbol style.
Note: One symbol is used for all points contained in a Multipoint object.
Currently MapInfo Professional uses the following four different syntaxes to define a symbol used for
points:
Syntax 2 (MapInfo 3.0 Symbol Syntax)
Symbol ( shape, color, size )
shape is an integer, 31 or larger, specifying which character to use from MapInfo Professional's
standard symbol set. MapInfo 3.0 symbols refers to the symbol set that was originally published with
MapInfo for Windows 3.0 and has been maintained in subsequent versions of MapInfo Professional.
To create an invisible symbol, use 31. The standard set of symbols includes symbols 31 through 67,
but the user can customize the symbol set by using the Symbol application.
color is an integer RGB color value; see RGB( ) function on page 501.
size is an integer point size, from 1 to 48.
Syntax 3 (TrueType Font Syntax)
Symbol ( shape, color, size, fontname, fontstyle, rotation )
shape is an integer, 31 or larger, specifying which character to use from a TrueType font. To create
an invisible symbol, use 31.
color is an integer RGB color value; see RGB( ) function.
Reference Guide
199
Create MultiPoint statement
size is an integer point size, from 1 to 48.
fontname is a string representing a TrueType font name (for example, “Wingdings”).
fontstyle is an integer code controlling attributes such as bold.
rotation is a floating-point number representing a rotation angle, in degrees.
Syntax 4 (Custom Bitmap File Syntax)
Symbol ( filename, color, size, customstyle )
filename is a string up to 31 characters long, representing the name of a bitmap file. The file must be
in the CUSTSYMB directory (unless a Reload Symbols statement has been used to specify a
different directory).
color is an integer RGB color value; see RGB( ) function on page 501.
size is an integer point size, from 1 to 48.
customstyle is an integer code controlling color and background attributes. See table below.
Syntax 5
Symbol symbol_expr
symbol_expr is a Symbol expression, which can either be the name of a Symbol variable, or a
function call that returns a Symbol value, for example, the MakeSymbol( ) function.
Example
Create Multipoint 7 (0,0) (1,1) (2,2) (3,4) (-1,1) (3,-2) (4,3)
200
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Create Object statement
Purpose
Creates one or more regions by performing a Buffer, Merge, Intersect, Union, Voronoi, or Isogram
operation.
Syntax 1
Create Object As { Buffer | Union | Intersect | Merge | ConvexHull |
Voronoi }
From fromtable
[ Into { Table intotable | Variable varname } ]
[ Data column = expression [ , column = expression... ] ]
[ Group By { column | RowID } ]
Syntax 2 (Buffer-specific)
Create Object As Buffer
From fromtable
[ Into { Table intotable | Variable varname } ]
[ Width bufferwidth [ Units unitname ]]]
[ Type { Spherical | Cartesian } ] ]
[ Resolution smoothness ]
[ Data column = expression [ , column = expression... ] ]
[ Group By { column | RowID } ]
Syntax 3 (Isogram-specific)
Create Object As Isogram
From fromtable
[ Into { Table intotable } ]
[ Data column = expression [ , column = expression... ] ]
Connection connection_handle
[ Distance dist1 [[ Brush brushclause ] [ Pen penclause ]]
[, dist2 [ Brush brushclause ] [ Pen penclause ]]
[, distN [ Brush brushclause ] [ Pen penclause ] [,...]
Units dist_unit ]
[ Time time1 [[ Brush brushclause ] [ Pen penclause ]]
[, time2 [ Brush brushclause ] [ Pen penclause ]]
[, timeN [ Brush brushclause ] [ Pen penclause ]] [,...]
Units time_unit ]
fromtable is the name of an open table, containing one or more graphic objects.
intotable is the name of an open table where the new object(s) will be stored.
varname is the name of an Object variable where a new object will be stored.
bufferwidth is a number indicating the displacement used in a Buffer operation; if this number is
negative, and if the source object is a closed object, the resulting buffer is smaller than the source
object. If the width is negative, and the object is a linear object (line, polyline, arc) or a point, then the
absolute value of width is used to produce a positive buffer.
Reference Guide
201
Create Object statement
dist_unit is the name of a distance unit (for example, “km” for kilometers).
smoothness is an integer from 2 to 100, indicating the number of segments per circle in a Buffer
operation.
column is the name of a column in the table.
expression is an expression used to populate column.
connection_handle is a number expression returned from the Open Connection statement
referencing the connection to be used.
dist1, dist2, distN are numeric expressions representing distances for the Isograms expressed in
dist_units.
brushclause is a valid Brush clause.
penclause is a valid Pen clause.
dist_unit is a valid unit of distance. See Set Distance Units statement on page 592 for a complete
list of possible values.
time1, time2, timeN are numeric values representing times for Isograms expressed in time_units.
time_unit is a string representing valid unit of time. Valid choices are: “hr”, “min”, or “sec”.
Description
The Create Object statement creates one or more new region objects, by performing a geographic
operation (Buffer, Merge, Intersect, Union, ConvexHull, Voronoi, or Isogram) on one or more existing
objects.
The Into clause specifies where results are stored. To store the results in a table, specify Into Table.
To store the results in an Object variable, specify Into Variable. If you omit the Into clause, results
are stored in the source table.
Note: If you specify a Group By clause to perform data aggregation, you must store the results in a
table rather than a variable.
The keyword which follows the As keyword dictates what type of objects are created. ConvexHull,
Buffer, and Isogram are discussed in sections below.
Specify Intersect to create an object representing the intersection of other objects (for example, if
two regions overlap, the intersection is the area covered by both objects).
Specify Merge to create an object representing the combined area of the source objects. The Merge
operation produces a results object that contains all of the polygons that belonged to the original
objects. If the original objects overlap, the merge operation does not eliminate the overlap. Thus, if
you merge two overlapping regions (each of which contains one polygon), the end result may be a
region object that contains two overlapping polygons. In general, Union should be used instead.
Specify Union to perform a combine operation, which eliminates any areas of overlap. If you perform
the union operation on two overlapping regions (each of which contains one polygon), the end result
may be a region object that contains one polygon.
202
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The union and merge operations are similar, but they behave very differently in cases where objects
are completely contained within other objects. In this case, the merge operation removes the area of
the smaller object from the larger object, leaving a hole where the smaller object was. The union
operation does not remove the area of the smaller object.
Create Objects As Union is similar to the Objects Combine statement. The Objects Combine
statement deletes the input and inserts a new combined object. Create Objects As Union only
inserts the new combined object, it does not delete the input objects. Combining using a Target and
potentially different tables is only available with the Objects Combine statement. The Combine
Objects using Column functionality is only available using Create Objects As Union using the
Group By clause.
If a Create Object As Union statement does not include a Group By clause, MapInfo Professional
creates one combined object for all objects in the table. If the statement includes a Group By
clause, it must name a column in the table to allow MapInfo Professional to group the source objects
according to the contents of the column and produce a combined object for each group of objects.
If you specify a Group By clause, MapInfo Professional groups all records sharing the same value,
and performs an operation (for example, Merge) on the group.
If you specify a Data clause, MapInfo Professional performs data aggregation. For example, if you
perform merge or union operations, you may want to use the Data clause to assign data values
based on the Sum( ) or Avg( ) aggregate functions.
Specify Voronoi to create regions that represent the Voronoi solutions of the input points. The data
values from the original input points can be assigned to the resultant polygon for that point by
specifying data clauses.
Convex Hull
The ConvexHull operator creates a polygon representing a convex hull around a set of points. The
convex hull polygon can be thought of as an operator that places a rubber band around all of the
points. It consists of the minimal set of points such that all other points lie on or inside the polygon.
The polygon is convex—no interior angle can be greater than 180 degrees.
The points used to construct the convex hull are any nodes from Regions, Polylines, or Points in the
fromtable. If a Create Object As ConvexHull statement does not include a Group By clause,
MapInfo Professional creates one convex hull polygon. If the statement includes a Group By clause
that names a column in the table, MapInfo Professional groups the source objects according to the
contents of the column, then creates one convex hull polygon for each group of objects. If the
statement includes a Group By RowID clause, MapInfo Professional creates one convex hull
polygon for each object in the source table.
Buffer
If the Create Object statement performs a Buffer operation, the statement can include Width and
Resolution clauses. The Width clause specifies the width of the buffer. The optional Units subclause lets you specify a distance unit name (such as “km” for kilometers) to apply to the Width
clause. If the Width clause does not include the Units sub-clause, the buffer width is interpreted in
MapBasic's current distance unit. By default, MapBasic uses miles as the distance unit; to change
this unit, use the Set Distance Units statement.
Reference Guide
203
Create Object statement
Type is the method used to calculate the buffer width around the object. It can either be Spherical or
Cartesian. Note that if the coordinate system of the intotable is NonEarth, then the calculations are
performed using Cartesian methods regardless of the option chosen, and if the coordinate system of
the intotable is Latitude/Longitude, then calculations are performed using Spherical methods
regardless of the option chosen.
The optional Type sub-clause lets you specify the type of distance calculation used to create the
buffer. If the Spherical type is used, then the calculation is done by mapping the data into a
Latitude/Longitude On Earth projection and using widths measured using Spherical distance
calculations. If the Cartesian type is used, then the calculation is done by considering the data to be
projected to a flat surface and widths are measured using Cartesian distance calculations. If the
Width clause does not include the Type sub-clause, then the default distance calculation type
Spherical is used. If the data is in a Latitude/Longitude projection, then Spherical calculations are
used regardless of the Type setting. If the data is in a NonEarth projection, the Cartesian
calculations are used regardless of the Type setting.
The Resolution keyword lets you specify the number of segments comprising each circle of the
buffer region. By default, a buffer object has a smoothness value of twelve (12), meaning that there
are twelve segments in a simple ring-shaped buffer region. By specifying a larger smoothness value,
you can produce smoother buffer regions. Note, however, that the larger the smoothness value, the
longer the Create Object statement takes, and the more disk space the resultant object occupies.
If a Create Object As Buffer statement does not include a Group By clause, MapInfo Professional
creates one buffer region. If the statement includes a Group By clause which names a column in the
table, MapInfo Professional groups the source objects according to the contents of the column, then
creates one buffer region for each group of objects. If the statement includes a Group By RowID
clause, MapInfo Professional creates one buffer region for each object in the source table.
Isogram
If the Create Object statement performs an Isogram operation, you must pass a connection_handle
that corresponds to an open connection created with an Open Connection statement. You must
specify a Distance clause or a Time clause to create the size of the Isogram desired. The Distance
clause can contain one or more distance expressions with an optional brush and/or pen for each
one. If you do not specify a Brush clause or Pen clause the current brush and pen is used. No
matter how many Distance instances you specify a single Units string must be provided to indicate
the units in which the distances are expressed.
By specifying a Time clause, you can create regions based on time, with each one having an
optional Brush clause and/or Pen clause. If you do not specify a Brush clause or Pen clause the
current brush and pen is used. No matter how many Time instances you specify a single Units string
must be provided to indicate the units in which the times are expressed. The maximum amount of
values allowed is 50. Each value creates a separate band that can be either specific times or
specific distances. Larger values take substantially longer to create. Many items factor into the
equation, but in general, using the Set Connection Isogram statement with MajorRoadsOnly
specified, results in a much quicker response compared to using the entire road network. MapBasic
only allows distances of 150 miles with MajorRoadsOnly Off and 600 miles with MajorRoadsOnly
On. similarly, the maximum time is 2 hours with MajorRoadsOnly Off and 8 hours with
MajorRoadsOnly On.
204
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example merges region objects from the Parcels table, and stores the resultant
regions in the table Zones. Since the Create Object statement includes a Group By clause,
MapBasic groups the Parcel regions, then performs one merge operation for each group. Thus, the
Zones table ends up with one region object for each group of objects in the Parcels table. Each
group consists of all parcels having the same value in the zone_id column.
Following the Create Object statement, the parcelcount column in the Zones table indicates how
many parcels were merged to produce that zone. The zonevalue column in the Zones table
indicates the sum of the values from the parcels that comprised that zone.
Open Table "PARCELS"
Open Table "ZONES"
Create Object As Merge
From PARCELS Into Table ZONES Data
parcelcount=Count(*),zonevalue=Sum(parcelvalue)
Group By zone_id
The next example creates a region object, representing a quarter-mile buffer around whatever
objects are currently selected. The buffer object is stored in the Object variable, corridor. A
subsequent Update statement or Insert statement could then copy the object to a table.
Dim corridor As Object
Create Object As Buffer
From Selection
Into Variable corridor
Width 0.25 Units "mi"
Resolution 60
The next example shows a multi-object convex hull using the Create Object As statement.
Create Object As ConvexHull from state_caps into Table dump_table
See Also
Buffer( ) function, ConvexHull( ) function, Objects Combine statement, Objects Erase
statement, Objects Intersect statement, Open Connection statement
Reference Guide
205
Create Pline statement
Create Pline statement
Purpose
Creates a polyline object.
Syntax
Create Pline
[ Into { Window window_id | Variable var_name } ]
[ Multiple num_sections ]
num_points ( x1, y1 ) ( x2, y2 ) [ ... ]
[ Pen... ]
[ Smooth ]
window_id is a window identifier.
var_name is the name of an existing object variable.
num_points specifies how many nodes the polyline will contain.
num_sections specifies how many sections the multi-section polyline will contain.
each x, y pair defines a node of the polyline.
The Pen clause specifies a line style.
Description
The Create Pline statement creates a polyline object. If you need to create a polyline object, but do
not know until run-time how many nodes the object should contain, create the object in two steps:
First, use Create Pline to create an object with no nodes, and then use the Alter Object statement
to add detail to the polyline object. See Alter Object statement on page 92 for more information.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a Window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If you omit the
Into clause, MapInfo Professional attempts to store the object in the topmost window; if objects
cannot be stored in the topmost window; no object is created.
The x and y parameters use whatever coordinate system MapBasic is currently using
(Longitude/Latitude by default; see Set CoordSys statement on page 588 for more information).
Objects created on a Layout window, however, are specified in paper units. By default, MapBasic
uses inches as the paper unit. To use a different paper unit, use the Set Paper Units statement. If
you need to create objects on a Layout window, you must first issue a Set CoordSys Layout
statement.
The optional Pen clause specifies a line style; see Pen clause on page 461 for more details. If no
Pen clause is specified, the Create Pline statement will use the current line style (the style which
appears in the MapInfo Professional Options > Line Style dialog box). Smooth will smooth the line
so that it appears to be one continuous line with curves instead of angles.
A single-section polyline can contain up to 32,763 nodes. For a multiple-section polyline, the limit is
smaller: for each additional section, reduce the number of nodes by three.
206
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Alter Object statement, Insert statement, Pen clause, Update statement
CreatePoint( ) function
Purpose
Returns an Object value representing a point.
Syntax
CreatePoint( x, y )
x is a float value, representing an x-position (for example, Longitude).
y is a float value, representing a y-position (for example, Latitude).
Return Value
Object
Description
The CreatePoint( ) function returns an Object value representing a point.
The x and y parameters should use whatever coordinate system MapBasic is currently using. By
default, MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys
statement can re-configure MapBasic to use a different coordinate system. Note that MapBasic's
coordinate system is independent of the coordinate system of any Map window.
The point object will use whatever Symbol style is currently selected. To create a point object with a
specific Symbol style, you could issue the Set Style statement before calling CreatePoint( ).
Alternately, instead of calling CreatePoint( ), you could issue a Create Point statement, which has
an optional Symbol clause.
The point object created through the CreatePoint( ) function could be assigned to an Object
variable, stored in an existing row of a table (through the Update statement), or inserted into a new
row of a table (through an Insert statement).
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
statement.
Examples
The following example uses the Insert statement to insert a new row into the table Sites. The
CreatePoint( ) function is used within the body of the Insert statement to specify the graphic object
that will be attached to the new row.
Open Table "sites"
Insert Into sites (obj)
Values ( CreatePoint(-72.5, 42.4) )
Reference Guide
207
Create Point statement
The following example assumes that the table Sites has Xcoord and Ycoord columns, which indicate
the longitude and latitude positions of the data. The Update statement uses the CreatePoint( )
function to build a point object for each row in the table. Following the Update operation, each row in
the Sites table will have a point object attached. Each point object will be located at the position
indicated by the Xcoord, Ycoord columns.
Open Table "sites"
Update sites
Set obj = CreatePoint(xcoord, ycoord)
The above example assumes that the Xcoord, Ycoord columns contain actual longitude and latitude
degree values. Note that MapInfo for DOS pointfiles store coordinates in millionths of degrees, not
whole degrees. Also, most MapInfo for DOS pointfiles store longitude coordinates in the “NorthWest
quadrant,” meaning that longitudes increase as you move westward. Thus, to perform the Update
operation on a MapInfo for DOS pointfile, you would need to divide the Xcoord and Ycoord fields by
one million, and multiply the Xcoord field by negative one:
Open Table "sites"
Update sites
Set obj = CreatePoint(-xcoord/1000000,ycoord/1000000)
See Also
Create Point statement, Insert statement, Update statement
Create Point statement
Purpose
Creates a point object.
Syntax
Create Point
[ Into { Window window_id | Variable var_name } ]
( x, y )
[ Symbol... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x, y specifies the location of the point.
The Symbol clause specifies a symbol style.
Description
The Create Point statement creates a point object.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If the Into
208
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
clause is not provided, MapBasic will attempt to store the object in the topmost window; if objects
may not be stored in the topmost window (for example, if the topmost window is a grapher) no object
will be created.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a longitude, latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, use the Set
Paper Units statement.
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
Layout statement.
The optional Symbol clause specifies a symbol style; see Symbol clause on page 680 for more
details. If no Symbol clause is specified, the Create Point statement uses the current symbol style
(the style which appears in the Options > Symbol Style dialog box).
See Also
CreatePoint( ) function, Insert statement, Symbol clause, Update statement
Create PrismMap statement
Purpose
Creates a Prism map.
Syntax
Create PrismMap
[ From Window window_ID | MapString mapper_creation_string ]
{ layer_id | layer_name }
With expr
[ Camera [Pitch angle | Roll angle | Yaw angle | Elevation angle] |
[ Position ( x, y, z ) | FocalPoint ( x, y, z ) ] |
[ Orientation(vu_1, vu_2, vu_3, vpn_1, vpn_2, vpn_3,
clip_near, clip_far) ] ]
[ Light Color lightcolor ] ]
[ Scale grid_scale ]
[ Background backgroundcolor ]
window_id is a window identifier a for a Map window which contains a region layer. An error
message is displayed if a layer with regions is not found.
mapper_creation_string specifies a command string that creates the mapper textured on the Prism
map.
layer_id is the layer identifier of a layer in the map (one or larger).
layer_name is the name of a layer in the map.
Reference Guide
209
Create PrismMap statement
expr is an expression that is evaluated for each row in the table.
Camera specifies the camera position and orientation.
angle is an angle measurement in degrees. The horizontal angle in the dialog box ranges from 0360 degrees and rotates the maps around the center point of the grid. The vertical angle in the
dialog box ranges from 0-90 and measures the rotation in elevation from the start point directly over
the map.
Pitch adjusts the camera's current rotation about the x-axis centered at the camera's origin.
Roll adjusts the camera's current rotation about the z-axis centered at the camera's origin.
Yaw adjusts the camera's current rotation about the y-axis centered at the camera's origin.
Elevation adjusts the current camera's rotation about the x-axis centered at the camera's focal
point.
Position indicates the camera and/or light position.
FocalPoint indicates the camera and/or light focal point.
Orientation specifies the camera's ViewUp (vu_1, vu_2, vu_3), ViewPlane Normal (vpn_1, vpn_2,
vpn_3) and Clipping Range (clip_near and clip_far), used specifically for persistence of view).
grid_scale is the amount to scale the grid in the z direction. A value >1 will exaggerate the topology
in the z direction, a value <1 will scale down the topological features in the z direction.
backgroundcolor is a color to be used to set the background and is specified using the RGB( )
function.
Description
The Create PrismMap statement creates a Prism Map window. The Prism Map is a way to
associate multiple variables for a single object in one visual. For example, the color associated with
a region may be the result of thematic shading while the height the object is extruded through may
represent a different value. The Create PrismMap statement corresponds to MapInfo Professional's
Map > Create Prism Map menu item.
Between sessions, MapInfo Professional preserves Prism Maps settings by storing a Create
PrismMap statement in the workspace file. Thus, to see an example of the Create PrismMap
statement, you could create a map, choose the Map > Create Thematic Map command, save the
workspace (for example, PRISM.WOR), and examine the workspace in a MapBasic text edit
window. You could then copy the Create PrismMap statement in your MapBasic program. Similarly,
you can see examples of the Create PrismMap statement by opening the MapBasic Window before
you choose Map > Create Thematic Map.
Each Create PrismMap statement must specify an expr expression clause. MapInfo Professional
evaluates this expression for each object in the layer; following the Create PrismMap statement,
MapInfo Professional chooses each object's display style based on that record's expr value. The
expression typically includes the names of one or more columns from the table being shaded.
The optional window_id clause identifies which map layer to use in the prism map; if no window_id is
provided, MapBasic uses the topmost Map window. The Create PrismMap statement must specify
which layer to use, even if the Map window has only one layer. The layer may be identified by
210
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
number (layer_id), where the topmost map layer has a layer_id value of one, the next layer has a
layer_id value of two, etc. Alternately, the Create PrismMap statement can identify the map layer by
name (for example, “world”).
Example
Open Table "STATES.TAB" Interactive
Map From STATES
Create PrismMap From Window FrontWindow( ) STATES With Pop_1980 Background
RGB(192,192,192)
See Also
Set PrismMap statement, PrismMapInfo( ) function
Create Ranges statement
Purpose
Calculates thematic ranges and stores the ranges in an array, which can then be used in a Shade
statement.
Syntax
Create Ranges
From table
With expr
[ Use {"Equal Ranges" | "Equal Count" | "Natural Break" | "StdDev" } ]
[ Quantile Using q_expr ]
[ Number num_ranges ]
[ Round rounding_factor ]
Into Variable array_variable
table is the name of the table to be shaded thematically.
expr is an expression that is evaluated for each row in the table.
q_expr is the expression used to perform quantiling.
num_ranges specifies the number of ranges (default is 4).
rounding_factor is factor by which the range break numbers should be rounded (for example, 10 to
round off values to the nearest ten).
array_variable is the float array variable in which the range information will be stored.
Description
The Create Ranges statement calculates a set of range values which can then be used in a Shade
statement (which creates a thematic map layer). For an introduction to thematic maps, see the
MapInfo Professional documentation.
Reference Guide
211
Create Ranges statement
The optional Use clause specifies how to break the data into ranges. If you specify “Equal Ranges”
each range covers an equal portion of the spectrum of values (for example, 0-25, 25-50, 50-75, 75100). If you specify “Equal Count” the ranges are constructed so that there are approximately the
same number of rows in each range. If you specify “Natural Break” the ranges are dictated by
natural breaks in the set of data values. If you specify “StdDev” the middle range breaks at the mean
of your data values, and the ranges above and below the middle range are one standard deviation
above or below the mean. MapInfo Professional uses the population standard deviation (N - 1).
The Into Variable clause specifies the name of the float array variable that will hold the range
information. You do not need to pre-size the array; MapInfo Professional automatically enlarges the
array, if necessary, to make room for the range information. The final size of the array is twice the
number of ranges, because MapInfo Professional calculates a high value and a low value for each
range.
After calling Create Ranges, call the Shade statement to create the thematic map, and use the
Shade statement's optional From Variable clause to read the array of ranges. The Shade statement
usually specifies the same table name and column expression as the Create Ranges statement.
Quantiled Ranges
If the optional Quantile Using clause is present, the Use clause is ignored and range limits are
defined according to the q_expr.
Quantiled ranges are best illustrated by example. The following statement creates ranges of buying
power index (BPI) values, and uses state population statistics to perform quantiling to set the range
limits.
Create Ranges From states
With BPI_1990 Quantile Using Pop_1990
Number 5
Into Variable f_ranges
Because of the Number 5 clause, this example creates a set of five ranges.
Because of the With BPI_1990 clause, states with the highest BPI values will be placed in the
highest range (the deepest color), and states with the lowest BPI values will be placed in the lowest
range (the palest color).
Because of the Quantile Using Pop_1990 clause, the range limits for the intermediate ranges
are calculated by quantiling, using a method that takes state population (Pop_1990) into account.
Since the Quantile Using clause specifies the Pop_1990 column, MapInfo Professional calculates
the total 1990 population for the table (which, for the United States, is roughly 250 million). MapInfo
Professional divides that total by the number of ranges (in this case, five ranges), producing a result
of fifty million. MapInfo Professional then tries to define the ranges in such a way that the total
population for each range approximates, but does not exceed, fifty million.
MapInfo Professional retrieves rows from the States table in order of BPI values, starting with the
states having low BPI values. MapInfo Professional assigns rows to the first range until adding
another row would cause the cumulative population to match or exceed fifty million. At that time,
MapInfo Professional considers the first range “full” and then assigns rows to the second range.
MapInfo Professional places rows in the second range until adding another row would cause the
cumulative total to match or exceed 100 million; at that point, the second range is full, etc.
212
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Include "mapbasic.def"
Dim range_limits( ) As Float, brush_styles( ) As Brush
Dim col_name As Alias
Open Table "states" Interactive
Create Styles
From Brush(2, CYAN, 0) 'style for LOW range
To Brush (2, BLUE, 0) 'style for HIGH range
Vary Color By "RGB"
Number 5
Into Variable brush_styles
' Store a column name in the Alias variable:
col_name = "Pop_1990"
Create Ranges From states
With col_name
Use "Natural Break"
Number 5
Into Variable range_limits
Map From states
Shade states
With col_name
Ranges
From Variable range_limits
Style Variable brush_styles
' Show the theme legend window:
Open Window Legend
See Also
Create Styles statement, Set Shade statement, Shade statement
Reference Guide
213
Create Rect statement
Create Rect statement
Purpose
Creates a rectangle or square object.
Syntax
Create Rect
[ Into { Window window_id | Variable var_name } ]
( x1, y1 ) ( x2, y2 )
[ Pen... ]
[ Brush... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x1, y1 specifies the starting corner of the rectangle.
x2, y2 specifies the opposite corner of the rectangle.
The Pen clause specifies a line style.
The Brush clause specifies a fill style.
Description
If the Create Rect statement includes the optional Into Variable clause, the object will be stored in
the specified object variable. If the Into clause specifies a Window identifier, the object will be
stored in the appropriate place in the window (for example, in the editable layer of a Map window). If
the Into clause is not provided, MapBasic will attempt to store the object in the topmost window; if
objects may not be stored in the topmost window (for example, if the topmost window is a grapher)
no object will be created.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, call the Set
Paper Units statement.
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
Layout statement.
The optional Pen clause specifies a line style; see Pen clause on page 461 for more details. If no
Pen clause is specified, the Create Rect statement uses the current line style (the style which
appears in the Options > Line Style dialog box). Similarly, the optional Brush clause specifies a fill
style; see Brush clause on page 109 for more details.
214
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Brush clause, Create RoundRect statement, Insert statement, Pen clause, Update statement
Create Redistricter statement
Purpose
Begins a redistricting session.
Syntax
Create Redistricter source_table By district_column
With
[ Count ]
[ , Brush ] [ , Symbol ] [ , Pen ]
[ , { Sum | Percent } ( expr ) ] [ , { Sum | Percent } ( expr ) ... ]
[ Percentage From expr]
[ Order { "MRU" | "Alpha" | "Unordered" } ]
source_table is the name of the table containing objects to be grouped into districts.
district_column is the name of a column; the initial set of districts is built from the original contents of
this column, and as objects are assigned to different districts, MapInfo Professional stores the
object's new district name in this column.
The Count keyword specifies that the Districts Browser will show a count of the objects belonging to
each district.
The Brush keyword specifies that the Districts Browser will show each district's fill style.
The Symbol keyword specifies that the Districts Browser will show each district's symbol style.
The Pen keyword specifies that the Districts Browser will show each district's line style.
expr is a numeric column expression.
The Percentage From clause specifies in-row calculation.
The Order clause specifies the order of rows in the Districts Browser (alphabetical, unsorted, or
based on most-recently-used); default is MRU.
Description
The Create Redistricter statement begins a redistricting session. This statement corresponds to
choosing MapInfo Professional's Window > New Redistrict Window command. For an introduction
to redistricting, see the MapInfo Professional documentation.
To control the set of districts, use the Set Redistricter statement. To end the redistricting session,
use the Close Window statement to close the Districts Browser window.
Reference Guide
215
Create Region statement
If you include the Brush keyword, the Districts Browser includes a sample of each district's fill style.
Note that this is not a complete Brush clause; the keyword Brush appears by itself. Similarly, the
Symbol and Pen keywords are individual keywords, not a complete Symbol clause or Pen clause.
If the Districts Browser includes brush, symbol, and/or pen styles, the user can change a district's
style by clicking on the style sample that appears in the Districts Browser.
The Percentage From clause allows you to specify the in-row mode of percentage calculation. If the
Percentage From clause is not specified, the in-column method of calculation is used.
See Also
Set Redistricter statement
Create Region statement
Purpose
Creates a region object.
Syntax
Create Region
[ Into { Window window_id | Variable var_name } ]
num_polygons
[ num_points1 ( x1, y1 ) ( x2, y2 ) [ ... ] ]
[ num_points2 ( x1, y1 ) ( x2, y2 ) [ ... ] ... ]
[ Pen... ]
[ Brush... ]
[ Center ( center_x, center_y ) ]
window_id is a window identifier.
var_name is the name of an existing object variable.
num_polygons specifies the number of polygons that will make up the region (zero or more).
num_points1 specifies the number of nodes in the region's first polygon.
num_points2 specifies the number of nodes in the region's second polygon, etc.
Each x, y pair specifies one node of a polygon.
The Pen clause specifies a line style.
The Brush clause specifies a fill style.
center_x is the x-coordinate of the object centroid.
center_y is the y-coordinate of the object centroid.
Description
The Create Region statement creates a region object.
216
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The num_polygons parameter specifies the number of polygons which comprise the region object. If
you specify a num_polygons parameter with a value of zero, the object will be created as an empty
region (a region with no polygons). You can then use the Alter Object statement to add details to
the region.
Depending on your application, you may need to create a region object in two steps, first using
Create Region to create an object with no polygons, and then using the Alter Object statement to
add details to the region object. If your application needs to create region objects, but it will not be
known until run-time how many nodes or how many polygons the regions will contain, you must use
the Alter Object statement to add the variable numbers of nodes. See Alter Object statement on
page 92 for more information.
If the statement includes the optional Into Variable clause, the object will be stored in the specified
object variable. If the Into clause specifies a window identifier, the object will be stored in the
appropriate place in the window (for example, in the editable layer of a Map window). If the Into
clause is not provided, MapBasic will attempt to store the object in the topmost window; if objects
may not be stored in the topmost window (for example, if the topmost window is a grapher) no object
will be created.
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, To use a
different paper unit, call the Set Paper Units statement.
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
Layout statement.
The optional Pen clause specifies a line style used to draw the outline of the object; see Pen clause
on page 461 for more details. If no Pen clause is specified, the Create Region statement uses the
current line style (the style which appears in the Options > Line Style dialog box). Similarly, the
optional Brush clause specifies a fill style; see Brush clause on page 109 for more details.
A single-polygon region can contain up to 1,048,572 nodes. For a multiple-polygon region, the limit
is smaller: for each additional polygon, reduce the number of nodes by three. There can be a
maximum of 32,000 polygons per region (multipolygon region).
Reference Guide
217
Create Report From Table statement
Example
Dim obj_region As Object
Dim x(100), y(100) As Float
Dim i, node_count As Integer
'
'
'
'
If you store a set of coordinates in the
x( ) and y( ) arrays, the following statements
will create a region object that has a node
at each x,y location:
' First, create an empty region object
Create Region Into Variable obj_region 0
' Now add nodes to populate the object:
For i = 1 to node_count
Alter Object obj_region Node Add ( x(i), y(i) )
Next
' Now store the object in the Sites table:
Insert Into Sites (Object) Values (obj_region)
See Also
Alter Object statement, Brush clause, Insert statement, Pen clause, Update statement
Create Report From Table statement
Purpose
Creates a report file for Crystal Reports from an open MapInfo Professional table:
Syntax
Create Report From Table tablename [Into reportfilespec][Interactive]
tablename is an open table in MapInfo Professional.
reportfilespec is a full path and filename for the new report file.
The Interactive keyword signifies that the new report should immediately be loaded into the Crystal
Report Designer module. Interactive mode is implied if the Into clause is missing. You cannot create
a report from a grid or raster table; you will get an error.
See Also
Open Report statement
218
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Create RoundRect statement
Purpose
Creates a rounded rectangle object.
Syntax
Create RoundRect
[ Into { Window window_id | Variable var_name } ]
( x1, y1 ) ( x2, y2 ) rounding
[ Pen... ]
[ Brush... ]
window_id is a window identifier.
var_name is the name of an existing object variable.
x1, y1 specifies one corner of the rounded rectangle.
x2, y2 specifies the opposite corner of the rectangle.
rounding is a float value, in coordinate units (for example, inches on a Layout or degrees on a Map),
specifying the diameter of the circle which fills the rounded rectangle's corner.
The Pen clause specifies a line style.
The Brush clause specifies a fill style.
Description
The Create RoundRect statement creates a rounded rectangle object (a rectangle with rounded
corners).
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. Note that MapBasic's coordinate
system is independent of the coordinate system of any Map window. Objects created on a Layout
window, however, are specified in paper units: each x-coordinate represents a distance from the left
edge of the page, while each y-coordinate represents the distance from the top edge of the page. By
default, MapBasic uses inches as the default paper unit. To use a different paper unit, call the Set
Paper Units statement.
Note: If you need to create objects on a Layout window, you must first issue a Set CoordSys
Layout statement.
The optional Pen clause specifies a line style used to draw the outline of the object; see Pen clause
on page 461 for more details. If no Pen clause is specified, the Create RoundRect statement uses
the current line style (the style which appears in the Options > Line Style dialog box). Similarly, the
optional Brush clause specifies a fill style; see Brush clause on page 109 for more details.
See Also
Brush clause, Create Rect statement, Insert statement, Pen clause, Update statement
Reference Guide
219
Create Styles statement
Create Styles statement
Purpose
Builds a set of Pen, Brush or Symbol styles, and stores the styles in an array.
Syntax
Create Styles
From { Pen... | Brush... | Symbol... }
To { Pen... | Brush... | Symbol... }
Vary { Color By { "RGB" | "HSV" } | Background By { "RGB" | "HSV" } |
Size By { "Log" | "Sqrt" | "Constant" }}
[ Number num_styles ]
[ Inflect At range_number With { Pen... | Brush... | Symbol...} ]
Into Variable array_variable
num_styles is the number of drawing styles (for example, the number of fill styles) to create. The
default number is four.
range_number is a SmallInt range number; the inflection attribute is placed after this range.
array_variable is an array variable that will store the range of pens, brushes, or symbols.
Description
The Create Styles statement defines a set of Pen, Brush, or Symbol styles, and stores the styles in
an array variable. The array can then be used in a Shade statement (which creates a thematic map
layer). For an introduction to thematic mapping, see the MapInfo Professional documentation.
The From clause specifies a Pen, Brush, or Symbol style. If the array of styles is later used in a
thematic map, the From style is the style assigned to the “low” range. The To clause specifies a style
that corresponds to the “high” range of a thematic map.
The Create Styles statement builds a set of styles which are interpolated between the From style
and the To style. For example, the From style could be a Brush clause representing a deep,
saturated shade of blue, and the To style could be a Brush clause representing a pale, faint shade of
blue. In this case, MapInfo Professional builds a set of Brush styles that vary from pale blue to
saturated blue.
The optional Number clause specifies the total number of drawing styles needed; this number
includes the two styles specified in the To and From clauses. Usually, this corresponds to the
number of ranges specified in a subsequent Shade statement.
The Vary clause specifies how to spread an attribute among the styles. To spread the foreground
color, use the Color sub-clause. To spread the background color, use the Background sub-clause.
In either case, color can be spread by interpolating the RGB or HSV components of the From and To
colors. If you are creating an array of Symbol styles, you can use the Size sub-clause to vary the
symbols' point sizes. Similarly, if you are creating an array of Pen styles, you can use the Size subclause to vary line width.
220
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The optional Inflect At clause specifies an inflection attribute that goes between the From and To
styles. If you specify an Inflect At clause, MapInfo Professional creates two sets of styles: one set of
styles interpolated between the From style and the Inflect style, and another set of styles
interpolated between the Inflect style and the To style. For example, using an inflection style, you
could create a thematic map of profits and losses, where map regions that have shown a profit
appear in various shades of green, while regions that have shown a loss appear in various shades of
red. Inflection only works when varying the color attribute.
The Into Variable clause specifies the name of the array variable that will hold the styles. You do not
need to pre-size the array; MapInfo Professional automatically enlarges the array, if necessary, to
make room for the set of styles. The array_variable (Pen, Brush, or Symbol) must match the style
type specified in the From and To clauses.
Example
The following example demonstrates the syntax of the Create Styles statement.
Dim brush_styles( ) As Brush
Create Styles
From Brush(2, CYAN, 0) 'style for LOW range
To Brush (2, BLUE, 0) 'style for HIGH range
Vary Color By "RGB"
Number 5
Into Variable brush_styles
This Create Styles statement defines a set of five Brush styles, and stores the styles in the
b_ranges array. A subsequent Shade statement could create a thematic map which reads the
Brush styles from the b_ranges array. For an example, see Create Ranges statement on
page 211.
See Also
Create Ranges statement, Set Shade statement, Shade statement
Reference Guide
221
Create Table statement
Create Table statement
Purpose
Creates a new table.
Syntax
Create Table table
( column columntype [ , ... ] ) | Using from_table }
[ File filespec ]
[ { Type NATIVE |
Type DBF [ CharSet char_set ] |
Type { Access | ODBC } database_filespec [ Version version ]
Table tablename
[ Password pwd ] [ CharSet char_set ]
} ]
[ Version version ]
table is the name of the table as you want it to appear in MapInfo Professional.
column is the name of a column to create. Column names can be up to 31 characters long, and can
contain letters, numbers, and the underscore (_) character. Column names cannot begin with
numbers.
from_table is the name of a currently open table in which the column you want to place in a new
table is stored. The from_table must be a base table, and must contain column data. Query tables
and raster tables cannot be used and will produce an error. The column structure of the new table
will be identical to this table.
filespec specifies where to create the .TAB, .MAP, and .ID files (and in the case of Access, .AID
files). If you omit the File clause, files are created in the current directory.
char_set is the name of a character set; see CharSet clause on page 126.
database_filespec is a string that identifies a valid Access database. If the specified database does
not exist, MapInfo Professional creates a new Access .MDB file.
version is an expression that specifies the version of the Microsoft Jet database format to be used by
the new database. Acceptable values are 4.0 (for Access 2000) or 3.0 (for Access '95/'97). If
omitted, the default version is 4.0. If the database in which the table is being created already exists,
the specified database version is ignored.
tablename is a string that indicates the name of the table as it will appear in Access.
pwd is the database-level password for the database, to be specified when database security is
turned on.
version is 100 (to create a table that can be read by versions of MapInfo Professional) or 300
(MapInfo Professional 3.0 format). Does not apply when creating an Access table; the version of the
Access table is handled by DAO.
222
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
columntype is the data type associated with the column. Each columntype is defined as follows:
Char( width ) | Float | Integer | SmallInt |
Decimal( width, decplaces ) | Date | Logical
width indicates how large each field should be (does not apply to all field types). Char fields can
have a width of up to 254 characters.
decplaces indicates the number of decimal places to use in a decimal field.
Description
The Create Table statement creates a new empty table with up to 250 columns. Specify ODBC to
create new tables on a DBMS server.
The Using clause allows you to create a new table as part of the “Combine Objects Using Column”
functionality. The from_table must be a base table, and must contain column data. Query tables and
raster tables cannot be used and will produce an error. The column structure of the new table being
created will be identical to this table.
The optional File clause specifies where to create the new table. If no File clause is used, the table
is created in the current directory or folder.
The optional Type clause specifies the table's data format. The default type is NATIVE, but can
alternately be DBF. The NATIVE format takes up less disk space than the DBF format, but the DBF
format produces base files that can be read in any dBASE-compatible database manager. Also,
create new tables on DBMS Servers from the ODBC Type clause in the Create Table statement.
The CharSet clause specifies a character set. The char_set parameter should be a string constant,
such as “WindowsLatin1”. If no CharSet clause is specified, MapBasic uses the default character
set for the hardware platform that is in use at runtime. See CharSet clause on page 126 for more
information.
The SmallInt column type reserves two bytes for each value; thus, the column can contain values
from -32,767 to +32,767. The Integer column type reserves four bytes for each value; thus, the
column can contain values from -2,147,483,647 to +2,147,483,647.
The Version clause controls the table's format. If you specify Version 100, MapInfo Professional
creates a table in a format that can be read by versions of MapInfo Professional. If you specify
Version 300, MapInfo Professional creates a table in the format used by MapInfo Professional
3.0. Note that region and polyline objects having more than 8,000 nodes and multiple-segment
polyline objects require version 300. If you omit the Version clause, the table is created in the
version 300 format.
Reference Guide
223
CreateText( ) function
Example
The following example shows how to create a table called Towns, containing 3 fields: a character
field called townname, an integer field called population, and a decimal field called median_income.
The file will be created in the subdirectory C:\MAPINFO\DATA. Since an optional Type clause is
used, the table will be built around a dBASE file.
Create Table Towns
( townname Char(30),
population SmallInt,
median_income Decimal(9,2) )
File "C:\MAPINFO\TEMP\TOWNS"
Type DBF
See Also
Alter Table statement, Create Index statement, Create Map statement, Drop Table statement,
Export statement, Import statement, Open Table statement
CreateText( ) function
Purpose
Returns a text object created for a specific map window.
Syntax
CreateText( window_id, x, y, text, angle, anchor, offset )
window_id is an integer window identifier that represents a Map window.
x, y are float values, representing the x/y location where the text is anchored.
text is a string value, representing the text that will comprise the text object.
angle is a float value, representing the angle of rotation; for horizontal text, specify zero.
anchor is an integer value from 0 to 8, controlling how the text is placed relative to the anchor
location. Specify one of the following codes; codes are defined in MAPBASIC.DEF.
LAYER_INFO_LBL_POS_CC
LAYER_INFO_LBL_POS_TL
LAYER_INFO_LBL_POS_TC
LAYER_INFO_LBL_POS_TR
LAYER_INFO_LBL_POS_CL
LAYER_INFO_LBL_POS_CR
LAYER_INFO_LBL_POS_BL
LAYER_INFO_LBL_POS_BC
LAYER_INFO_LBL_POS_BR
(0)
(1)
(2)
(3)
(4)
(5)
(6)
(7)
(8)
The two-letter suffix indicates the label orientation: T=Top, B=Bottom, C=Center, R=Right, L=Left.
For example, to place the text below and to the right of the anchor location, specify the define code
LAYER_INFO_LBL_POS_BR, or specify the value 8.
224
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
offset is an integer from zero to 200, representing the distance (in points) the text is offset from the
anchor location; offset is ignored if anchor is zero (centered).
Return Value
Object
Description
The CreateText( ) function returns an Object value representing a text object.
The text object uses the current Font style. To create a text object with a specific Font style, issue
the Set Style statement before calling CreateText( ).
At the moment the text is created, the text height is controlled by the current Font. However, after the
text object is created, its height depends on the Map window's zoom; zooming in will make the text
appear larger.
The object returned could be assigned to an Object variable, stored in an existing row of a table
(through the Update statement), or inserted into a new row of a table (through an Insert
statement).
Example
The following example creates a text object and inserts it into the map's Cosmetic layer (given that
the variable i_map_id is an integer containing a Map window's ID).
Insert Into Cosmetic1 (Obj)
Values ( CreateText(i_map_id, -80, 42.4, "Sales Map", 0,0,0) )
See Also
AutoLabel statement, Create Text statement, Font clause, Insert statement, Update statement
Create Text statement
Purpose
Creates a text object, such as a title, for a Map or Layout window.
Syntax
Create Text
[ Into { Window window_id | Variable var_name } ]
text_string
( x1, y1 ) ( x2, y2 )
[ Font... ]
[ Label Line { Simple | Arrow } ( label_x, label_y ) ]
[ Spacing { 1.0 | 1.5 | 2.0 } ]
[ Justify { Left | Center | Right } ]
[ Angle text_angle ]
window_id is an integer window ID number, identifying a Map or Layout window.
Reference Guide
225
CurDate( ) function
var_name is the name of an existing object variable.
text_string specifies the string, up to 255 characters long, that will constitute the text object; to create
a multiple-line text object, embed the function call Chr$(10) in the string.
x1, y1 are floating-point coordinates, specifying one corner of the rectangular area which the text will
fill.
x2, y2 specify the opposite corner of the rectangular area which the text will fill.
The Font clause specifies a text style. The point-size element of the Font is ignored if the text object
is created in a Map window; see below.
label_x, label_y specifies the position where the text object's label line is anchored.
text_angle is a float value indicating the angle of rotation for the text object (in degrees).
Description
The x and y parameters use whatever coordinate system MapBasic is currently using. By default,
MapBasic uses a Longitude/Latitude coordinate system, although the Set CoordSys statement can
re-configure MapBasic to use a different coordinate system. If you need to create objects on a
Layout window, you must first issue a Set CoordSys Layout statement.
The x1, y1, x2, and y2 arguments define a rectangular area. When you create text in a Map window,
the text fills the rectangular area, which controls the text height; the point size specified in the Font
clause is ignored. In a Layout window, text is drawn at the point size specified in the Font clause,
with the upper-left corner of the text placed at the (x1, y1) location; the (x2, y2) arguments are
ignored.
See Also
AutoLabel statement, CreateText( ) function, Font clause, Insert statement, Update statement
CurDate( ) function
Purpose
Returns the current date in YYYYMMDD format.
Syntax
CurDate( )
Return Value
Date
Description
The Curdate( ) function returns a Date value representing the current date. The format will always
be YYYYMMDD. To change the value to a string in the local system format use the FormatDate$( )
function or Str$( ) function.
226
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim d_today As Date
d_today = CurDate( )
See Also
Day( ) function, Format$( ) function, Month( ) function, StringToDate( ) function, Timer( )
function, Weekday( ) function, Year( ) function
CurDateTime function
Purpose
Returns the current date and time.
Syntax
CurDateTime
Return Value
DateTime
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as datetime
X = CurDateTime()
Print X
CurrentBorderPen( ) function
Purpose
Returns the current border pen style currently in use.
Syntax
CurrentBorderPen( )
Return Value
Pen
Description
The CurrentBorderPen( ) function returns the current border pen style. MapInfo Professional
assigns the current style to the border of any region objects drawn by the user. If a MapBasic
program creates an object through a statement such as Create Region statement, but the
statement does not include a Pen clause, the object uses the current BorderPen style.
Reference Guide
227
CurrentBrush( ) function
The return value can be assigned to a Pen variable, or may be used as a parameter within a
statement that takes a Pen setting as a parameter (such as Set Map statement).
To extract specific attributes of the Pen style (such as the color), call the StyleAttr( ) function. For
more information about Pen settings, see Pen clause on page 461.
Example
Dim p_user_pen As Pen p_user_pen = CurrentBorderPen( )
See Also
CurrentPen( ) function, Pen clause, Set Style statement, StyleAttr( ) function
CurrentBrush( ) function
Purpose
Returns the Brush (fill) style currently in use.
Syntax
CurrentBrush( )
Return Value
Brush
Description
The CurrentBrush( ) function returns the current Brush style. This corresponds to the fill style
displayed in the Options > Region Style dialog box. MapInfo Professional assigns the current
Brush value to any filled objects (ellipses, rectangles, rounded rectangles, or regions) drawn by the
user. If a MapBasic program creates a filled object through a statement such as the Create Region
statement, but the statement does not include a Brush clause, the object will be assigned the
current Brush value.
The return value of the CurrentBrush( ) function can be assigned to a Brush variable, or may be
used as a parameter within a statement that takes a Brush setting as a parameter (such as Set Map
statement or Shade statement).
To extract specific Brush attributes (such as the color), call the StyleAttr( ) function.
For more information about Brush settings, see Brush clause on page 109.
Example
Dim b_current_fill As Brush
b_current_fill = CurrentBrush( )
See Also
Brush clause, MakeBrush( ) function, Set Style statement, StyleAttr( ) function
228
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
CurrentFont( ) function
Purpose
Returns the Font style currently in use for Map and Layout windows.
Syntax
CurrentFont( )
Return Value
Font
Description
The CurrentFont( ) function returns the current Font style. This corresponds to the text style
displayed in the Options > Text Style dialog box when a Map or Layout window is the active
window. MapInfo Professional will assign the current Font value to any text object drawn by the user.
If a MapBasic program creates a text object through the Create Text statement, but the statement
does not include a Font clause, the text object will be assigned the current Font value.
The return value of the CurrentFont( ) function can be assigned to a Font variable, or may be used
as a parameter within a statement that takes a Font setting as a parameter (such as Set Legend
statement).
To extract specific attributes of the Font style (such as the color), call the StyleAttr( ) function.
For more information about Font settings, see Font clause on page 299.
Example
Dim f_user_text As Font
f_user_text = CurrentFont( )
See Also
Font clause, MakeFont( ) function, Set Style statement, StyleAttr( ) function
CurrentLinePen( ) function
Purpose
Returns the Pen (line) style currently in use.
Syntax
CurrentLinePen( )
Return Value
Pen
Reference Guide
229
CurrentPen( ) function
Description
The CurrentLinePen( ) function returns the current Pen style. MapInfo Professional assigns the
current style to any line or polyline objects drawn by the user. If a MapBasic program creates an
object through a statement such as Create Line statement, but the statement does not include a
Pen clause, the object uses the current Pen style. The return value can be assigned to a Pen
variable, or may be used as a parameter within a statement that takes a Pen setting as a parameter
(such as Set Map statement).
To extract specific attributes of the Pen style (such as the color), call the StyleAttr( ) function. For
more information about Pen settings, see Pen clause on page 461.
Example
Dim p_user_pen As Pen p_user_pen = CurrentPen( )
See Also
CurrentBorderPen( ) function, Pen clause, Set Style statement, StyleAttr( ) function
CurrentPen( ) function
Purpose
Returns the Pen (line) style currently in use and sets the border pen to the same style as the line
pen.
Syntax
CurrentPen( )
Return Value
Pen
Description
The CurrentPen( ) function returns the current Pen style. MapInfo Professional assigns the current
style to any line or polyline objects drawn by the user. If a MapBasic program creates an object
through a statement such as the Create Line statement, but the statement does not include a Pen
clause, the object uses the current Pen style. If you want to use the current line pen without resetting the border pen, use the CurrentLinePen( ) function.
The return value can be assigned to a Pen variable, or may be used as a parameter within a
statement that takes a Pen setting as a parameter (such as the Set Map statement).
To extract specific attributes of the Pen style (such as the color), call the StyleAttr( ) function. For
more information about Pen settings, see Pen clause on page 461.
Example
Dim p_user_pen As Pen
p_user_pen = CurrentPen( )
230
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
MakePen( ) function, Pen clause, Set Style statement, StyleAttr( ) function
CurrentSymbol( ) function
Purpose
Returns the Symbol style currently in use.
Syntax
CurrentSymbol( )
Return Value
Symbol
Description
The CurrentSymbol( ) function returns the current symbol style. This is the style displayed in the
Options > Symbol Style dialog box. MapInfo Professional assigns the current Symbol style to any
point objects drawn by the user. If a MapBasic program creates a point object through a Create
Point statement, but the statement does not include a Symbol clause, the object will be assigned
the current Symbol value.
The return value of the CurrentSymbol( ) function can be assigned to a Symbol variable, or may be
used as a parameter within a statement that takes a Symbol clause as a parameter (such as Set
Map statement or Shade statement).
To extract specific attributes of the Symbol style (such as the color), call the StyleAttr( ) function.
For more information about Symbol settings, see Symbol clause on page 680.
Example
Dim sym_user_symbol As Symbol
sym_user_symbol = CurrentSymbol( )
See Also
MakeSymbol( ) function, Set Style statement, StyleAttr( ) function, Symbol clause
CurTime function
Purpose
Returns the current time.
Syntax
CurTime
Reference Guide
231
CurTime function
Return Value
Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Y as time
Y = CurTime()
Print Y
232
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
DateWindow( ) function
Purpose
Returns the current date window setting as an integer in the range 0 to 99, or (-1) if date windowing
is off.
Syntax
DateWindow( context )
context is a SmallInt that can either be DATE_WIN_CURPROG or DATE_WIN_SESSION.
Description
This depends on which context is passed. If context is DATE_WIN_SESSION, then the current
session setting in effect is returned. If context is DATE_WIN_CURPROG, then the current MapBasic
program's local setting is returned, if a program is not running the session setting is returned.
MBXs compiled before v5.5 will still convert 2-digit years to the current century (5.0 and earlier
behavior). To get the new behavior, they must be recompiled with MapBasic v5.5 or later.
Example
In the following example the variable Date1 = 19890120, Date2 = 20101203 and MyYear = 1990.
DIM Date1, Date2 as Date
DIM MyYear As Integer
Set Format Date "US"
Set Date Window 75
Date1 = StringToDate("1/20/89")
Date2 = StringToDate("12/3/10")
MyYear = Year("12/30/90")
See Also
Set Date Window statement
Day( ) function
Purpose
Returns the day component from a Date expression.
Syntax
Day( date_expr )
date_expr is a Date expression.
Return Value
SmallInt from 1 to 31
Reference Guide
233
DDEExecute statement
Description
The Day( ) function returns an integer value from one to thirty-one, representing the day-of-themonth component of the specified date. For example, if the specified date is 12/17/93, the Day( )
function returns a value of 17.
Example
Dim day_var As SmallInt, date_var As Date
date_var = StringToDate("05/23/1985")
day_var = Day(date_var)
See Also
CurDate( ) function, Month( ) function, Timer( ) function, Year( ) function
DDEExecute statement
Purpose
Issues a command across an open DDE channel.
Syntax
DDEExecute channel, command
channel is an integer channel number returned by DDEInitiate( ).
command is a string representing a command for the DDE server to execute.
Description
The DDEExecute statement sends a command string to the server application in a DDE
conversation.
The channel parameter must correspond to the number of a channel opened through a
DDEInitiate( ) function call.
The command parameter string must represent a command which the DDE server (the passive
application) is able to carry out. Different applications have different requirements regarding what
constitutes a valid command; to learn about the command format for a particular application, see the
documentation for that application.
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
ERR_NO_RESPONSE_FROM_APP error if server application does not respond.
234
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Through MapBasic, you can open a DDE channel with Microsoft Excel as the server application. If
the conversation specifies the “System” topic, you can use the DDEExecute statement to send
Excel a command string. Provided that the command string is equivalent to an Excel macro function,
and provided that the command string is enclosed in square brackets, Excel can execute the
command. The example below instructs Excel to open the worksheet “TRIAL.XLS”.
Dim i_chan As Integer
i_chan = DDEInitiate("Excel", "System")
DDEExecute i_chan, "[OPEN(""C:\DATA\TRIAL.XLS"")]"
See Also
DDEInitiate( ) function, DDEPoke statement, DDERequest$( ) function
DDEInitiate( ) function
Purpose
Initiates a new DDE conversation, and returns the associated channel number.
Syntax
DDEInitiate( appl_name, topic_name )
appl_name is a string representing an application name (for example, “MapInfo”).
topic_name is a string representing a topic name (for example, “System”).
Return Value
Integer
Description
The DDEInitiate( ) function initiates a DDE (Dynamic Data Exchange) conversation, and returns the
number that identifies that conversation's channel.
A DDE conversation allows two Microsoft Windows applications to exchange information. Once a
DDE conversation has been initiated, a MapBasic program can issue DDERequest$( ) function
calls (to read information from the other application) and DDEPoke statements (to write information
to the other application). Once a DDE conversation has served its purpose and is no longer needed,
the MapBasic program should terminate the conversation through the DDETerminate statement or
DDETerminateAll statement.
Note: DDE conversations are a feature specific to Microsoft Windows; therefore, MapBasic
generates an error if a program issues DDE-related function calls when running on a nonWindows platform. To determine the current hardware platform at run-time, call the
SystemInfo( ) function.
The appl_name parameter identifies a Windows application. For example, to initiate a conversation
with Microsoft Excel, you should specify the appl_name parameter “Excel.” The application named
by the appl_name parameter must already be running before you can initiate a DDE conversation;
Reference Guide
235
DDEInitiate( ) function
note that the MapBasic Run Program statement allows you to run another Windows application.
Not all Windows applications support DDE conversations. To determine if an application supports
DDE conversations, see the documentation for that application.
The topic_name parameter is a string that identifies the topic for the conversation. Each application
has its own set of valid topic names; for a list of topics supported by a particular application, refer to
the documentation for that application. With many applications, the name of a file that is in use is a
valid topic name. Thus, if Excel is currently using the worksheet file “ORDERS.XLS”, you could issue
the following MapBasic statements:
Dim i_chan As Integer
i_chan = DDEInitiate("Excel", "C:\ORDERS.XLS")
to initiate a DDE conversation with that Excel worksheet.
Many applications support a special topic called “System”. If you initiate a conversation using the
“System” topic, you can then use the DDERequest$( ) function to obtain a list of the strings which
the application accepts as valid topic names (i.e. a list of the files that are currently in use). Knowing
what topics are available, you can then initiate another DDE conversation with a specific document.
See the example below.
The following table lists some sample application and topic names which you could use with the
DDEInitiate( ) function.
DDEInitiate( ) call
Nature of conversation
DDEInitiate("Excel", "System")
DDERequest$( ) function calls can return Excel
system information, such as a list of the names of
the worksheets in use; DDEExecute statements
can send commands for Excel to execute.
DDEInitiate("Excel", wks)
If wks is the name of an Excel document in use,
subsequent DDEPoke statements can store
values in the worksheet, and DDERequest$( )
function calls can read information from the
worksheet.
DDEInitiate("MapInfo", "System")
DDERequest$( ) function calls can provide
system information, such as a list of the MapBasic
applications currently in use by MapInfo
Professional.
DDEInitiate("MapInfo" mbx)
If mbx is the name of a MapBasic application in
use, DDEPoke statements can assign values to
global variables in the specified application, and
DDERequest$( ) function calls can read the
current values of global variables.
When a MapBasic program issues a DDEInitiate( ) function call, the MapBasic program is known as
the “client” in the DDE conversation. The other Windows application is known as the “server.” Within
one particular conversation, the client is always the active party; the server merely responds to
236
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
actions taken by the client. A MapBasic program can carry on multiple conversations at the same
time, limited only by memory and system resources. A MapBasic application could act as the client
in one conversation (by issuing statements such as DDEInitiate( ), etc.) while acting as the server in
another conversation (by defining a RemoteMsgHandler procedure).
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
ERR_INVALID_CHANNEL error generated if the specified channel number is invalid.
Example
The following example attempts to initiate a DDE conversation with Microsoft Excel, version 4 or
later. The goal is to store a simple text message (“Hello from MapInfo!”) in the first cell of a
worksheet that Excel is currently using, but only if that cell is currently empty. If the first cell is not
empty, we will not overwrite its current contents.
Dim chan_num, tab_marker As Integer
Dim topiclist, topicname, cell As String
chan_num = DDEInitiate("EXCEL", "System")
If chan_num = 0 Then
Note "Excel is not responding to DDE conversation."
End Program
End If
' Get a list of Excel's valid topics
topiclist = DDERequest$(chan_num, "topics")
'
'
'
'
'
'
'
'
'
'
'
'
If Excel 4 is running, topiclist might look like:
": Sheet1 System"
(if spreadsheet is still "unnamed"),or like:
": C:Orders.XLS Sheet1 System"
If Excel 5 is running, topiclist might look like:
"[Book1]Sheet1 [Book2]Sheet2 ..."
Next, extract just the first topic (for example,"Sheet1")
by extracting the text between the 1st & 2nd tabs;
or, in the case of Excel 5, by extracting the text
that appears before the first tab.
If Left$(topiclist, 1) = ":" Then
' ...then it's Excel 4.
tab_marker = InStr(3, topiclist, Chr$(9) )
If tab_marker = 0 Then
Note "No Excel documents in use! Stopping."
End Program
End If
topicname = Mid$(topiclist, 3, tab_marker - 3)
Else
' ... assume it's Excel 5.
Reference Guide
237
DDEPoke statement
tab_marker = Instr(1, topiclist, Chr$(9) )
topicname = Left$( topiclist, tab_marker - 1)
End If
' open a channel to the specific document
' (e.g., "Sheet1")
DDETerminate chan_num
chan_num = DDEInitiate("Excel", topicname)
If chan_num = 0 Then
Note "Problem communicating with " + topicname End Program
End If
' Let's examine the 1st cell in Excel.
' If cell is blank, put a message in the cell.
' If cell isn't blank, don't alter it ' just display cell contents in a MapBasic NOTE.
' Note that a "Blank cell" gets returned as a
' carriage-return line-feed sequence:
'
Chr$(13) + Chr$(10).
cell = DDERequest$( chan_num, "R1C1" )
If cell <> Chr$(13) + Chr$(10) Then
Note
"Message not sent; cell already contains:" + cell
Else
DDEPoke chan_num, "R1C1", "Hello from MapInfo!"
Note "Message sent to Excel,"+topicname+ ",R1C1."
End If
DDETerminateAll
Note: This example does not anticipate every possible obstacle. For example, Excel might
currently be editing a chart (for example, “Chart1”) instead of a worksheet, in which case we
will not be able to reference cell “R1C1”.
See Also
DDEExecute statement, DDEPoke statement, DDERequest$( ) function, DDETerminate
statement, DDETerminateAll statement
DDEPoke statement
Purpose
Sends a data value to an item in a DDE server application.
Syntax
DDEPoke channel, itemname, data
channel is an integer channel number returned by the DDEInitiate( ) function.
itemname is a string value representing the name of an item.
data is a character string to be sent to the item named in the itemname parameter.
238
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The DDEPoke statement stores the data text string in the specified DDE item.
The channel parameter must correspond to the number of a channel which was opened through the
DDEInitiate( ) function.
The itemname parameter should identify an item which is appropriate for the specified channel.
Different DDE applications support different item names; to learn what item names are supported by
a particular Windows application, refer to the documentation for that application.
In a DDE conversation with Excel, a string of the form R1C1 (for Row 1, Column 1) is a valid item
name. In a DDE conversation with another MapBasic application, the name of a global variable in
the application is a valid item name.
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
ERR_INVALID_CHANNEL error generated if the specified channel number is invalid.
Example
If Excel is already running, the following example stores a simple message (“Hello from MapInfo!”) in
the first cell of an Excel worksheet.
Dim i_chan_num As Integer
i_chan_num = DDEInitiate("EXCEL", "Sheet1")
DDEPoke i_chan_num, "R1C1", "Hello from MapInfo!"
The following example assumes that there is another MapBasic application currently in use—
”Dispatch.mbx”—and assumes that the Dispatch application has a global variable called Address.
The example below uses DDEPoke to modify the Address global variable.
i_chan_num = DDEInitiate("MapInfo","C:\DISPATCH.MBX")
DDEPoke i_chan_num, "Address", "23 Main St."
See Also
DDEExecute statement, DDEInitiate( ) function, DDERequest$( ) function
DDERequest$( ) function
Purpose
Returns a data value obtained from a DDE conversation.
Syntax
DDERequest$( channel, itemname )
channel is an integer channel number returned by the DDEInitiate( ) function.
itemname is a string representing the name of an item in the server application.
Reference Guide
239
DDERequest$( ) function
Return Value
String
Description
The DDERequest$( ) function returns a string of information obtained through a DDE conversation.
If the request is unsuccessful, the DDERequest$( ) function returns a null string.
The channel parameter must correspond to the number of a channel which was opened through the
DDEInitiate( ) function.
The itemname parameter should identify an item which is appropriate for the specified channel.
Different DDE applications support different item names; to learn what item names are supported by
a particular Windows application, refer to the documentation for that application.
The following table lists some topic and item combinations that can be used when conducting a DDE
conversation with Microsoft Excel as the server:
Topic name
“System”
Item names to use with DDERequest$( )
“Systems” returns a list of item names accepted under the
“System” topic;
“Topics” returns a list of DDE topic names accepted by
Excel, including the names of all open worksheets;
“Formats” returns a list of clipboard formats accepted by
Excel (for example, “TEXT BITMAP …”)
wks (name of a worksheet in use)
A string of the form R1C1 (for Row 1, Column 1) returns the
contents of that cell
Note: Through the DDERequest$( ) function, one MapBasic application can observe the current
values of global variables in another MapBasic application. The following table lists the topic
and item combinations that can be used when conducting a DDE conversation with MapInfo
Professional as the server.
240
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Topic name
“System”
item names to use with DDERequest$( )
“Systems” returns a list of item names accepted under the
“System” topic;
“Topics” returns a list of DDE topic names accepted by MapInfo
Professional, which includes the names of all MapBasic
applications currently in use;
“Formats” returns a list of clipboard formats accepted by MapInfo
Professional (“TEXT”);
“Version” returns the MapInfo version number, multiplied by 100.
mbx (name of .MBX in use)
“{items}” returns a list of the names of global variables in use by
the specified MapBasic application; specifying the name of a
global variable lets DDERequest$( ) return the value of the
variable
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
ERR_INVALID_CHANNEL error if the specified channel number is invalid.
ERR_CANT_INITIATE_LINK error generated if MapBasic cannot link to the topic.
Example
The following example uses the DDERequest$( ) function to obtain the current contents of the first
cell in an Excel worksheet. Note that this example will only work if Excel is already running.
Dim i_chan_num As Integer
Dim s_cell As String
i_chan_num = DDEInitiate("EXCEL", "Sheet1")
s_cell = DDERequest$(i_chan_num, "R1C1")
The following example assumes that there is another MapBasic application currently in use—
”Dispatch”—and assumes that the Dispatch application has a global variable called Address. The
example below uses DDERequest$( ) to obtain the current value of the Address global variable.
Dim i_chan_num As Integer, s_addr_copy As String
i_chan_num = DDEInitiate("MapInfo","C:\DISPATCH.MBX")
s_addr_copy = DDERequest$(i_chan_num, "Address")
See Also
DDEInitiate( ) function
Reference Guide
241
DDETerminate statement
DDETerminate statement
Purpose
Closes a DDE conversation.
Syntax
DDETerminate channel
channel is an integer channel number returned by the DDEInitiate( ) function.
Description
The DDETerminate statement closes the DDE channel specified by the channel parameter.
The channel parameter must correspond to the channel number returned by the DDEInitiate( )
function call (which initiated the conversation). Once a DDE conversation has served its purpose
and is no longer needed, the MapBasic program should terminate the conversation through the
DDETerminate statement or the DDETerminateAll statement.
Note: Multiple MapBasic applications can be in use simultaneously, and each application can open
its own DDE channels. However, a given MapBasic application may only close the DDE
channels which it opened. A MapBasic application may not close DDE channels which were
opened by another MapBasic application.
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
ERR_INVALID_CHANNEL error generated if the specified channel number is invalid.
Example
DDETerminate i_chan_num
See Also
DDEInitiate( ) function, DDETerminateAll statement
DDETerminateAll statement
Purpose
Closes all DDE conversations which were opened by the same MapBasic program.
Syntax
DDETerminateAll
242
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The DDETerminateAll statement closes all open DDE channels which were opened by the same
MapBasic application. Note that multiple MapBasic applications can be in use simultaneously, and
each application can open its own DDE channels. However, a given MapBasic application may only
close the DDE channels which it opened. A MapBasic application may not close DDE channels
which were opened by another MapBasic application.
Once a DDE conversation has served its purpose and is no longer needed, the MapBasic program
should terminate the conversation through the DDETerminate statement or the DDETerminateAll
statement.
Error Conditions
ERR_CMD_NOT_SUPPORTED error generated if not running on Windows.
See Also
DDEInitiate( ) function, DDETerminate statement
Declare Function statement
Purpose
Defines the name and parameter list of a function.
Restrictions
This statement may not be issued from the MapBasic window.
Accessing external functions (using syntax 2) is platform-dependent. DLL files may only be
accessed by applications running on Windows.
Syntax 1
Declare Function fname
([ [ ByVal ] parameter As var_type ]
[ , [ ByVal ] parameter As var_type... ] ) As return_type
fname is the name of the function.
parameter is the name of a parameter to the function.
var_type is a variable type, such as integer; arrays and custom Types are allowed.
return_type is a standard scalar variable type; arrays and custom Types are not allowed.
Syntax 2 (external routines in Windows DLLs
Declare Function fname Lib "file_name" [ Alias "function_alias" ]
( [ [ ByVal ] parameter As var_type ]
[, [ ByVal ] parameter As var_type... ] ) As return_type
fname is the name by which a function will be called.
Reference Guide
243
Declare Function statement
file_name is the name of a Windows DLL file.
function_alias is the original name of the external function.
parameter is the name of a parameter to the function.
var_type is a data type: with Windows DLLs, this can be a standard variable type or a custom Type.
return_type is a standard scalar variable type.
Description
The Declare Function statement pre-declares a user-defined MapBasic function or an external
function.
A MapBasic program can use a Function…End Function statement to create a custom function.
Every function defined in this fashion must be preceded by a Declare Function statement. For more
information on creating custom functions, see Function…End Function statement on page 311.
Parameters passed to a function are passed by reference unless you include the optional ByVal
keyword. For information on the differences between by-reference and by-value parameters, see the
MapBasic User Guide.
Calling External Functions
Using Syntax 2 (above), you can use a Declare Function statement to define an external function.
An external function is a function that was written in another language (for example, C or Pascal),
and is stored in a separate file. Once you have declared an external function, your program can call
the external function as if it were a conventional MapBasic function.
If the Declare Function statement declares an external function, the file_name parameter must
specify the name of the file containing the external function. The external file must be present at runtime.
Every external function has an explicitly assigned name. Ordinarily, the Declare Function
statement's fname parameter matches the explicit routine name from the external file. Alternately,
the Declare Function statement can include an Alias clause, which lets you call the external
function by whatever name you choose. The Alias clause lets you override an external function's
explicit name, in situations where the explicit name conflicts with the name of a standard MapBasic
function.
If the Declare Function statement includes an Alias clause, the function_alias parameter must
match the external function's original name, and the fname parameter indicates the name by which
MapBasic will call the routine.
Restrictions on Windows DLL parameters
You can pass a custom variable type as a parameter to a DLL. However, the DLL must be compiled
with “structure packing” set to the tightest packing. See the MapBasic User Guide for more
information.
244
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example defines a custom function, CubeRoot, which returns the cube root of a
number (the number raised to the one-third power).
Declare Sub Main
Declare Function CubeRoot(ByVal x As Float) As Float
Sub Main
Note Str$( CubeRoot(23) )
End Sub
Function CubeRoot(ByVal x As Float) As Float
CubeRoot = x ^ (1 / 3)
End Function
See Also
Declare Sub statement, Function…End Function statement
Declare Sub statement
Purpose
Identifies the name and parameter list of a sub procedure.
Restrictions
This statement may not be issued from the MapBasic window.
Accessing external functions (using Syntax 2) is platform-dependent. DLL files may only be
accessed by applications running on Windows.
Syntax 1
Declare Sub sub_proc
[ ( [ ByVal ] parameter As var_type [ , ... ] ) ]
sub_proc is the name of a sub procedure.
parameter is the name of a sub procedure parameter.
var_type is a standard data type or a custom Type.
Syntax 2 (external routines in Windows DLLs)
Declare Sub sub_proc Lib "file_name" [ Alias "sub_alias" ]
[ ( [ ByVal ] parameter As var_type [ , ... ] ) ]
sub_proc is the name by which an external routine will be called.
file_name is a string; the DLL name.
sub_alias is an external routine's original name.
parameter is the name of a sub procedure parameter.
var_type is a data type: with Windows DLLs, this can be a standard variable type or a custom Type.
Reference Guide
245
Declare Sub statement
Description
The Declare Sub statement establishes a sub procedure's name and parameter list. Typically, each
Declare Sub statement corresponds to an actual sub procedure which appears later in the same
program.
A MapBasic program can use a Sub…End Sub statement to create a procedure. Every procedure
defined in this manner must be preceded by a Declare Sub statement. For more information on
creating procedures, see Sub…End Sub statement on page 678.
Parameters passed to a procedure are passed by reference unless you include the optional ByVal
keyword.
Calling External Routines
Using Syntax 2 (above), you can use a Declare Sub statement to define an external routine. An
external routine is a routine that was written in another language (for example, C or Pascal), and is
stored in a separate file. Once you have declared an external routine, your program can call the
external routine as if it were a conventional MapBasic procedure.
If the Declare Sub statement declares an external routine, the file_name parameter must specify the
name of the file containing the routine. The file must be present at run-time.
Every external routine has an explicitly assigned name. Ordinarily, the Declare Sub statement's
sub_proc parameter matches the explicit routine name from the external file. The Declare Sub
statement can include an Alias clause, which lets you call the external routine by whatever name
you choose. The Alias clause lets you override an external routine's explicit name, in situations
where the explicit name conflicts with the name of a standard MapBasic function.
If the Declare Sub statement includes an Alias clause, the sub_alias parameter must match the
external routine's original name, and the sub_proc parameter indicates the name by which
MapBasic will call the routine. You can pass a custom variable type as a parameter to a DLL.
However, the DLL must be compiled with “structure packing” set to the tightest packing. For
information on custom variable types, see Type statement on page 695.
246
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Declare Sub Main
Declare Sub Cube(ByVal original As Float, cubed As Float)
Sub Main
Dim x, result As Float
Call Cube(2, result)
' result now contains the value: 8 (2 x 2 x 2)
x = 1
Call Cube(x + 2, result)
' result now contains the value: 27 (3 x 3 x 3)
End Sub
Sub Cube (ByVal original As Float, cubed As Float)
'
' Cube the "original" parameter value, and store
' the result in the "cubed" parameter.
'
cubed = original ^ 3
End Sub
See Also
Call statement, Sub…End Sub statement
Define statement
Purpose
Defines a custom keyword with a constant value.
Restrictions
You cannot issue a Define statement through the MapBasic window.
Syntax
Define identifier definition
identifier is an identifier up to 31 characters long, beginning with a letter or underscore (_).
definition is the text MapBasic should substitute for each occurrence of identifier.
Description
The Define statement defines a new identifier. For the remainder of the program, whenever
MapBasic encounters the same identifier the original definition will be substituted for the identifier.
For examples of Define statements, see the standard MapBasic definitions file, MAPBASIC.DEF.
An identifier defined through a Define statement is not case-sensitive. If you use a Define statement
to define the keyword FOO, your program can refer to the identifier as Foo or foo. You cannot use
the Define statement to re-define a MapBasic keyword, such as Set or Create. For a list of reserved
keywords, see Dim statement on page 258.
Reference Guide
247
DeformatNumber$( ) function
Examples
Your application may need to reference the mathematical value known as Pi, which has a value of
approximately 3.141593. Accordingly, you might want to use the following definition:
Define PI 3.141593
Following such a definition, you could simply type PI wherever you needed to reference the value
3.141593.
The definition portion of a Define statement can include quotes. For example, the following
statement creates a keyword with a definition including quotes:
Define FILE_NAME "World.tab"
The following Define is part of the standard definitions file, MAPBASIC.DEF. This Define provides
an easy way of clearing the Message window:
Define CLS Print Chr$(12)
DeformatNumber$( ) function
Purpose
Removes formatting from a string that represents a number.
Syntax
DeformatNumber$ ( numeric_string )
numeric_string is a string that represents a numeric value, such as “12,345,678”.
Return Value
String
Description
Returns a string that represents a number. The return value does not include thousands separators,
regardless of whether the numeric_string argument included comma separators. The return value
uses a period as the decimal separator, regardless of whether the user's computer is set up to use
another character as the decimal separator.
248
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Examples
The following example calls the Val( ) function to determine the numeric value of a string. Before
calling the Val( ) function, this example calls the DeformatNumber$( ) function to remove comma
separators from the string. (The string that you pass to the Val( ) function cannot contain comma
separators.)
Dim s_number As String
Dim f_value As Float
s_number = "1,222,333.4"
s_number = DeformatNumber$(s_number)
' the variable s_number now contains the
' string: "1222333.4"
f_value = Val(s_number)
Print f_value
See Also
FormatNumber$( ) function, Val( ) function
Delete statement
Purpose
Deletes one or more graphic objects, or one or more entire rows, from a table.
Syntax
Delete [ Object ] From table [ Where Rowid = id_number ]
table is the name of an open table.
id_number is the number of a single row (an integer value of one or more).
Description
The Delete statement deletes graphical objects or entire records from an open table.
By default, the Delete statement deletes all records from a table. However, if the statement includes
the optional Object keyword, MapBasic only deletes the graphical objects that are attached to the
table, rather than deleting the records themselves.
By default, the Delete statement affects all records in the table. However, if the statement includes
the optional Where Rowid =…clause, then only the specified row is affected by the Delete
statement.
There is an important difference between a Delete Object From statement and a Drop Map
statement. A Delete Object From statement only affects objects or records in a table, it does not
affect the table structure itself. A Drop Map statement actually modifies the table structure, so that
graphical objects may not be attached to the table.
Reference Guide
249
Dialog statement
Examples
The following Delete statement deletes all of the records from a table. At the conclusion of this
operation, the table still exists, but it is completely empty - as if the user had just created it by
choosing File > New.
Open Table "clients"
Delete From clients
Table clients
The following Delete statement deletes only the object from the tenth row of the table:
Open Table "clients"
Delete Object From clients Where Rowid = 10
Table clients
See Also
Drop Map statement, Insert statement
Dialog statement
Purpose
Displays a custom dialog box.
Restrictions
You cannot issue a Dialog statement through the MapBasic window.
Syntax
Dialog
[ Title title ]
[ Width w ] [ Height h ] [ Position x, y ]
[ Calling handler ]
Control control_clause
[ Control control_clause... ]
title is a string expression that appears in the title bar of the dialog box.
h specifies the height of the dialog box, in dialog box units (8 dialog box height units represent the
height of one character).
w specifies the width of the dialog, in dialog units (4 dialog height units represent the width of one
character).
x, y specifies the dialog box’s initial position, in pixels, representing distance from the upper-left
corner of MapInfo Professional's work area; if the Position clause is omitted, the dialog box appears
centered.
handler is the name of a procedure to call before the user is allowed to use the dialog box; this
procedure is typically used to issue Alter Control statements.
250
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Each control_clause can specify one of the following types of controls:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Button
OKButton
CancelButton
EditText
StaticText
PopupMenu
CheckBox
MultiListBox
GroupBox
RadioGroup
PenPickerm
BrushPicker
FontPicker
SymbolPicker
ListBox
See the separate discussions of those control types for more details (for example, for details on
CheckBox controls, see Control CheckBox clause on page 150; for details on Picker controls, see
Control PenPicker/BrushPicker/SymbolPicker/FontPicker clause; etc.).
Each control_clause can specify one of the following control types:
•
•
•
•
•
•
•
•
•
Button / OKButton / CancelButton
CheckBox
GroupBox
RadioGroup
EditText
StaticText
PenPicker / BrushPicker / SymbolPicker / FontPicker
ListBox / MultiListBox
PopupMenu
Description
The Dialog statement creates a dialog box, displays it on the screen, and lets the user interact with
it. The dialog box is modal; in other words, the user must dismiss the dialog box (for example, by
clicking OK or Cancel) before doing anything else in MapInfo Professional. For an introduction to
custom dialog boxes, see the MapBasic User Guide.
Anything that can appear on a dialog box is known as a control. Each dialog box must contain at
least one control (for example, an OKButton control). Individual control clauses are discussed in
separate entries (for example, see Control CheckBox clause on page 150 for a discussion of
check-box controls). As a general rule, every dialog box should include an OKButton control and/or
a CancelButton control, so that the user has a way of dismissing the dialog box.
Reference Guide
251
Dialog statement
The Dialog statement lets you create a custom dialog box. If you want to display a standard dialog
box (for example, a File > Open dialog box), use one of the following statements or functions: Ask( )
function, Note statement, ProgressBar statement, FileOpenDlg( ) function, FileSaveAsDlg( )
function, or GetSeamlessSheet( ) function).
For an introduction to the concepts behind MapBasic dialog boxes, see the MapBasic User Guide.
Sizes and Positions of Dialog Boxes and Dialog Box Controls
Within the Dialog statement, sizes and positions are stated in terms of dialog box units. A width of
four dialog box units equals the width of one character, and a height of eight dialog box units equals
the height of one character. Thus, if a dialog box control has a height of 40 and a width of 40, that
control is roughly ten characters wide and 5 characters tall. Control positions are relative to the
upper left corner of the dialog box. To place a control at the upper-left corner of a dialog box, use xand y-coordinates of zero and zero.
The Position, Height, and Width clauses are all optional. If you omit these clauses, MapBasic
places the controls at default positions in the dialog box, with subsequent control clauses appearing
further down in the dialog box.
Terminating a Dialog Box
After a MapBasic program issues a Dialog statement, the user will continue interacting with the
dialog box until one of four things happens:
•
•
•
•
The user clicks the OKButton control (if the dialog box has one);
The user clicks the CancelButton control (if the dialog box has one);
The user clicks a control with a handler that issues a Dialog Remove statement; or
The user otherwise dismisses the dialog box (for example, by pressing Esc on a dialog box that
has a CancelButton).
To force a dialog box to remain on the screen after the user has clicked OK or Cancel, assign a
handler procedure to the OKButton or CancelButton control and have that handler issue a Dialog
Preserve statement.
Reading the User’s Input
After a Dialog statement, call the CommandInfo( ) function to determine whether the user clicked
OK or Cancel to dismiss the dialog box. If the user clicked OK, the following function call returns
TRUE:
CommandInfo(CMD_INFO_DLG_OK)
There are two ways to read values entered by the user: Include Into clauses in the Dialog
statement, or call the ReadControlValue( ) function from a handler procedure.
If a control specifies the Into clause, and if the user clicks the OKButton, MapInfo Professional
stores the control’s final value in a program variable.
Note: MapInfo Professional only updates the variable if the user clicks OK. Also, MapInfo
Professional only updates the variable after the dialog box terminates.
To read a control's value from within a handler procedure, call the ReadControlValue( ) function.
252
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Specifying Hotkeys for Controls
When a MapBasic application runs on MapInfo, dialog boxes can assign hotkeys to the various
controls. A hotkey is a convenience allowing the user to choose a dialog box control by pressing key
sequences rather than clicking with the mouse.
To specify a hotkey for a control, include the ampersand character (&) in the title for that control.
Within the Title clause, the ampersand should appear immediately before the character which is to
be used as a hotkey character. Thus, the following Button clause defines a button which the user
can choose by pressing Alt-R:
Control Button
Title "&Reset"
Although an ampersand appears within the Title clause, the final dialog box does not show the
ampersand. If you need to display an ampersand character in a control (for example, if you want a
button to read “Find & Replace”), include two successive ampersand characters in the Title clause:
Title "Find && Replace"
If you position a StaticText control just before or above an EditText control, and you define the
StaticText control with a hotkey designation, the user is able to jump to the EditText control by
pressing the hotkey sequence.
Specifying the Tab Order
The user can press the Tab key to move the keyboard focus through the dialog box. The focus
moves from control to control according to the dialog box's tab order.
Tab order is defined by the order of the Control clauses in the Dialog statement. When the focus is
on the third control, pressing Tab moves the focus to the fourth control, etc. If you want to change the
tab order, change the order of the Control clauses.
Examples
The following example creates a simple dialog box with an EditText control. In this example, none of
the Control clauses use the optional Position clause; therefore, MapBasic places each control in a
default position.
Dialog
Title "Search"
Control StaticText
Title "Enter string to find:"
Control EditText
Value gs_searchfor 'this is a Global String variable
Into gs_searchfor
Control OKButton
Control CancelButton
If CommandInfo(CMD_INFO_DLG_OK) Then
' ...then the user clicked OK, and the variable
' gs_searchfor contains the text the user entered.
End If
Reference Guide
253
Dialog statement
The following program demonstrates the syntax of all of MapBasic's control types.
Include "mapbasic.def"
Declare Sub reset_sub ‘resets dialog to default settings
Declare Sub ok_sub ' notes values when user clicks OK.
Declare Sub Main
Sub Main
Dim s_title As String 'the title of the map
Dim l_showlegend As Logical 'TRUE means include legend
Dim i_details As SmallInt '1 = full details; 2 = partial
Dim i_quarter As SmallInt '1=1st qrtr, etc.
Dim i_scope As SmallInt '1=Town;2=County; etc.
Dim sym_variable As Symbol
Dialog
Title "Map Franchise Locations"
Control StaticText
Title "Enter Map Title:"
Position 5, 10
Control EditText
Value "New Franchises, FY 95"
Into s_title
ID 1
Position 65, 8 Width 90
Control GroupBox
Title "Level of Detail"
Position 5, 30 Width 70 Height 40
Control RadioGroup
Title "&Full Details;&Partial Details"
Value 2
Into i_details
ID 2
Position 12, 42 Width 60
Control StaticText
Title "Show Franchises As:" Position 95, 30
Control SymbolPicker
Position 95, 45
Into sym_variable
ID 3
Control StaticText
Title "Show Results For:"
Position 5, 80
Control ListBox
Title "First Qrtr;2nd Qrtr;3rd Qrtr;4th Qrtr"
Value 4
Into i_quarter
ID 4
Position 5, 90 Width 65 Height 35
254
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Control StaticText
Title "Include Map Layers:"
Position 95, 80
Control MultiListBox
Title "Streets;Highways;Towns;Counties;States"
Value 3
ID 5
Position 95, 90 Width 65 Height 35
Control StaticText
Title "Scope of Map:"
Position 5, 130
Control PopupMenu
Title "Town;County;Territory;Entire State"
Value 2
Into i_scope
ID 6
Position 5, 140
Control CheckBox
Title "Include &Legend"
Into l_showlegend
ID 7
Position 95, 140
Control Button
Title "&Reset"
Calling reset_sub
Position 10, 165
Control OKButton
Position 65, 165
Calling ok_sub
Control CancelButton
Position 120, 165
If CommandInfo(CMD_INFO_DLG_OK) Then
' ... then the user clicked OK.
Else
' ... then the user clicked Cancel.
End If
End Sub
Sub reset_sub
' here, you could use Alter Control statements
' to reset the controls to their original state.
End Sub
Sub ok_sub
' Here, place code to handle user clicking OK
End Sub
The preceding program produces the following dialog box.
Reference Guide
255
Dialog Preserve statement
See Also
Alter Control statement, Ask( ) function, Dialog Preserve statement, Dialog Remove
statement, FileOpenDlg( ) function, FileSaveAsDlg( ) function, Note statement,
ReadControlValue( ) function
Dialog Preserve statement
Purpose
Reactivates a custom dialog box after the user clicked OK or Cancel.
Syntax
Dialog Preserve
Restrictions
This statement may only be issued from within a sub procedure that acts as a handler for an
OKButton or CancelButton dialog box control.
You cannot issue this statement from the MapBasic window.
Description
The Dialog Preserve statement allows the user to resume using a custom dialog box (which was
created through a Dialog statement) even after the user clicked the OKButton or CancelButton
control.
256
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The Dialog Preserve statement lets you “confirm” the user's OK or Cancel action. For example, if
the user clicks Cancel, you may wish to display a dialog box asking a question such as “Do you
want to lose your changes?” If the user chooses “No” on the confirmation dialog box, the application
should reactivate the original dialog box. You can provide this functionality by issuing a Dialog
Preserve statement from within the CancelButton control's handler procedure.
Example
The following procedure could be used as a handler for a CancelButton control.
Sub confirm_cancel
If Ask("Do you really want to lose your changes?",
"Yes", "No") = FALSE Then
Dialog Preserve
End If
End Sub
See Also
Alter Control statement, Dialog statement, Dialog Remove statement, ReadControlValue( )
function
Dialog Remove statement
Purpose
Removes a custom dialog from the screen.
Syntax
Dialog Remove
Restrictions
This statement may only be issued from within a sub procedure that acts as a handler for a dialog
box control. You cannot issue this statement from the MapBasic window.
Description
The Dialog Remove statement removes the dialog box created by the most recent Dialog
statement. A dialog box disappears automatically after the user clicks on an OKButton control or a
CancelButton control. Use the Dialog Remove statement (within a dialog box control's handler
routine) to remove the dialog box before the user clicks OK or Cancel. This is useful, for example, if
you have a dialog box with a ListBox control, and you want the dialog box to come down if the user
double-clicks an item in the list.
Note: Dialog Remove signals to remove the dialog box after the handler sub procedure returns. It
does not remove the dialog box instantaneously.
Reference Guide
257
Dim statement
Example
The following procedure is part of the sample program NVIEWS.MB. It handles the ListBox control in
the Named Views dialog box. When the user single-clicks a list item, this handler procedure enables
various buttons on the dialog box. When the user double-clicks a list item, this handler uses a
Dialog Remove statement to dismiss the dialog box.
Note: MapInfo Professional calls this handler procedure for click events and for double-click
events.
Sub listbox_handler
Dim i As SmallInt
Alter Control 2 Enable
Alter Control 3 Enable
If CommandInfo(CMD_INFO_DLG_DBL) = TRUE Then
'
' ... then the user double-clicked.
'
i = ReadControlValue(1)
Dialog Remove
Call go_to_view(i)
End If
End Sub
See Also
Alter Control statement, Dialog statement, Dialog Preserve statement, ReadControlValue( )
function
Dim statement
Purpose
Defines one or more variables.
Restrictions
When you issue Dim statements through the MapBasic window, you can only define one variable
per Dim statement, although a Dim statement within a compiled program may define multiple
variables. You cannot define array variables using the MapBasic window.
Syntax
Dim var_name [ , var_name ... ] As var_type
[ , var_name [ , var_name ... ] As var_type ... ]
var_name is the name of a variable to define.
var_type is a standard or custom variable Type.
Description
A Dim statement declares one or more variables. The following table summarizes the types of
variables which you can declare through a Dim statement.
258
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Location of Dim Statements and Scope of Variables
Variable Type
Description
SmallInt
Whole numbers from -32768 to 32767 (inclusive); stored in 2 bytes.
Integer
Whole numbers from -2,147,483,647 to +2,147,483,647 (inclusive); stored in 4
bytes.
Float
Floating point value; stored in eight-byte IEEE format.
String
Variable-length character string, up to 32768 bytes long.
String * length
Fixed-length character string (where length dictates the length of the string, in
bytes, up to 32768 bytes); fixed-length strings are padded with trailing blanks.
Logical
TRUE or FALSE, stored in 1 byte: zero=FALSE, non-zero=TRUE.
Date
Date, stored in four bytes: two bytes for the year, one byte for the month, one
byte for the day.
Object
Graphical object (Point, Region, Line, Polyline, Arc, Rectangle, Rounded
Rectangle, Ellipse, Text, or Frame).
Alias
Column name.
Pen
Pen (line) style setting.
Brush
Brush (fill) style setting.
Font
Font (text) style setting.
Symbol
Symbol (point-marker) style setting.
The Dim statement which defines a variable must precede any other statements which use that
variable. Dim statements usually appear at the top of a procedure or function.
If a Dim statement appears within a Sub…End Sub statement or within a Function…End
Function statement, the statement defines variables that are local in scope. Local variables may
only be accessed from within the procedure or function that contained the Dim statement.
If a Dim statement appears outside of any procedure or function definition, the statement defines
variables that are module-level in scope. Module-level variables can be accessed by any procedure
or function within a program module (i.e., within the .MB program file).
To declare global variables (variables that can be accessed by any procedure or function in any of
the modules that make up a project), use the Global statement.
Reference Guide
259
Dim statement
Declaring Multiple Variables and Variable Types
A single Dim statement can declare two or more variables that are separated by commas. You also
can define variables of different types within one Dim statement by grouping like variables together,
and separating the different groups with a comma after the variable type:
Dim jointer, i_min, i_max As Integer, s_name As String
Array Variables
MapBasic supports one-dimensional array variables. To define an array variable, add a pair of
parentheses immediately after the variable name. To specify an initial array size, include a constant
integer expression between the parentheses.
The following example declares an array of ten float variables, then assigns a value to the first
element in the array:
Dim f_stats(10) As Float
f_stats(1) = 17.23
The number that appears between the parentheses is known as the subscript. The first element of
the array is the element with a subscript of one (as shown in the example above).
To re-size an array, use the ReDim statement. To determine the current size of an array, use the
UBound( ) function. If the Dim statement does not specify an initial array size, the array will initially
contain no members; in such a case, you will not be able to store any data in the array until re-sizing
the array with a ReDim statement. A MapBasic array can have up to 32,767 items.
String Variables
A string variable can contain a text string up to 32 kilobytes in length. However, there is a limit to how
long a string constant you can specify in a simple assignment statement. The following example
performs a simple string variable assignment, where a constant string expression is assigned to a
string variable:
Dim status As String
status = "This is a string constant ... "
In this type of assignment, the constant string expression to the right of the equal sign has a
maximum length of 256 characters.
MapBasic, like other BASIC languages, pads fixed-length string variables with blanks. In other
words, if you define a 10-byte string variable, then assign a five-character string to that variable, the
variable will actually be padded with five spaces so that it fills the space allotted. (This feature makes
it easier to format text output in such a way that columns line up).
260
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Variable-length string variables, however, are not padded in this fashion. This difference can affect
comparisons of strings; you must exercise caution when comparing fixed-length and variable-length
string variables. In the following program, the If…Then statement would determine that the two
strings are not equal:
Dim s_var_len As String
Dim s_fixed_len As String * 10
s_var_len = "testing"
s_fixed_len = "testing"
If s_var_len = s_fixed_len Then
Note "strings are equal" ' this won't happen
Else
Note "strings are NOT equal" ' this WILL happen
End If
Restrictions on Variable Names
Variable names are case-insensitive. Thus, if a Dim statement defines a variable called abc, the
program may refer to that variable as abc, ABC, or Abc.
Each variable name can be up to 31 characters long, and can include letters, numbers, and the
underscore character ( _ ). Variable names can also include the punctuation marks $, %, &, !, #, and
@, but only as the final character in the name. A variable name may not begin with a number.
Many MapBasic language keywords, such as Open, Close, Set, and Do, are reserved words which
may not be used as variable names. If you attempt to define a variable called Set, MapBasic will
generate an error when you compile the program. The table below summarizes the MapBasic
keywords which may not be used as variable names.
Add
Alter
Close
Browse
Call
Create
DDE
DDEExecute
DDEPoke
DDETerminate
DDETerminateAll
Declare
Delete
Dialog
Dim
Do
Drop
Else
ElseIf
End
Error
Event
Exit
Export
Fetch
Find
For
Function
Get
Global
Goto
Graph
If
Import
Insert
Layout
Map
Menu
Note
Objects
OnError
Open
Pack
Print
PrintWin
ProgressBar
Put
Reference Guide
261
Dim statement
ReDim
Register
Reload
Remove
Rename
Resume
Rollback
Run
Save
Seek
Select
Set
Shade
StatusBar
Stop
Sub
Type
Update
While
In some BASIC languages, you can dictate a variable's type by ending the variable with one of the
punctuation marks listed above. For example, some BASIC languages assume that any variable
named with a dollar sign (for example, LastName$) is a string variable. In MapBasic, however, you
must declare every variable's type explicitly, through the Dim statement.
Initial Values of Variables
MapBasic initializes numeric variables to a value of zero when they are defined. Variable-length
string variables are initialized to an empty string, and fixed-length string variables are initialized to all
spaces.
Object and style variables are not automatically initialized. You must initialize Object and style
variables before making references to those variables.
Example
' Below is a custom Type definition, which creates
' a new data type known as Person
Type Person
Name As String
Age As Integer
Phone As String
End Type
' The next Dim statement creates a Person variable
Dim customer As Person
' This Dim creates an array of Person variables:
Dim users(10) As Person
' this Dim statement defines an integer variable
' "counter", and an integer array "counters" :
Dim counter, counters(10) As Integer
' the next statement assigns the "Name" element
' of the first member of the "users" array
users(1).Name = "Chris"
See Also
Global statement, ReDim statement, Type statement, UBound( ) function
262
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Distance( ) function
Purpose
Returns the distance between two locations.
Syntax
Distance ( x1, y1, x2, y2, unit_name )
x1 and x2 are x-coordinates (for example, longitude).
y1 and y2 are y-coordinates (for example, latitude).
unit_name is a string representing the name of a distance unit (for example, “km”).
Return Value
Float
Description
The Distance( ) function calculates the distance between two locations.
The function returns the distance measurement in the units specified by the unit_name parameter;
for example, to obtain a distance in miles, specify “mi” as the unit_name parameter. See Set
Distance Units statement on page 592 for the list of available unit names.
The x- and y-coordinate parameters must use MapBasic's current coordinate system. By default,
MapInfo Professional expects coordinates to use a Longitude/Latitude coordinate system. You can
reset MapBasic's coordinate system through the Set CoordSys statement.
If the current coordinate system is an earth coordinate system, Distance( ) returns the great-circle
distance between the two points. A great-circle distance is the shortest distance between two points
on a sphere. (A great circle is a circle that goes around the earth, with the circle's center at the
center of the earth; a great-circle distance between two points is the distance along the great circle
which connects the two points.)
For the most part, MapInfo Professional performs a Cartesian or Spherical operation. Generally, a
spherical operation is performed unless the coordinate system is NonEarth, in which case, a
Cartesian operation is performed.
Example
Dim dist, start_x, start_y, end_x, end_y As Float
Open Table "cities"
Fetch First From cities
start_x = CentroidX(cities.obj)
start_y = CentroidY(cities.obj)
Fetch Next From cities
end_x = CentroidX(cities.obj)
end_y = CentroidY(cities.obj)
dist = Distance(start_x,start_y,end_x,end_y,"mi")
Reference Guide
263
Do Case…End Case statement
See Also
Area( ) function, ObjectLen( ) function, Set CoordSys statement, Set Distance Units
statement
Do Case…End Case statement
Purpose
Decides which group of statements to execute, based on the current value of an expression.
Restrictions
You cannot issue a Do Case statement through the MapBasic window.
Syntax
Do Case do_expr
Case case_expr [ , case_expr ]
statement_list
[ Case ... ]
[ Case Else
statement_list ]
End Case
do_expr is an expression.
case_expr is an expression representing a possible value for do_expr.
statement_list is a group of statements to carry out under the appropriate circumstances.
Description
The Do Case statement is similar to the If…Then statement, in that Do Case tests for the existence
of certain conditions, and decides which statements to execute (if any) based on the results of the
test. MapBasic's Do Case statement is analogous to the BASIC language's Select Case statement.
(In MapBasic, the name of the statement was changed to avoid conflicting with the Select
statement).
In executing a Do Case statement, MapBasic examines the first Case case_expr clause. If one of
the expressions in the Case case_expr clause is equal to the value of the do_expr expression, that
case is considered a match. Accordingly, MapBasic executes the statements in that Case's
statement_list, and then jumps down to the first statement following the End Case statement.
If none of the expressions in the first Case case_expr clause equal the do_expr expression,
MapBasic tries to find a match in the following Case case_expr clause. MapBasic will test each
Case case_expr clauses in succession, until one of the cases is a match or until all of the cases are
exhausted.
MapBasic will execute at most one statement_list from a Do Case statement. Upon finding a
matching Case, MapBasic will execute that Case's statement_list, and then jump immediately down
to the first statement following End Case.
264
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If none of the case_expr expressions are equal to the do_expr expression, none of the cases will
match, and thus no statement_list will be executed. However, if a Do Case statement includes a
Case Else clause, and if none of the Case case_expr clauses match, then MapBasic will carry out
the statement list from the Case Else clause.
Note that a Do Case statement of this form:
Do Case expr1
Case expr2
statement_list1
Case expr3, expr4
statement_list2
Case Else
statement_list3
End Case
would have the same effect as an If…Then statement of this form:
If expr1 = expr2 Then
statement_list1
ElseIf expr1 = expr3 Or expr1 = expr4 Then
statement_list2
Else
statement_list3
End If
Example
The following example builds a text string such as “First Quarter”, “Second Quarter”, etc., depending
on the current date.
Dim cur_month As Integer, msg As String
cur_month = Month( CurDate( ) )
Do Case cur_month
Case 1, 2, 3
msg = "First Quarter"
Case 4, 5, 6
msg = "Second Quarter"
Case 7, 8, 9
msg = "Third Quarter"
Case Else
msg = "Fourth Quarter"
End Case
See Also
If…Then statement
Reference Guide
265
Do…Loop statement
Do…Loop statement
Purpose
Defines a loop which will execute until a specified condition becomes TRUE (or FALSE).
Restrictions
You cannot issue a Do Loop statement through the MapBasic window.
Syntax 1
Do
statement_list
Loop [ { Until | While } condition ]
Syntax 2
Do [ { Until | While } condition ]
statement_list
Loop
statement_list is a group of statements to be executed zero or more times.
condition is a conditional expression which controls when the loop terminates.
Description
The Do…Loop statement provides loop control. Generally speaking, the Do…Loop repeatedly
executes the statements in a statement_list as long as a While condition remains TRUE (or,
conversely, the loop repeatedly executes the statement_list until the Until condition becomes
TRUE).
If the Do…Loop does not contain the optional Until / While clause, the loop will repeat indefinitely.
In such a case, a flow control statement, such as Goto statement or Exit Do statement, will be
needed to halt or exit the loop. The Exit Do statement halts any Do…Loop immediately (regardless
of whether the loop has an Until / While clause), and resumes program execution with the first
statement following the Loop clause.
As indicated above, the optional Until / While clause may either follow the Do keyword or the Loop
keyword. The position of the Until / While clause dictates whether MapBasic tests the condition
before or after executing the statement_list. This is of particular importance during the first iteration
of the loop. A loop using the following syntax:
Do
statement_list
Loop While condition
will execute the statement_list and then test the condition. If the condition is TRUE, MapBasic will
continue to execute the statement_list until the condition becomes FALSE. Thus, a Do…Loop using
the above syntax will execute the statement_list at least once.
266
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
By contrast, a Do…Loop of the following form will only execute the statement_list if the condition is
TRUE.
Do While condition
statement_list
Loop
Example
The following example uses a Do…Loop statement to read the first ten records of a table.
Dim sum As Float, counter As Integer
Open Table "world"
Fetch First From world
counter = 1
Do
sum = sum + world.population
Fetch Next From world
counter = counter + 1
Loop While counter <= 10
See Also
Exit Do statement, For…Next statement
Drop Index statement
Purpose
Deletes an index from a table.
Syntax
Drop Index table( column )
table is the name of an open table.
column is the name of a column in that table.
Description
The Drop Index statement deletes an existing index from an open table. Dropping an index reduces
the amount of disk space occupied by a table. (To re-create that index at a later time, issue a Create
Index statement.)
Note: MapInfo Professional cannot drop an index if the table has unsaved edits. Use the Commit
Table statement to save edits.
The Drop Index statement takes effect immediately; no save operation is required. You cannot undo
the effect of a Drop Index statement by selecting File > Revert or Edit > Undo. Similarly, the
MapBasic Rollback statement will not undo the effect of a Drop Index statement.
Reference Guide
267
Drop Map statement
Example
The following example deletes the index from the Name field of the World table.
Open Table "world"
Drop Index world(name)
See Also
Create Index statement
Drop Map statement
Purpose
Deletes all graphical objects from a table. Cannot be used on linked tables.
Syntax
Drop Map table
table is the name of an open table.
Description
A Drop Map statement deletes all graphical objects (points, lines, regions, circles, etc.) from an
open table, and modifies the table structure so that graphical objects may not be attached to the
table.
Note: The Drop Map statement takes effect immediately; no save operation is required. You
cannot undo the effect of a Drop Map statement by selecting File > Revert or Edit > Undo.
Similarly, the MapBasic Rollback statement will not undo the effect of a Drop Map
statement. Accordingly, you should be extremely cautious when using the Drop Map
statement.
After performing a Drop Map operation, you will no longer be able to display the corresponding table
in a Map window; the Drop Map statement modifies the table's structure so that objects may no
longer be associated with the table. (A subsequent Create Map statement will restore the table's
ability to contain graphical objects; however, a Create Map statement will not restore the graphical
objects which were discarded during a Drop Map operation.) The Drop Map statement does not
affect the number of records in a table. You still can browse a table after performing Drop Map.
If you wish to delete all of the graphical objects from a table, but you intend to attach new graphical
objects to the same table, use Delete Object instead of Drop Map.
The Drop Map statement does not work on linked tables.
Example
Open Table "clients"
Drop Map clients
268
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Create Map statement, Create Table statement, Delete statement
Drop Table statement
Purpose
Deletes a table in its entirety.
Syntax
Drop Table table
table is the name of an open table.
Description
The Drop Table statement completely erases the specified table from the computer's disk. The table
must already be open.
Note that if a table is based on a pre-existing database or spreadsheet file, the Drop Table
statement will delete the original file as well as the component files which make it a table. In other
words, a Drop Table operation may have the effect of deleting a file which is used outside of
MapInfo Professional.
The Drop Table statement takes effect immediately; no save operation is required. You cannot undo
the effect of a Drop Table statement by selecting File > Revert or Edit > Undo. Similarly, the
MapBasic Rollback statement will not undo the effect of a Drop Table statement. You should be
extremely cautious when using the Drop Table statement.
Note: Many MapInfo table operations (for example, Select) store results in temporary tables (for
example, Query1). Temporary tables are deleted automatically when you exit MapInfo
Professional; you do not need to use the Drop Table statement to delete temporary tables.
The Drop Table statement cannot be used to delete a table that is actually a “view.” For example, a
StreetInfo table (such as SF_STRTS) is actually a view, combining two other tables (SF_STRT1 and
SF_STRT2). So, you could not delete the SF_STRTS table by using the Drop Table statement.
Example
Open Table "clients"
Drop Table clients
See Also
Create Table statement, Delete statement, Kill statement
Reference Guide
269
End MapInfo statement
End MapInfo statement
Purpose
This statement halts MapInfo Professional.
Syntax
End MapInfo [ Interactive ]
Description
The End MapInfo statement halts MapInfo Professional.
An application can define a special procedure called EndHandler, which is executed automatically
when MapInfo Professional terminates. Accordingly, when an application issues an End MapInfo
statement, MapInfo Professional automatically executes any sleeping EndHandler procedures
before shutting down. See EndHandler procedure on page 271 for more information.
If an application issues an End MapInfo statement, and one or more tables have unsaved edits,
MapInfo Professional prompts the user to save or discard the table edits.
If you include the Interactive keyword, and if there are unsaved themes or labels, MapInfo
Professional prompts the user to save or discard the unsaved work. However, if the user's system is
set up so that it automatically saves MAPINFOW.WOR on exit, this prompt does not appear. If you
omit the Interactive keyword, this prompt does not appear.
To halt a MapBasic application without exiting MapInfo Professional, use the End Program
statement.
See Also
End Program statement, EndHandler procedure
End Program statement
Purpose
Halts a MapBasic application.
Restrictions
The End Program statement may not be issued from the MapBasic window.
Syntax
End Program
270
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The End Program statement halts execution of a MapBasic program. A MapBasic application can
add items to MapInfo Professional menus, and even add entirely new menus to the menu bar.
Typically, a menu item added in this fashion calls a sub procedure from a MapBasic program. Once
a MapBasic application has connected a procedure to the menu in this fashion, the application is
said to be “sleeping.”
If any procedure in a MapBasic application issues an End Program statement, that entire
application is halted—even if “sleeping” procedures have been attached to custom menu items.
When an application halts, MapInfo Professional automatically removes any menu items created by
that application.
If an application defines a procedure named EndHandler, MapBasic automatically calls that
procedure when the application halts, for whatever reason the application halts.
See Also
End MapInfo statement, EndHandler procedure
EndHandler procedure
Purpose
A reserved procedure name, called automatically when an application terminates.
Syntax
Declare Sub EndHandler
Sub EndHandler
statement_list
End Sub
statement_list is a list of statements to execute when the application terminates.
Description
EndHandler is a special-purpose MapBasic procedure name.
If the user runs an application containing a sub procedure named EndHandler, the EndHandler
procedure is called automatically when the application ends. This happens whether the user exited
MapInfo Professional or another procedure in the application issued an End Program statement.
Note: Multiple MapBasic applications can be “sleeping” at the same time. When MapInfo
Professional terminates, MapBasic automatically calls all sleeping EndHandler procedures,
one after another.
See Also
RemoteMsgHandler procedure, SelChangedHandler procedure, ToolHandler procedure,
WinChangedHandler procedure, WinClosedHandler procedure
Reference Guide
271
EOF( ) function
EOF( ) function
Purpose
Returns TRUE if MapBasic tried to read past the end of a file, FALSE otherwise.
Syntax
EOF( filenum )
filenum is the number of a file opened through the Open File statement.
Return Value
Logical
Description
The EOF( ) function returns a logical value indicating whether the End-Of-File condition exists for the
specified file. The integer filenum parameter represents the number of an open file.
If a Get statement tries to read past the end of the specified file, the EOF( ) function returns a value
of TRUE; otherwise, EOF( ) returns a value of FALSE.
The EOF( ) function works with open files; when you wish to check the current position of an open
table, use the EOT( ) function.
For an example of calling EOF( ), see the sample program NVIEWS.MB (Named Views).
Error Conditions
ERR_FILEMGR_NOTOPEN error generated if the specified file is not open.
See Also
EOT( ) function, Open File statement
EOT( ) function
Purpose
Returns TRUE if MapBasic has reached the end of the specified table, FALSE otherwise.
Syntax
EOT( table )
table is the name of an open table.
Return Value
Logical
272
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The EOT( ) function returns TRUE or FALSE to indicate whether MapInfo Professional has tried to
read past the end of the specified table. The table parameter represents the name of an open table.
Error Conditions
ERR_TABLE_NOT_FOUND error generated if the specified table is not available
Example
The following example uses the logical result of the EOT( ) function to decide when to terminate a
loop. The loop repeatedly fetches the next record in a table, until the point when the EOT( ) function
indicates that the program has reached the end of the table.
Dim f_total As Float
Open Table "customer"
Fetch First From customer
Do While Not EOT(customer)
f_total = f_total + customer.order
Fetch Next From customer
Loop
See Also
EOF( ) function, Fetch statement, Open File statement, Open Table statement
EPSGToCoordSysString$( ) function
Purpose
Converts a string containing a Spatial Reference System into a CoordSys clause that can be used
with any MapBasic function or statement.
Syntax
EPSGToCoordSysString$( epsg_string )
epsg_string is a String describing a Spatial Reference System (SRS) for any supported coordinate
systems. SRS strings are also referred to as EPSG (European Petroleum Survey Group) strings (for
example, epsg:2600). For a complete list of EPSG codes used with MapInfo Professional see the
MAPINFOW.PRJ file in your MapInfo Professional installation. The EPSG codes are identified by a
“\p” followed by a number.
Description
The EPSGToCoordSysString$( ) is used to convert a SRS String into a CoordSys clause that can
be used in any MapBasic function or statement that takes a CoordSys clause as an input.
Example
The following example sets the coordinate system of a map to Earth Projection 1, 104.
run command("Set Map " +
Reference Guide
EPSGToCoordSysString$("EPSG:4326"))
273
Erase( ) function
See Also
CoordSys clause
Erase( ) function
Purpose
Returns an object created by erasing part of another object.
Syntax
Erase( source_object, eraser_object )
source_object is an object, part of which is to be erased; cannot be a point or text object.
eraser_object is a closed object, representing the area that will be erased.
Return Value
Returns an object representing what remains of source_object after erasing eraser_object.
Description
The Erase( ) function erases part of an object, and returns an object expression representing what
remains of the object.
The source_object parameter can be a linear object (line, polyline, or arc) or a closed object (region,
rectangle, rounded rectangle, or ellipse), but cannot be a point object or text object. The
eraser_object must be a closed object. The object returned retains the color and pattern styles of the
source_object.
Example
' In this example, o1 and o2 are Object variables
' that already contain Object expressions.
If o1 Intersects o2 Then
If o1 Entirely Within o2 Then
Note "Cannot Erase; nothing would remain."
Else
o3 = Erase( o1, o2 )
End If
Else
Note "Cannot Erase; objects do not intersect."
End If
See Also
Objects Erase statement, Objects Intersect statement
274
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Err( ) function
Purpose
Returns a numeric code, representing the current error.
Syntax
Err( )
Return Value
Integer
Description
The Err( ) function returns the numeric code indicating which error occurred most recently.
By default, a MapBasic program which generates an error will display an error message and then
halt. However, by issuing an OnError statement, a program can set up an error handling routine to
respond to error conditions. Once an error handling routine is specified, MapBasic jumps to that
routine automatically in the event of an error. The error handling routine can then call the Err( )
function to determine which error occurred.
The Err( ) function can only return error codes while within the error handler. Once the program
issues a Resume statement to return from the error handling routine, the error condition is reset.
This means that if you call the Err( ) function outside of the error handling routine, it returns zero.
Some statement and function descriptions within this document contain an Error Conditions heading
(just before the Example heading), listing error codes related to that statement or function. However,
not all error codes are identified in the Error Conditions heading.
Some MapBasic error codes are only generated under narrowly-defined, specific circumstances; for
example, the ERR_INVALID_CHANNEL error is only generated by DDE-related functions or
statements. If a statement might generate such an “unusual” error, the discussion for that statement
will identify the error under the Error Conditions heading.
However, other MapBasic errors are “generic”, and might be generated under a variety of broadlydefined circumstances. For example, many functions, such as Area( ) function and ObjectInfo( )
function, take an Object expression as a parameter. Any such function will generate the
ERR_FCN_OBJ_FETCH_FAILED error if you pass an expression of the form tablename.obj as a
parameter, when the current row from that table has no associated object. In other words, any
function which takes an Object parameter might generate the ERR_FCN_OBJ_FETCH_FAILED
error. Since the ERR_FCN_OBJ_FETCH_FAILED error can occur in so many different places,
individual functions do not explicitly identify the error.
Similarly, there are two math errors—ERR_FP_MATH_LIB_DOMAIN and
ERR_FP_MATH_LIB_RANGE—which can occur as a result of an invalid numeric parameter. These
errors might be generated by calls to any of the following functions: Acos( ) function, Asin( )
function, Atn( ) function, Cos( ) function, Exp( ) function, Log( ) function, Sin( ) function,
Sqr( ) function, or Tan( ) function.
Reference Guide
275
Error statement
The complete list of potential MapBasic error codes is included in the file ERRORS.DOC.
See Also
Error statement, Error$( ) function, OnError statement
Error statement
Purpose
Simulates the occurrence of an error condition.
Syntax
Error error_num
error_num is an integer error number.
Description
The Error statement simulates the occurrence of an error.
If an error-handling routine has been enabled through an OnError statement, the simulated error
will cause MapBasic to perform the appropriate error-handling routine. If no error handling routine
has been enabled, the error simulated by the Error statement will cause the MapBasic application to
halt after displaying an appropriate error message.
See Also
Err( ) function, Error$( ) function, OnError statement
Error$( ) function
Purpose
Returns a message describing the current error.
Syntax
Error$( )
Return Value
String
Description
The Error$( ) function returns a character string describing the current run-time error, if an error has
occurred. If no error has occurred, the Error$( ) function returns a null string.
The Error$( ) function should only be called from within an error handling routine. See Err( )
function on page 275 for more information.
276
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Err( ) function, Error statement, OnError statement
Exit Do statement
Purpose
Exits a Do…Loop statement prematurely.
Restrictions
You cannot issue an Exit Do statement through the MapBasic window.
Syntax
Exit Do
Description
An Exit Do statement terminates a Do…Loop statement. Upon encountering an Exit Do
statement, MapBasic will jump to the first statement following the Do…Loop statement. Note that
the Exit Do statement is only valid within a Do…Loop statement.
Do…Loop statements can be nested; that is, a Do…Loop statement can appear within the body
of another, “outer” Do…Loop statement. An Exit Do statement only halts the iteration of the
nearest Do…Loop statement. Thus, in an arrangement of this sort:
Do While condition1
:
Do While condition2
:
If error_condition
Exit Do
End If
:
Loop
:
Loop
the Exit Do statement will halt the inner loop (Do While condition2) without necessarily affecting the
outer loop (Do While condition1).
See Also
Do…Loop statement, Exit For statement, Exit Sub statement
Reference Guide
277
Exit For statement
Exit For statement
Purpose
Exits a For…Next statement prematurely.
Restrictions
You cannot issue an Exit For statement through the MapBasic window.
Syntax
Exit For
Description
An Exit For statement terminates a For…Next statement. Upon encountering an Exit For
statement, MapBasic will jump to the first statement following the For…Next statement. Note that
the Exit For statement is only valid within a For…Next statement.
For…Next statements can be nested; that is, a For…Next statement can appear within the body
of another, “outer” For…Next statement. Note that an Exit For statement only halts the iteration of
the nearest For…Next statement. Thus, in an arrangement of this sort:
For x = 1 to 5
:
For y = 2 to 10 step 2
:
If error_condition
Exit For
End If
:
Next
:
Next
the Exit For statement will halt the inner loop (For y = 2 to 10 step 2) without necessarily
affecting the outer loop (For x = 1 to 5).
See Also
Exit Do statement, For…Next statement
Exit Function statement
Purpose
Exits a Function…End Function statement.
Restrictions
You cannot issue an Exit Function statement through the MapBasic window.
278
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Syntax
Exit Function
Description
An Exit Function statement causes MapBasic to exit the current function. Accordingly, an Exit
Function statement may only be issued from within a Function…End Function statement.
Function calls may be nested; in other words, one function can call another function, which, in turn,
can call yet another function. Note that a single Exit Function statement exits only the current
function.
See Also
Function…End Function statement
Exit Sub statement
Purpose
Exits a Sub…End Sub statement.
Restrictions
You cannot issue an Exit Sub statement through the MapBasic window.
Syntax
Exit Sub
Description
An Exit Sub statement causes MapBasic to exit the current sub procedure. Accordingly, an Exit
Sub statement may only be issued from within a sub procedure.
Sub…End Sub statement may be nested; in other words, one sub procedure can call another sub
procedure, which, in turn, can call yet another sub procedure, etc. Note that a single Exit Sub
statement exits only the current sub procedure.
See Also
Call statement, Sub…End Sub statement
Reference Guide
279
Exp( ) function
Exp( ) function
Purpose
Returns the number e raised to a specified exponent.
Syntax
Exp( num_expr )
num_expr is a numeric expression.
Return Value
Float
Description
The Exp( ) function raises the mathematical value e to the power represented by num_expr. e has a
value of approximately 2.7182818.
Note: MapBasic supports general exponentiation through the caret operator (^).
Example
Dim e As Float
e = Exp(1)
' the local variable e now contains
' approximately 2.7182818
See Also
Cos( ) function, Sin( ) function, Log( ) function
280
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Export statement
Purpose
Exports a table to another file format.
Syntax 1 (for exporting MIF/MID files, DBF files, or ASCII text files)
Export table
Into file_name
[ Type
{ "MIF" |
"DBF" Charset char_set ] |
"ASCII" Charset char_set ] [ Delimiter "d " ] [ Titles ] } ]
"CSV" [ Charset char_set ] [ Titles ] } ]
[ Overwrite ]
Syntax 2 (for exporting DXF files)
Export table
Into file_name
[ Type "DXF" ]
[ Overwrite ]
[ Preserve
[ AttributeData ] [ Preserve ] [ MultiPolygonRgns [ As Blocks ] ] ]
[ { Binary | ASCII [ DecimalPlaces decimal_places ] } ]
[ Version { 12 | 13 } ]
[ Transform
( MI_x1, MI_y1 ) ( MI_x2, MI_y2 )
( DXF_x1, DXF_y1 ) ( DXF_x2, DXF_y2 ) ]
table is the name of an open table; do not use quotation marks around this name.
file_name is a string specifying the file name to contain the exported data; if the file name does not
include a path, the export file is created in the current working directory.
char_set is a string that identifies a character set, such as “WindowsLatin1”; see CharSet clause on
page 126 for details.
d is a character used as a delimiter when exporting an ASCII file.
decimal_places is a small integer (from 0 to 16, default value is 6), which controls the number of
decimal places used when exporting floating-point numbers in ASCII.
MI_x1, MI_y1, etc. are numbers that represent bounds coordinates in the MapInfo Professional
table.
DXF_x1, DXF_y1, etc. are numbers that represent bounds coordinates in the DXF file.
Reference Guide
281
Export statement
Description
The Export statement copies the contents of a MapInfo table to a separate file, using a file format
which other packages could then edit or import. For example, you could export the contents of a
table to a DXF file, then use a CAD software package to import the DXF file. The Export statement
does not alter the original table.
Specifying the File Format
The optional Type clause specifies the format of the file you want to create.
I
Type clause
File Format Specified
Type “MIF”
MapInfo Interchange File format. For information on the MIF file format, see the
MapInfo Professional documentation.
Type “DXF”
DXF file (a format supported by CAD packages, such as AutoCAD).
Type “DBF”
dBASE file format.
Note: Map objects are not exported when you specify DBF format.
Type “ASCII”
Text file format.
Note: Map objects are not exported when you specify ASCII format.
Type “CSV”
Comma-delimited text file format.
Note: Map objects are not exported when you specify CSV format.
If you omit the Type clause, MapInfo Professional assumes that the file extension indicates the
desired file format. For example, if you specify the file name “PARCELS.DXF” MapInfo Professional
creates a DXF file.
If you include the optional Overwrite keyword, MapInfo Professional creates the export file,
regardless of whether a file by that name already exists. If you omit the Overwrite keyword, and the
file already exists, MapInfo Professional does not overwrite the file.
Exporting ASCII Text Files
When you export a table to an ASCII or CSV text file, the text file will contain delimiters. A delimiter is
a special character that separates the fields within each row of data. CSV text files automatically use
a comma (,) as the delimiter. No other delimiter can be specified for CSV export.
The default delimiter for an ASCII text file is the TAB character (Chr$(9)). To specify a different
delimiter, include the optional Delimiter clause. The following example uses a colon (:) as the
delimiter:
Export sites Into "sitedata.txt" Type "ASCII"
Delimiter ":" Titles
282
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
When you export to an ASCII or CSV text file, you may want to include the optional Titles keyword.
If you include Titles, the first row of the text file will contain the table's column names. If you omit
Titles, the column names will not be stored in the text file (which could be a problem if you intend to
re-import the file later).
Exporting DXF Files
If you export a table into DXF file, using Syntax 2 as shown above, the Export statement can include
the following DXF-specific clauses:
Include the Preserve AttributeData clause if you want to export the table's tabular data as attribute
data in the DXF file.
Include the Preserve MultiPolygonRgns As Blocks clause if you want MapInfo Professional to
export each multiple-polygon region as a DXF block entity. If you omit this clause, each polygon from
a multiple-polygon region is stored separately.
Include the Binary keyword to export into a binary DXF file; or, include the ASCII keyword to export
into an ASCII text DXF file. If you do not include either keyword, MapInfo Professional creates an
ASCII DXF file. Binary DXF files are generally smaller, and can be processed much faster than
ASCII. When you export as ASCII, you can specify the number of decimal places used to store
floating-point numbers (0 to 16 decimal places; 6 is the default).
The Version 12 or Version 13 clause controls whether MapInfo Professional creates a DXF file
compliant with AutoCAD 12 or 13. If you omit the clause, MapInfo Professional creates a version 12
DXF file.
Transform specifies a coordinate transformation. In the Transform clause, you specify the
minimum and maximum x- and y-bounds coordinates of the MapInfo table, and then specify the
minimum and maximum coordinates that you want to have in the DXF file.
Example
The following example takes an existing MapInfo table, Facility, and exports the table to a DXF file
called “FACIL.DXF”.
Open Table "facility"
Export facility
Into "FACIL.DXF"
Type "DXF"
Overwrite
Preserve AttributeData
Preserve MultiPolygonRgns As Blocks
ASCII DecimalPlaces 3
Transform (0, 0) (1, 1) (0, 0) (1, 1)
See Also
Import statement
Reference Guide
283
ExtractNodes( ) function
ExtractNodes( ) function
Purpose
Returns a polyline or region created from a subset of the nodes in an existing object.
Syntax
ExtractNodes( object, polygon_index, begin_node, end_node, b_region )
object is a polyline or region object.
polygon_index is an integer value, 1 or larger: for region objects. This indicates which polygon (for
regions) or section (for polylines) to query.
begin_node is a SmallInt node number, 1 or larger; indicates the beginning of the range of nodes to
return.
end_node is a SmallInt node number, 1 or larger; indicates the end of the range of nodes to return.
b_region is a logical value that controls whether a region or polyline object is returned; use TRUE for
a region object or FALSE for a polyline object.
Return Value
Returns an object with the specified nodes. MapBasic applies all styles (color, etc.) of the original
object; then, if necessary, MapBasic applies the current drawing styles.
Description
If the begin_node is equal to or greater than end_node, the nodes are returned in the following
order:
•
•
begin_node through the next-to-last node in the polygon;
First node in polygon through end_node.
If object is a region object, and if begin_node and end_node are both equal to 1, MapBasic returns
the entire set of nodes for that polygon. This provides a simple mechanism for extracting a single
polygon from a multiple-polygon region. To determine the number of polygons in a region, call the
ObjectInfo( ) function.
Error Conditions
ERR_FCN_ARG_RANGE error generated if b_region is FALSE and the range of nodes contains
fewer than two nodes, or if b_region is TRUE and the range of nodes contains fewer than three
nodes.
See Also
ObjectNodeX( ) function, ObjectNodeY( ) function
284
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Farthest statement
Purpose
Find the object in a table that is farthest from a particular object. The result is a two-point Polyline
object representing the farthest distance.
Syntax
Farthest [ N | All ] From { Table fromtable | Variable fromvar }
To totable Into intotable
[ Type { Spherical | Cartesian }]
[ Ignore [ Contains ][ Min min_value ][ Max max_value ] Units unitname]
[ Data clause ]
N is an optional parameter for the number of “farthest” objects to find. The default is 1. If All is used,
then a distance object is created for every combination.
fromtable is a table of objects from which you want to find farthest distances.
fromvar is a MapBasic variable representing an object that you want to find the farthest distances
from.
totable is a table of objects that you want to find farthest distances to.
intotable is a table to place the results into.
min_value is the minimum distance to include in the results.
max_value is the maximum distance to include in the results.
unitname is string representing the name of a distance unit (for example, “km”) used for min_value
and/or max_value.
Description
The Farthest statement finds all the objects in the fromtable that is furthest from a particular object.
Every object in the fromtable is considered. For each object in the fromtable, the furthest object in
the totable is found. If N is defined, then the N farthest objects in the totable are found. A two-point
Polyline object representing the farthest points between the fromtable object and the chosen totable
object is placed in the intotable. If All is specified, then an object is placed in the intotable
representing the distance between the fromtable object and each totable object.
If there are multiple objects in the totable that are the same distance from a given fromtable object,
then only one of them may be returned. If multiple objects are requested (i.e., if N is greater than 1),
then objects of the same distance will fill subsequent slots. If a tie exists at the second farthest
object, and three objects are requested, then one of the second farthest objects will become the third
farthest object.
The types of the objects in the fromtable and totable can be anything except Text objects. For
example, if both tables contain Region objects, then the minimum distance between Region objects
is found, and the two-point Polyline object produced represents the points on each object used to
Reference Guide
285
Farthest statement
calculate that distance. If the Region objects intersect, then the minimum distance is zero, and the
two-point Polyline returned will be degenerate, where both points are identical and represent a point
of intersection.
The distances calculated do not take into account any road route distance. It is strictly a “as the bird
flies” distance.
The Ignore clause can be used to limit the distances to be searched, and can effect how many
totable objects are found for each fromtable object. One use of the Min distance could be to
eliminate distances of zero. This may be useful in the case of two point tables to eliminate
comparisons of the same point. For example, if there are two point tables representing Cities, and
we want to find the closest cities, we may want to exclude cases of the same city.
The Max distance can be used to limit the objects to consider in the totable. This may be most useful
in conjunction with N or All. For example, we may want to search for the five airports that are closest
to a set of cities (where the fromtable is the set of cities and the totable is a set of airports), but we
don't care about airports that are farther away than 100 miles. This may result in less than five
airports being returned for a given city. This could also be used in conjunction with the All parameter,
where we would find all airports within 100 miles of a city.
Supplying a Max parameter can improve the performance of the Farthest statement, since it
effectively limits the number of totable objects that are searched.
The effective distances found are strictly greater than the min_value and less than or equal to the
max_value:
min_value < distance <= max_value
This can allow ranges or distances to be returned in multiple passes using the Farthest statement.
For example, the first pass may return all objects between 0 and 100 miles, and the second pass
may return all objects between 100 and 200 miles, and the results should not contain duplicates (i.e.,
a distance of 100 should only occur in the first pass and never in the second pass).
Type is the method used to calculate the distances between objects. It can either be Spherical or
Cartesian. The type of distance calculation must be correct for the coordinate system of the intotable
or an error will occur. If the Coordsys of the intotable is NonEarth and the distance method is
Spherical, then an error will occur. If the Coordsys of the intotable is Latitude/Longitude, and the
distance method is Cartesian, then an error will occur.
The Ignore clause limits the distances returned. Any distances found which are less than or equal to
min_value or greater than max_value are ignored. min_value and max_value are in the distance unit
signified by unitname. If unitname is not a valid distance unit, an error will occur. See Set Distance
Units statement on page 592 for the list of available unit names. The entire Ignore clause is
optional, as are the Min and Max sub clauses within it.
Normally, if one object is contained within another object, the distance between the objects is zero.
For example, if fromtable is WorldCaps and totable is World, then the distance between London and
the United Kingdom would be zero. If the Contains keyword is used within the Ignore clause, then
the distance will not be automatically be zero. Instead, the distance from London to the boundary of
the United Kingdom will be returned. In effect, this will treat all closed objects, such as regions, as
polylines for the purpose of this operation.
The Data clause can be used to mark which fromtable object and which totable object the result
came from.
286
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Data Clause
Data IntoColumn1=column1, IntoColumn2=column2
The IntoColumn on the left hand side of the equals sign must be a valid column in intotable. The
column name on the right hand side of the equals sign must be a valid column name from either
totable or fromtable. If the same column name exists in both totable and fromtable, then the column
in totable will be used (e.g., totable is searched first for column names on the right hand side of the
equals sign).
To avoid any conflicts such as this, the column names can be qualified using the table alias. For
example:
Data name1=states.state_name, name2=county.state_name
To fill a column in the intotable with the distance, we can either use the Table > Update Column
functionality from the menu or use the Update statement.
See Also
Nearest statement, CartesianObjectDistance( ) function, ObjectDistance( ) function,
SphericalObjectDistance( ) function, CartesianConnectObjects( ) function, ConnectObjects( )
function, SphericalConnectObjects( ) function
Fetch statement
Purpose
Sets a table's cursor position (i.e., which row is the current row).
Syntax
Fetch { First | Last | Next | Prev | Rec n } From table
n is the number of the record to read.
table is the name of an open table.
Description
Use the Fetch statement to retrieve records from an open table. By issuing a Fetch statement, your
program places the table cursor at a certain row position in the table; this dictates which of the
records in the table is the “current” record.
Note: The term “cursor” is used here to signify a row's position in a table. This has nothing to do
with the on-screen mouse cursor.
After you issue a Fetch statement, you can retrieve data from the current row by using one of the
following expression types:
Reference Guide
287
Fetch statement
Syntax
Example
table.column
World.Country
table.col#
World.col1
table.col( number )
World.col( 1 )
A Fetch First statement positions the cursor at the first un-deleted row in the table.
A Fetch Last statement positions the cursor at the last un-deleted row in the table.
A Fetch Next statement moves the cursor forward to the next un-deleted row.
A Fetch Prev statement moves the cursor backward to the previous un-deleted row.
A Fetch Rec n statement positions the cursor on a specific row, even if that row is deleted.
Note: If the specified record is deleted, the statement generates run-time error 404.
Various MapInfo Professional and MapBasic operations (for example, Select, Update, and screen
redraws) automatically reset the current row. Accordingly, Fetch statements should be issued just
before any statements that make assumptions about which row is current.
Reading Past the End of the Table
After you issue a Fetch statement, you may need to call the EOT( ) function to determine whether
you fetched an actual row.
If the Fetch statement placed the cursor on an actual row, the EOT( ) function returns FALSE
(meaning, there is not an end-of-table condition).
If the Fetch statement attempted to place the cursor past the last row, the EOT( ) function returns
TRUE (meaning, there is an end-of-table condition; therefore there is no “current row”).
The following example shows how to use a Fetch Next statement to loop through all rows in a table.
As soon as a Fetch Next statement attempts to read past the final row, the EOT( ) function returns
TRUE, causing the loop to halt.
Dim i As Integer
i = 0
Fetch First From world
Do While Not EOT(world)
i = i + 1
Fetch Next From world
Loop
Print "Number of undeleted records: " + i
288
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Examples
The following example shows how to fetch the 3rd record from the table States:
Open Table "states"
Fetch Rec 3 From states 'position at 3rd record
Note states.state_name 'display name of state
As illustrated in the example below, the Fetch statement can operate on a temporary table (for
example, Selection).
Select * From states Where pop_1990 < pop_1980
Fetch First From Selection
Note Selection.col1 + " has negative net migration"
See Also
EOT( ) function, Open Table statement
FileAttr( ) function
Purpose
Returns information about an open file.
Syntax
FileAttr( filenum, attribute )
filenum is the number of a file opened through an Open File statement.
attribute is a code indicating which file attribute to return; see table below.
Return Value
Integer
Description
The FileAttr( ) function returns information about an open file.
The attribute parameter must be one of the codes in this table:
Reference Guide
289
FileExists( ) function
attribute parameter
FILE_ATTR_MODE
Return Value
Small integer, indicating the mode in which the file was opened. Return
value will be one of the following:
•
•
•
•
•
FILE_ATTR_FILESIZE
MODE_INPUT
MODE_OUTPUT
MODE_APPEND
MODE_RANDOM
MODE_BINARY
Integer, indicating the file size in bytes.
Error Conditions
The ERR_FILEMGR_NOTOPEN error is generated if the specified file is not open.
See Also
EOF( ) function, Get statement, Open File statement, Put statement
FileExists( ) function
Purpose
Returns a logical value indicating whether or not a file exists.
Syntax
FileExists( filespec )
filespec is a string that specifies the file path and name.
Return Value
Logical: TRUE if the file already exists, otherwise FALSE.
Example
If FileExists("C:\MapInfo\TODO.TXT") Then
Open File "C:\MapInfo\TODO.TXT" For INPUT As #1
End If
See Also
TempFileName$( ) function
290
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
FileOpenDlg( ) function
Purpose
Displays a File Open dialog box, and returns the name of the file the user selected.
Syntax
FileOpenDlg( path, filename, filetype, prompt )
path is a string value, indicating the directory or folder to choose files from.
filename is a string value, indicating the default file name for the user to choose.
filetype is a string value, three or four characters long, indicating a file type (for example, “TAB” to
specify tables).
prompt is a string title that appears on the bar at the top of the dialog box.
Return Value
String value, representing the name of the file the user chose (or an empty string if the user
cancelled).
Description
The FileOpenDlg( ) function displays a dialog box similar to the one that displays when the user
chooses File > Open.
To choose a file from the list that appears in the dialog box, the user can either click a file in the list
and click the OK button, or simply double-click a file in the list. In either case, the FileOpenDlg( )
function returns a character string representing the full path and name of the file the user chose.
Alternately, if the user clicks the Cancel button instead of picking a file, the dialog returns a null
string ("").
The FileOpenDlg( ) function does not actually open any files; it merely presents the user with a
dialog box, and lets the user choose a file. If your application then needs to actually open the file
chosen by the user, the application must issue a statement such as the Open Table statement. If
you want your application to display an Open dialog box, and then you want MapInfo Professional to
automatically open the selected file, you can issue a statement such as the Run Menu Command
statement with M_FILE_OPEN or M_FILE_ADD_WORKSPACE.
The path parameter specifies the directory or folder from which the user will choose an existing file.
Note that the path parameter only dictates the initial directory, it does not prevent the user from
changing directories once the dialog box appears. If the path parameter is blank (a null string), the
dialog box presents a list of files in the current working directory.
The filename parameter specifies the default file name for the user to choose.
The filetype parameter is a string, usually three or four characters long, which indicates the type of
files that should appear in the dialog box. Some filetype settings have special meaning; for example,
if the filetype parameter is “TAB”, the dialog box presents a list of MapInfo tables, and if the filetype
parameter is “WOR”, the dialog box presents a list of MapInfo workspace files.
Reference Guide
291
FileOpenDlg( ) function
There are also a variety of other three-character filetype values, summarized in the table below. If
you specify one of the special type values from the table below, the dialog box includes a control that
lets the user choose between seeing a list of table files or a list of all files (“*.*”).
filetype parameter
Type of files that appear
“TAB”
MapInfo tables
“WOR”
MapInfo workspaces
“MIF”
MapInfo Interchange Format files, used for importing / exporting maps from
/ to ASCII text files.
“DBF”
dBASE or compatible data files
“WKS”, “WK1”
Lotus spreadsheet files
“XLS”
Excel spreadsheet files
“DXF”
AutoCAD data interchange format files
“MMI”, “MBI”
MapInfo for DOS interchange files
“MB”
MapBasic source program files
“MBX”
Compiled MapBasic applications
“TXT”
Text files
“BMP”
Windows bitmap files
“WMF”
Windows metafiles
Each of the three-character file types listed above corresponds to an actual file extension; in other
words, specifying a filetype parameter of “WOR” tells MapBasic to display a list of files having the
“.WOR” file extension, because that is the extension used by MapInfo Professional workspaces.
To help you write portable applications, MapBasic lets you use the same three-character filetype
settings on all platforms. On Windows, a control in the lower left corner of the dialog box lets the user
choose whether to see a list of files with the .TAB extension, or a list of all files in the current
directory. If the FileOpenDlg( ) function specifies a filetype parameter which is not listed in the table
of file extensions above, the dialog box appears without that control.
Example
Dim s_filename As String
s_filename = FileOpenDlg("","","TAB","Open Table")
See Also
FileSaveAsDlg( ) function, Open File statement, Open Table statement
292
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
FileSaveAsDlg( ) function
Purpose
Displays a Save As dialog box, and returns the name of the file the user entered.
Syntax
FileSaveAsDlg( path, filename, filetype, prompt )
path is a string value, indicating the default destination directory.
filename is a string value, indicating the default file name.
filetype is a string value, indicating the type of file that the dialog box lets the user choose.
prompt is a string title that appears at the top of the dialog box.
Return Value
String value, representing the name of the file the user entered (or an empty string if the user
cancelled).
Description
The FileSaveAsDlg( ) function displays a Save As dialog box, similar to the dialog box that displays
when the user chooses File > Save Copy As.
The user can type in the name of the file they want to save. Alternately, the user can double-click
from the list of grayed-out filenames that appears in the dialog box. Since each file name in the list
represents an existing file, MapBasic asks the user to verify that they want to overwrite the existing
file.
If the user specifies a filename and clicks OK, the FileSaveAsDlg( ) function returns a character
string representing the full path and name of the file the user chose. If the user clicks the Cancel
button instead of picking a file, the function returns a null string ("").
The path parameter specifies the initial directory path. The user can change directories once the
dialog box appears. If the path parameter is blank (a null string), the dialog box presents a list of files
in the current directory.
The filename parameter specifies the default file name for the user to choose.
The filetype parameter is a three-character (or shorter) string which identifies the type of files that
should appear in the dialog box. To display a dialog box that lists workspaces, specify the string
“WOR” as the filetype parameter; to display a dialog box that lists table names, specify the string
“TAB.” See FileOpenDlg( ) function on page 291 for more information about three-character
filetype codes.
The FileSaveAsDlg( ) function does not actually save any files; it merely presents the user with a
dialog box, and lets the user choose a file name to save. To save data under the file name chosen by
the user, issue a statement such as the Commit Table statement.
Reference Guide
293
Find statement
See Also
Commit Table statement, FileOpenDlg( ) function
Find statement
Purpose
Finds a location in a mappable table.
Syntax
Find address [ , region ] [ Interactive ]
address is a string expression representing the name of a map object to find; to find the intersection
of two streets, use the syntax: streetname && streetname.
region is the name of a region object which refines the search.
Description
The Find statement searches a mappable table for a named location (represented by the address
parameter). MapBasic stores the search results in system variables, which a program can then
access through the CommandInfo( ) function. If the Find statement includes the optional
Interactive keyword, and if MapBasic is unable to locate the specified address, a dialog box
displays a list of “near matches.”
The Find statement can only search a mappable table (for example, a table which has graphic
objects attached). The table must already be open. The Find statement operates on whichever
column is currently chosen for searching. A MapBasic program can issue a Find Using statement
to identify a specific table column to search. If the Find statement is not preceded by a Find Using
statement, MapBasic searches whichever table was specified the last time the user chose MapInfo
Professional's Query > Find command.
The Find statement can optionally refine a search by specifying a region name in addition to the
address parameter. In other words, you could simply try to find a city name (for example, “Albany”)
by searching a table of cities; or you could refine the search by specifying both a city name and a
region name (for example, “Albany”, “CA”). The Find statement does not automatically add a symbol
to the map to mark where the address was found. To create such a symbol, call the CreatePoint( )
function or the Create Point statement; see example below.
Determining Whether the Address Was Found
Following a Find statement, a MapBasic program can issue the function call
CommandInfo(CMD_INFO_FIND_RC) to determine if the search was successful. If the search was
successful, call CommandInfo(CMD_INFO_X) to determine the x-coordinate of the queried
location, and call CommandInfo(CMD_INFO_Y) to determine the y-coordinate. To determine the
row number that corresponds to the “found” address, call
CommandInfo(CMD_INFO_FIND_ROWID).
294
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The Find statement may result in an exact match, an approximate match, or a failure to match. If the
Find statement results in an exact match, the function call CommandInfo(CMD_INFO_FIND_RC)
returns a value of one (1). If the Find statement results in an approximate match, the function call
returns a value greater than one (1). If the Find statement fails to match the address, the function
call returns a negative value.
The table below summarizes the Find-related information represented by the
CommandInfo(CMD_INFO_FIND_RC) return value. The return value has up to three digits, and
that each of the three digits indicates the relative success or failure of a different part of the search.
Digit Values
Meaning
xx1
Exact match.
xx2
A substitution from the abbreviations file used.
xx3 ( - )
Exact match not found.
xx4 ( - )
No object name specified; match not found.
xx5 ( + )
The user chose a name from the Interactive dialog box.
x1x
Side of street undetermined.
x2x ( + / - )
Address number was within min/max range.
x3x ( + / - )
Address number was not within min/max range.
x4x ( + / - )
Address number was not specified.
x5x ( - )
Streets do not intersect.
x6x ( - )
The row matched does not have a map object.
x7x ( + )
The user chose an address number from the Interactive dialog box.
1xx ( + / - )
Name found in only one region other than specified region.
2xx ( - )
Name found in more than one region other than the specified region.
3xx ( + / - )
No refining region was specified, and one match was found.
4xx ( - )
No region was specified, and multiple matches were found.
5xx ( + )
Name found more than once in the specified region.
6xx ( + )
The user chose a region name from the Interactive dialog box.
The Mod operator is useful when examining individual digits from the Find result. For example, to
determine the last digit of a number, use the expression number Mod 10. To determine the last two
digits of a number, use the expression number Mod 100; etc.
Reference Guide
295
Find statement
The distinction between exact and approximate matches is best illustrated by example. If a table of
cities contains one entry for “Albany”, and the Find Using statement attempts to locate a city name
without a refining region name, and the Find statement specifies an address parameter value of
“Albany”, the search results in an exact match. Following such a Find statement, the function call
CommandInfo(CMD_INFO_FIND_RC) would return a value of 1 (one), indicating that an exact
match was found.
Now suppose that the Find operation has been set up to refine the search with an optional region
name; in other words, the Find statement expects a city name followed by a state name (for
example, “Albany”, “NY”). If a MapBasic program then issues a Find statement with “Albany” as the
address and a null string as the state name, that is technically not an exact match, because
MapBasic expects the city name to be followed by a state name. Nevertheless, if there is only one
“Albany” record in the table, MapBasic will be able to locate that record. Following such a Find
operation, the function call CommandInfo(CMD_INFO_FIND_RC) would return a value of 301. The
1 digit signifies that the city name matched exactly, while the 3 digit indicates that MapBasic was
only partly successful in locating a correct refining region.
If a table of streets contains “Main St”, and a Find statement attempts to locate “Main Street”,
MapBasic considers the result to be an approximate match (assuming that abbreviation file
processing has been enabled; see Find Using statement on page 297). Strictly speaking, the
string “Main Street” does not match the string “Main St”. However MapBasic is able to match the two
strings after substituting possible abbreviations from the MapInfo abbreviations file
(MAPINFOW.ABB). Following the Find statement, the CommandInfo(CMD_INFO_FIND_RC)
function call returns a value of 2.
If the Find operation presents the user with a dialog box, and the user enters text in the dialog box in
order to complete the find, then the return code will have a 1 (one) in the millions place.
Example
Include "mapbasic.def"
Dim x, y As Float, win_id As Integer
Open Table "states" Interactive
Map From States
win_id = FrontWindow( )
Find Using states(state)
Find "NY"
If CommandInfo(CMD_INFO_FIND_RC) >= 1 Then
x = CommandInfo(CMD_INFO_X)
y = CommandInfo(CMD_INFO_Y)
Set Map
Window win_id
Center (x, y)
' Now create a symbol at the location we found.
' Create the object in the Cosmetic layer.
Insert Into
WindowInfo( win_id, WIN_INFO_TABLE) (Object)
Values ( CreatePoint(x, y) )
Else
Note "Location not found."
End If
296
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Find Using statement, CommandInfo( ) function
Find Using statement
Purpose
Dictates which table(s) and column(s) should be searched in subsequent Find operations.
Syntax
Find Using table ( column )
[ Refine Using table ( column ) ]
[ Options
[ Abbrs { On | Off } ]
[ ClosestAddr { On | Off } ]
[ OtherBdy { On | Off } ]
[ Symbol symbol_style ] ]
[ Inset inset_value { Percent | Distance Units dist_unit} ]
[ Offset value ] [ Distance Units dist_unit ] ]
table is the name of an open table.
column is the name of a column in the table.
symbol_style is a Symbol variable or a function call that returns a Symbol value; this controls what
type of symbol is drawn on the map if the user chooses Query > Find.
inset_value is a positive integer value representing how far from the ends of the line to adjust the
placement of an address location.
value specifies the Offset value (the distance back from the street).
dist_unit is a string that represents the name of a distance unit (for example, “mi” for miles, “m” for
meters.
Description
The Find Using statement specifies which table(s) and column(s) MapBasic will search when
performing a Find statement. Note that the column specified must be indexed.
The optional Refine clause specifies a second table, which will act as an additional search criterion;
the table must contain region objects. The specified column does not need to be indexed. If you omit
the Refine clause, subsequent Find statements expect a simple location name (for example,
“Portland”). If you include a Refine clause, subsequent Find statements expect a location name and
a region name (for example, “Portland”, “OR”).
The optional Abbrs clause dictates whether MapBasic will try substituting abbreviations from the
abbreviations file in order to find a match. By default, this option is enabled (On); to disable the
option, specify the clause Abbrs Off.
The optional ClosestAddr clause dictates whether MapBasic will use the closest available address
number in cases where the address number does not match. By default, this option is disabled (Off);
to enable the option, specify the clause ClosestAddr On.
Reference Guide
297
Fix( ) function
The optional OtherBdy clause dictates whether MapBasic will match to a record found in a refining
region other than the refining region specified. By default, this option is disabled (Off); to enable the
option, specify the clause OtherBdy On.
MapInfo Professional saves the Inset and Offset settings specified the last time the user chose
Query > Find Options, Table > Geocode Options or executed a Find Using statement. Thus, the
last specified inset/offset options becomes the default settings for the next time.
If Percent is specified, it represents the percentage of the length of the line where the address is to
be placed. For Percent, valid values for inset_value are from 0 to 50. If Distance Units are
specified, inset_value represents the distance from the ends of the line where the address is to be
placed. For distance, valid values for inset_value are from 0 to 32,767. The inset takes the
addresses that would normally fall at the end of the street and moves them away from the end going
in the direction towards the center.
The Offset value sets the addresses back from the street instead of right on the street. value is a
positive integer value representing how far to offset the placement of an address location back from
the street. Valid values are from 0 to 32,767.
Example
Find Using city_1k(city)
Refine Using states(state)
Find "Albany", "NY"
See Also
Create Index statement, Find statement
Fix( ) function
Purpose
Returns an integer value, obtained by removing the fractional part of a decimal value.
Syntax
Fix( num_expr )
num_expr is a numeric expression.
Return Value
Integer
298
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Fix( ) function removes the fractional portion of a number, and returns the resultant integer
value. The Fix( ) function is similar to, but not identical to, the Int( ) function. The two functions
differ in the way that they treat negative fractional values. When passed a negative fractional
number, Fix( ) returns the nearest integer value greater than or equal to the original value; thus, the
function call:
Fix(-2.3)
returns a value of -2. But when the Int( ) function is passed a negative fractional number, it returns
the nearest integer value that is less than or equal to the original value. Thus, the function call:
Int(-2.3)
returns a value of -3.
Example
Dim i_whole As Integer
i_whole = Fix(5.999)
' i_whole now has the value 5.
i_whole = Fix(-7.2)
' i_whole now has the value -7.
See Also
Int( ) function, Round( ) function
Font clause
Purpose
Specifies a text style.
Syntax
Font font_expr
font_expr is a Font expression, for example, MakeFont( fontname, style, size, fgcolor,
bgcolor ).
Description
The Font clause specifies a text style. Font is a clause, not a complete MapBasic statement.
Various object-related statements, such as the Create Text statement, allow you to specify a Font
setting; this lets you choose the typeface and point size of the new text object. If you omit the Font
expression from a Create Text statement, the new object uses MapInfo Professional's current Font.
The keyword Font may be followed by an expression that evaluates to a Font value.
This expression can be a Font variable:
Font font_var
Reference Guide
299
Font clause
or a call to a function (for example, CurrentFont( ) function or MakeFont( ) function) which returns
a Font value:
Font MakeFont("Helvetica", 1, 12, BLACK, WHITE)
With some MapBasic statements (for example, the Set Legend statement), the keyword Font can
be followed immediately by the five parameters that define a Font style (font name, style, point size,
foreground color, and background color) within parentheses:
Font("Helvetica", 1, 12, BLACK, WHITE)
The following table summarizes the components that define a font:
Component
Description
font name
A string that identifies a font. The set of available fonts depends on the user's
system and the hardware platform in use.
style
Integer value. Controls text attributes such as bold, italic, and underline. See
table below for details.
size
Integer value representing a point size. A point size of twelve is one-sixth of
an inch tall.
foreground color
Integer RGB color value, representing the color of the text. See Rnd( )
function on page 503.
background color
Integer RGB color value. If the halo style is used, this is the halo color;
otherwise, this is the background fill color.
To specify a transparent background style in a Font clause, omit the
background color. For example: Font( "Helvetica", 1, 12, BLACK).
To specify a transparent fill when calling the MakeFont( ) function, specify -1
as the background color.
The following table shows how the style parameter corresponds to font styles.
Style Value
300
Description of text style
0
Plain
1
Bold
2
Italic
4
Underline
8
Strikethrough
32
Shadow
256
Halo
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Style Value
Description of text style
512
All Caps
1024
Expanded
To specify two or more style attributes, add the values from the left column. For example, to specify
both the Bold and All Caps attributes, use a style value of 513.
Example
Include "MAPBASIC.DEF"
Dim o_title As Object
Create Text
Into Variable o_title
"Your message could go HERE"
(73.5, 42.6) (73.67, 42.9)
Font MakeFont("Helvetica",1,12,BLACK,WHITE)
See Also
Alter Object statement, Chr$( ) function, Create Text statement, RGB( ) function
For…Next statement
Purpose
Defines a loop which will execute for a specific number of iterations.
Restrictions
You cannot issue a For…Next statement through the MapBasic window.
Syntax
For var_name = start_expr To end_expr [ Step inc_expr ]
statement_list
Next
var_name is the name of a numeric variable.
start_expr is a numeric expression.
end_expr is a numeric expression.
inc_expr is a numeric expression.
statement_list is the group of statements to execute with each iteration of the For loop.
Reference Guide
301
For…Next statement
Description
The For…Next statement provides loop control. This statement requires a numeric variable
(identified by the var_name parameter). A For…Next statement either executes a group of
statements (the statement_list) a number of times, or else skips over the statement_list completely.
The start_expr, end_expr, and inc_expr values dictate how many times, if any, the statement_list will
be carried out.
Upon encountering a For…Next statement, MapBasic assigns the start_expr value to the var_name
variable. If the variable is less than or equal to the end_expr value, MapBasic executes the group of
statements in the statement_list, and then adds the inc_expr increment value to the variable. If no
Step clause was specified, MapBasic uses a default increment value of one. MapBasic then
compares the current value of the variable to the end_expr expression; if the variable is currently
less than or equal to the end_expr value, MapBasic once again executes the statements in the
statement_list. If, however, the var_name variable is greater than the end_expr, MapBasic stops the
For loop, and resumes execution with the statement which follows the Next statement.
Conversely, the For…Next statement can also count downwards, by using a negative Step value. In
this case, each iteration of the For loop decreases the value of the var_name variable, and
MapBasic will only decide to continue executing the loop as long as var_name remains greater than
or equal to the end_expr.
Each For statement must be terminated by a Next statement. Any statements which appear
between the For and Next statements comprise the statement_list; this is the list of statements
which will be carried out upon each iteration of the loop.
The Exit For statement allows you to exit a For loop regardless of the status of the var_name
variable. The Exit For statement tells MapBasic to jump out of the loop, and resume execution with
the first statement which follows the Next statement.
MapBasic permits you to modify the value of the var_name variable within the body of the For loop;
this can affect the number of times that the loop is executed. However, as a matter of programming
style, you should try to avoid altering the contents of the var_name variable within the loop.
302
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim i As Integer
' the next loop will execute a Note statement 5 times
For i = 1 to 5
Note "Hello world!"
Next
' the next loop will execute the Note statement 3 times
For i = 1 to 5 Step 2
Note "Hello world!"
Next
' the next loop will execute the Note statement 3 times
For i = 5 to 1 Step -2
Note "Hello world!"
Next
' MapBasic will skip the following For statement
' completely, because the initial start value is
' already larger than the initial end value
For i = 100 to 50 Step 5
Note "This note will never be executed"
Next
See Also
Do…Loop statement, Exit For statement
ForegroundTaskSwitchHandler procedure
Purpose
A reserved procedure name, called automatically when MapInfo Professional receives the focus
(becoming the active application) or loses the focus (another application becomes active).
Syntax
Declare Sub ForegroundTaskSwitchHandler
Sub ForegroundTaskSwitchHandler
statement_list
End Sub
statement_list is a list of statements.
Description
If the user runs an application containing a procedure named ForegroundTaskSwitchHandler,
MapInfo Professional calls the procedure automatically whenever MapInfo Professional receives or
loses the focus. Within the procedure, call the CommandInfo( ) function to determine whether
MapInfo Professional received or lost the focus.
Reference Guide
303
Format$( ) function
Example
Sub ForegroundTaskSwitchHandler
If CommandInfo(CMD_INFO_TASK_SWITCH)
= SWITCHING_INTO_MAPINFO Then
' ... then MapInfo just became active
Else
' ... another app just became active
End If
End Sub
See Also
CommandInfo( ) function
Format$( ) function
Purpose
Returns a string representing a custom-formatted number.
Syntax
Format$( value, pattern )
value is a numeric expression.
pattern is a string which specifies how to format the results.
Return Value
String
Description
The Format$( ) function returns a string representing a formatted number. Given a numeric value
such as 12345.67, Format$( ) can produce formatted results such as “$12,345.67”.
The value parameter specifies the numeric value that you want to format.
The pattern parameter is a string of code characters, chosen to produce a particular type of
formatting. The pattern string should include one or more special format characters, such as #, 0, %,
the comma character (,), the period (.), or the semi-colon (;); these characters control how the
results will look. The table below summarizes the format characters.
304
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
pattern character
#
Role in formatting results:
The result will include one or more digits from the value.
If the pattern string contains one or more # characters to the left of the
decimal place, and if the value is between zero and one, the formatted
result string will not include a zero before the decimal place.
0
A digit placeholder similar to the # character. If the pattern string contains
one or more 0 characters to the left of the decimal place, and the value is
between zero and one, the formatted result string will include a zero before
the decimal place. See examples below.
. (period)
The pattern string must include a period if you want the result string to
include a “decimal separator.” The result string will include the decimal
separator currently in use on the user's computer. To force the decimal
separator to be a period, use the Set Format statement.
, (comma)
The pattern string must include a comma if you want the result string to
include “thousand separators.” The result string will include the thousand
separator currently set up on the user's computer. To force the thousand
separator to be a comma, use the Set Format statement.
%
The result will represent the value multiplied by one hundred; thus, a value
of 0.75 will produce a result string of “75%”. If you wish to include a percent
sign in your result, but you do not want MapBasic to multiply the value by
one hundred, place a \ (back slash) character before the percent sign (see
below).
E+
The result is formatted with scientific notation. For example, the value 1234
produces the result “1.234e+03”. If the exponent is positive, a plus sign
appears after the “e”. If the exponent is negative (which is the case for
fractional numbers), the results include a minus sign after the “e”.
E-
This string of control characters functions just as the “E+” string, except that
the result will never show a plus sign following the “e”.
; (semi-colon)
By including a semicolon in your pattern string, you can specify one format
for positive numbers and another format for negative numbers. Place the
semicolon after the first set of format characters, and before the second set
of format characters. The second set of format characters applies to
negative numbers. If you want negative numbers to appear with a minus
sign, include “–” in the second set of format characters.
\
If the back slash character appears in a pattern string, MapBasic does not
perform any special processing for the character which follows the back
slash. This lets you include special characters (for example, %) in the
results, without causing the special formatting actions described above.
Reference Guide
305
FormatDate$( ) function
Error Conditions
ERR_FCN_INVALID_FMT error generated if the pattern string is invalid
Examples
The following examples show the results you can obtain by using various pattern strings. The results
are shown as comments in the code.
Note: You will obtain slightly different results if your computer is set up with non-US number
formatting.
Format$( 12345,
Format$(-12345,
Format$( 12345,
Format$(-12345,
",#")
",#")
"$#")
"$#")
'
'
'
'
returns
returns
returns
returns
"12,345"
"-12,345"
"$12345"
"-$12345"
Format$( 12345.678, "$,#.##") ' returns "$12,345.68"
Format$(-12345.678, "$,#.##") ' returns "-$12,345.68"
Format$( 12345.678,
Format$(-12345.678,
Format$(12345.6789,
Format$(12345.6789,
"$,#.##;($,#.##)") 'returns "$12,345.68"
"$,#.##;($,#.##)") 'returns "($12,345.68)"
",#.###") ' returns "12,345.679"
",#.#") ' returns "12,345.7"
Format$(-12345.6789, "#.###E+00") ' returns "-1.235e+04"
Format$( 0.054321, "#.###E+00") ' returns "5.432e-02"
Format$(-12345.6789, "#.###E-00") ' returns "-1.235e04"
Format$( 0.054321, "#.###E-00") ' returns "5.432e-02"
Format$(0.054321, "#.##%") ' returns "5.43%"
Format$(0.054321, "#.##\%") ' returns ".05%"
Format$(0.054321, "0.##\%") ' returns "0.05%"
See Also
Str$( ) function
FormatDate$( ) function
Purpose
Returns a date formatted in the short date style specified by the Control Panel.
Syntax
FormatDate$( value )
value is a number or string representing the date in a YYYYMMDD format.
Return Value
String
306
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The FormatDate$( ) function returns a string representing a date in the local system format as
specified by the Control Panel.
If you specify the year as a two-digit number (for example, 96), MapInfo Professional uses the
current century or the century as determined by the Set Date Window statement.
Year can take two-digit year expressions. Use the Date window to determine which century should
be used. See DateWindow( ) function on page 233.
Examples
Assuming Control Panel settings are d/m/y for date order, '-' for date separator, and “dd-MMM-yyyy”
for short date format:
Dim d_Today As Date
d_Today = CurDate( )
Print d_Today 'returns "19970910"
Print FormatDate$( d_Today ) 'returns "10-Sep-1997"
Dim s_EnteredDate As String
s_EnteredDate = "03-02-61"
Print FormatDate$( s_EnteredDate ) 'returns "03-Feb-1961"
s_EnteredDate = "12-31-61"
Print FormatDate$( s_EnteredDate ) ' returns ERROR: not d/m/y ordering
s_EnteredDate = "31-12-61"
Print FormatDate$( s_EnteredDate ) ' returns 31-Dec-1961"
See Also
DateWindow( ) function, Set Date Window statement
FormatNumber$( ) function
Purpose
Returns a string representing a number, including thousands separators and decimal-place
separators that match the user's system configuration.
Syntax
FormatNumber$( num )
num is a numeric value or a string that represents a numeric value, such as “1234.56”.
Return Value
String
Reference Guide
307
FormatTime$ function
Description
Returns a string that represents a number. If the number is large enough to need a thousands
separators, this function inserts thousands separators. MapInfo Professional reads the user's
system configuration to determine which characters to use as the thousands separator and decimal
separator.
Examples
The following table demonstrates how the FormatNumber$( ) function with a comma as the
thousands separator and period as the decimal separator (United States defaults):
Function Call
Result returned
FormatNumber$("12345.67")
“12,345.67” (inserted a thousands separator)
FormatNumber$("12,345.67")
“12,345.67” (no change)
If the user's computer is set up to use period as the thousands separator and comma as the decimal
separator, the following table demonstrates the results:
Function Call
Result returned
FormatNumber$("12345.67")
“12.345,67” (inserted a thousands separator, and changed
the decimal separator to match user's setup)
FormatNumber$("12,345.67")
“12.345,67” (changed both characters to match the user's
setup)
See Also
DeformatNumber$( ) function
FormatTime$ function
Purpose
Returns a string representing a time using the format specified in the second argument. The format
string should follow the same Microsoft standards as for setting the locale time format:
Hours
308
Meaning
h
Hours without leading zeros for single-digit hours (12-hour clock).
hh
Hours with leading zeros for single-digit hours (12-hour clock).
H
Hours without leading zeros for single-digit hours (24-hour clock).
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
HH
Hours with leading zeros for single-digit hours (24-hour clock).
Minutes
Meaning
m
Minutes without leading zeros for single-digit minutes.
mm
Minutes with leading zeros for single-digit minutes.
Seconds
Meaning
s
Seconds without leading zeros for single-digit seconds.
ss
Seconds with leading zeros for single-digit seconds.
Time marker
t
Meaning
One-character time marker string.
Note: Do not to use this format for certain languages, for example, Japanese
(Japan). With this format, the application always takes the first character
from the time marker string, defined by LOCALE_S1159 (AM) and
LOCALE_S2359 (PM). Because of this, the application can create
incorrect formatting with the same string used for both AM and PM.
tt
Multi-character time marker string.
Source: http://msdn2.microsoft.com/en-us/library/ms776320.aspx
Note: In the preceding formats, the letters m, s, and t must be lowercase, and the letter h must be
lowercase to denote the 12-hour clock or uppercase to denote the 24-hour clock.
Our code follows the rules for specifying the system local time format. In addition, we also allow the
user to specify f, ff, or fff for tenths of a second, hundredths of a second, or milliseconds.
Syntax
FormatTime$ (Time, String)
Return Value
String
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Z as time
Z = CurTime()
Print FormatTime$(Z, "hh:mm:ss.fff tt")
Reference Guide
309
FME Refresh Table statement
FME Refresh Table statement
Purpose
Refreshes a Universal Data Source (FME) table from the original data source
Syntax
FME Refresh Table alias
alias is the an alias for an open registered Universal Data Source (FME) table.
Example
The following example refreshes the local table named watershed.
FME Refresh Table watershed
FrontWindow( ) function
Purpose
Returns the integer identifier of the active window.
Syntax
FrontWindow( )
Return Value
Integer
Description
The FrontWindow( ) function returns the integer ID of the foremost document window (Map,
Browse, Graph, or Layout). Note that immediately following a statement which creates a new
window (for example, Map, Browse, Graph, Layout), the new window is the foremost window.
Example
Dim map_win_id As Integer
Open Table "states"
Map From states
map_win_id = FrontWindow( )
See Also
NumWindows( ) function, WindowID( ) function, WindowInfo( ) function
310
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Function…End Function statement
Purpose
Defines a custom function.
Restrictions
You cannot issue a Function…End Function statement through the MapBasic window.
Syntax
Function name ( [ [ ByVal ] parameter As datatype ]
[, [ ByVal ] parameter As datatype... ] ) As return_type
statement_list
End Function
name is the function name.
parameter is the name of a parameter to the function.
datatype is a variable type, such as integer; arrays and custom Types are allowed.
return_type is a standard scalar variable type; arrays and custom Types are not allowed.
statement_list is the list of statements that the function will execute.
Description
The Function…End Function statement creates a custom, user-defined function. User-defined
functions may be called in the same fashion that standard MapInfo Professional functions are called.
Each Function…End Function definition must be preceded by a Declare Function statement.
A user-defined function is similar to a Sub procedure; but a function returns a value. Functions are
more flexible, in that any number of function calls may appear within one expression. For example,
the following statement performs an assignment incorporating two calls to the Proper$( ) function:
fullname = Proper$(firstname) + " " + Proper$(lastname)
Within a Function…End Function definition, the function name parameter acts as a variable. The
value assigned to the name “variable” will be the value that is returned when the function is called. If
no value is assigned to name, the function will always return a value of zero (if the function has a
numeric data type), FALSE (if the function has a logical data type), or a null string (if the function has
a string data type).
Restrictions on Parameter Passing
A function call can return only one “scalar” value at a time. In other words, a single function call
cannot return an entire array's worth of values, nor can a single function call return a set of values to
fill in a custom data Type variable. By default, every parameter to a user-defined function is a byreference parameter. This means that the function's caller must specify the name of a variable as the
parameter. If the function modifies the value of a by-reference parameter, the modified value will be
reflected in the caller's variable.
Reference Guide
311
Function…End Function statement
Any or all of a function's parameters may be specified as by-value if the optional ByVal keyword
precedes the parameter name in the Function…End Function definition. When a parameter is
declared by-value, the function's caller can specify an expression for that parameter, rather than
having to specify the name of a single variable. However, if a function modifies the value of a byvalue parameter, there is no way for the function's caller to access the new value. You cannot pass
arrays, custom Type variables, or Alias variables as ByVal parameters to custom functions.
However, you can pass any of those data types as by-reference parameters. If your custom function
takes no parameters, your Function…End Function statement can either include an empty pair of
parentheses, or omit the parentheses entirely. However, every function call must include a pair of
parentheses, regardless of whether the function takes parameters. For example, if you wish to
define a custom function called Foo, your Function…End Function statement could either look like
this:
Function Foo( )
' ... statement list goes here ...
End Function
or like this:
Function Foo
' ... statement list goes here ...
End Function
but all calls to the function would need to include the parentheses, in this fashion:
var_name = Foo( )
Availability of Custom Functions
The user may not incorporate calls to user-defined functions when filling in standard MapInfo
Professional dialog boxes. A custom function may only be called from within a compiled MapBasic
application. Thus, a user may not specify a user-defined function within the SQL Select dialog box;
however, a compiled MapBasic program may issue a Select statement which does incorporate
calls to user-defined functions.
A custom function definition is only available from within the application that defines the function. If
you write a custom function which you wish to include in each of several MapBasic applications, you
must copy the Function…End Function definition to each of the program files.
Function Names
The Function…End Function statement's name parameter can match the name of a standard
MapBasic function, such as Abs or Chr$. Such a custom function will replace the standard
MapBasic function by the same name (within the confines of that MapBasic application). If a
program defines a custom function named Abs, any subsequent calls to the Abs function will
execute the custom function instead of MapBasic's standard Abs( )function.
When a MapBasic application redefines a standard function in this fashion, other applications are
not affected. Thus, if you are writing several separate applications, and you want each of your
applications to use your own, customized version of the Distance( ) function, each of your
applications must include the appropriate Function…End Function statement.
312
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
When a MapBasic application redefines a standard function, the re-definition applies throughout the
entire application. In every procedure of that program, all calls to the redefined function will use the
custom function, rather than the original.
Example
The following example defines a custom function, CubeRoot, which returns the cube root of a
number (the number raised to the one-third power). Because the call to CubeRoot appears earlier in
the program than the CubeRoot Function…End Function definition, this example uses the Declare
Function statement to pre-define the CubeRoot function parameter list.
Declare Function CubeRoot(ByVal x As Float) As Float
Declare Sub Main
Sub Main
Dim f_result As Float
f_result = CubeRoot(23)
Note Str$(f_result)
End Sub
Function CubeRoot(ByVal x As Float) As Float
CubeRoot = x ^ 0.33333333333
End Function
See Also
Declare Function statement, Declare Sub statement, Sub…End Sub statement
Reference Guide
313
Geocode statement
Geocode statement
Purpose
Geocodes a table or individual value using a remote geocode service through a connection created
using the Open Connection statement and set up using the Set Connection Geocode statement.
Syntax
Geocode connection_number
Input
[ Table input_tablename ]
[ Country = Country_expr
[ Street = Street_expr,
[ IntersectingStreet = IntersectingStreet_expr ],
Municipality = Municipality_expr,
CountrySubdivision = CountrySubdiv_expr,
PostalCode = PostalCode_expr,
CountrySecondarySubdivision= CountrySecondarySubdiv_expr,
SecondaryPostalCode = SecondaryPostalCode_expr,
Placename = Placename_expr,
Street2 = Street2_expr,
MunicipalitySubdivision = MunicipalitySubdiv_expr ] ]
Output
[ Into
[ Table out_tablename [ Key out_keycolumn = in_keyexpr ] ] |
[ Variable variable_name ]]
[ Point [ On | Off ] [ Symbol Symbol_expr ], ]
[ Street_column = Street, Municipality_column = Municipality,
CountrySubdiv_column = CountrySubdivision,
PostalCode_column = PostalCode,
CountrySecondarySubdiv_column = CountrySecondarySubdivision,
SecondaryPostalCode_column = SecondaryPostalCode,
Placename_column = Placename,
MunicipalitySubdiv_column = MunicipalitySubdivision,
Country_column = Country, ResultCode_column = ResultCode,
Latitude_column = Latitude, Longitude_column = Longitude
Columns colname = geocoder_keyname [,] ...]
[ Interactive [ On [ Max Candidates candidates_expr | All ]
[ CloseMatchesOnly [ On | Off ] ]
| Off [ First | None ]]
connection_number is the number returned when the connection was created. See Open
Connection statement on page 449.
input_tablename is a table alias of an open table including result sets and selections.
Country_expr is a string expression representing the three letter ISO code for the country.
Street_expr is an expression that specifies a street address.
IntersectingStreet_expr is an expression that specifies a street that should intersect with the street
specified in Street_expr.
314
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Municipality_expr is an expression that specifies the name of a municipality.
CountrySubdivision_expr is an expression that specifies the name of a subdivision of a country. For
example, in the US this specifies the name of a state. In Canada it specifies the name of a province.
PostalCode_expr is an expression that specifies a postal code.
CountrySecondarySubdiv_expr is an expression that specifies the name of a secondary subdivision
for a country. For example, in the US this corresponds to a county, in Canada this corresponds to a
census division.
SecondaryPostalCode_expr is an expression that specifies a secondary postal code system. In the
US this corresponds to a ZIP+4 extension on a ZIP Code.
Placename_expr is an expression that specifies the name of a well-known place, such as a large
building that may contain multiple addresses.
Street2_expr is an expression that specifies a secondary address line.
MunicipalitySubdiv_expr is an expression that specifies the name of a municipality subdivision.
out_tablename is a table alias of a table to be used as the holder of the data resulting from the
geocode operation.
out_keycolumn is a string representing the name of a key column in the output table that will be used
to hold some identifying “key” from the input records. This is used to identify the record from where
the geocode came.
in_keyexpr is an expression from (the input table) whose value is inserted in the output record.
variable_name is the name of a variable that can hold a single geometry.
Symbol_expr is an expression that specifies the symbol to use when displaying a Point from the
geometry column. See Symbol clause on page 680 for more information.
Street_column is an alias that represents the name of the column to hold the Street result.
Municipality_column is a string the represents the name of the column to hold the Municipality result.
CountrySubdiv_column is a string the represents the name of the column to hold the Country
Subdivision result.
PostalCode_column is a string the represents the name of the column to hold the Postal Code
result.
CountrySecondarySubdiv_column is a string the represents the name of the column to hold the
Country Secondary Subdivision result.
SecondaryPostalCode_column is a string the represents the name of the column to hold the
Secondary Postal Code result.
Placename_column is a string the represents the name of the column to hold the Placename result.
MunicipalitySubdiv_column is a string the represents the name of the column to hold the Municipality
Subdivision result.
Country_column is a string the represents the name of the column to hold the Country result.
Reference Guide
315
Geocode statement
ResultCode_column is a string the represents the name of the column to hold the Result Code
generated by the geocoder.
Latitude_column is a string the represents the name of the float or decimal column to hold the
Latitude result.
Longitude_column is a string the represents the name of the float or decimal column to hold the
Longitude result.
colname is a string the represents the name of the column for a geocoder-specific result.
geocoder_keyname is a string representing the name of a country-specific geocoder item. These
items are documented by the specific geocoder.
candidates_expr is an expression that specifies the number of candidates to be returned in an
interactive geocoding session.
Description
Every Geocode statement must include an Input clause and an Output clause. The
input_tablename is optional, however if a table is not specified, the resulting geocode operation
would be performed on a set of string inputs (variables or constants), so that only a single address is
geocoded in each request. The output_tablename is also optional. See Table vs. non-table- based
input and output below.
Input clause
The Input clause is required as a geocode request needs some input data.
A Country must be specified either as an explicit argument or as a column in input_tablename.
When a single country is used, it can be a constant string if no data is available. ISO standard three
letter country codes must be used.
The list of fields to include from input_table to be geocoded must include at least one value. The
more expressions that are included, the more accurate your geocoding result will be.
Output clause
The Output clause is required, as without it, the entire command returns nothing.
Into Table indicates that the Output clause refer to columns in output_table, which must be writable.
If not specified, the clauses refer to the input_table. Note that if the input columns are to be updated,
they must be specified both for input AND output.
Key is used with Into Table. This clause creates a relationship between the key columns in the input
and output table.
Variable specifies that the geometry result from the geocode operation is stored in a variable
defined in variable_name. When using this output option, note that if the input is a table only the first
record is processed and the remainder of the records are skipped.
Point specifies that the geographic result of the geocode is to be stored in either the table or the
variable. In the case of a table, this requires that the table be mappable.
316
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
To store the point stored into the object column, specify Point or Point On (default is on). The
current default symbol is used. To return the same using a specific symbol, specify Point On
Symbol symbol_expr. If you do not want to store the point in the object column, specify Point Off.
Whether you want the object created or not, you can still store the x and y values in real number
columns. To do this specify those columns as Latitude = latitude_column Longitude =
longitude_column.
The rest of the output data specifies columns in the output table where well known geocoder return
values are stored. In general, these may be more specific than the input. For example, it may be
possible to geocode an address with just a business name of “MapInfo” and a post code of “12180”.
However, much more is returned in the output. The Columns extension allows for data to be
returned that is geocoder specific. The user must know the names of the keys as defined by the
geocoders.
Table vs. non-table- based input and output
The Geocode statement can be used with any combination of table-based and non-table-based
inputs and outputs. If you choose to use a table-based input you can have your output placed into
either a new or existing table, or into a variable. If the output is a variable then only the first record is
processed and the only value stored is the geographic object.
If you choose non-table-based input, the values for the operation must either be expressions (not
column names), variables, or constant strings, the output can be placed either into a table or
assigned to a variable.
Interactive clause
Interactive [ On | Off ] is an optional keyword that controls whether a dialog box to be displayed in
the case of multiple candidates returned for each address. When this occurs, the user is prompted to
choose, respecify, skip, or cancel the operation.
is asked to decide which of the choices is best given the opportunity to skip this input. When On, the
dialog box displays in these situations. When Off, if multiple matches occur the choices are to
accept the first candidate or none, meaning that the record is skipped. The default is skipping the
record.
If the Interactive keyword is not included, it is equivalent to Interactive Off None and no options
can be specified. If Interactive is specified, the default is On.
•
•
•
•
•
Interactive is equivalent to Interactive On. When no value is provided for Max the default is
three (3) candidates to be returned.
Interactive On Max Candidates All returns all candidates
Interactive On Max Candidates 4* myMBVariable/6 returns the number of candidates
resulting from the evaluation of the expression.
Interactive Off is equivalent to Interactive Off None.
Interactive Off First returns the first candidate in the list.
The CloseMatchesOnly setting sets the geocode service to only return close matches as defined
by the server. If CloseMatchesOnly is set to Off, all results are returned up to the number defined in
Max Candidates with the ones that are considered to be close marked as such.
Reference Guide
317
GeocodeInfo( ) function
Examples
The following example shows a geocode request using the nystreets table and specifying the use of
the city, Streetname, state, and postalcode.
Geocode connectionHandle Input Table nystreets municipality=city,
street=StreetName, countrysubdivision=state, postalcode=zip,
country="usa"
OUTPUT StreetName=street, address=municipality
This example shows a geocode request using the nystreets table and specifying a symbol for
displaying the output.
Geocode connectionHandle Input Table nystreets street=StreetName,
country="usa"
Output Point Symbol MakeFontSymbol(65, 255 ,24,"MapInfo
Cartographic",32,0), StreetName=street
This example sends a request with the Interactive set to On with the return value being placed into
the street column.
Geocode connectionHandle Input Table nystreets street=StreetName,
country="usa"
Output Point Symbol MakeFontSymbol(65, 255 ,24,"MapInfo
Cartographic",32,0),
StreetName=street Interactive on Max Candidates 5
The following example shows a Geocode request without using a table and outputting the results
into a variable:
Geocode connectionHandle Input street="1 Global View", country="usa",
countrysubdivison="NY", municipality="Troy"
Output Variable outvar
See Also
Open Connection statement
GeocodeInfo( ) function
Purpose
Returns any and all attributes that were set on a connection using the Set Connection Geocode
statement. In addition, GeocodeInfo( ) can also return some status values from the last geocode
command issued using each connection. There is also an attribute to handle the maximum number
of addresses that the server will permit to be sent to the service at a time.
Syntax
GeoCodeInfo( connection_handle, attribute )
connection_handle is an Integer.
attribute is an Integer code, indicating which type of information should be returned.
318
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Return Value
Float, Integer, SmallInt, Logical, or String, depending on the attribute parameter.
Description
The GeoCodeInfo( ) function returns the properties defaulted by the connection or the properties
that have been changed using Set GeoCode. Like many functions of this type in MapBasic, the
return values vary according to the attribute parameter. All the codes for these values are listed in
MAPBASIC.DEF.
attribute Value
GeoCodeInfo( ) Return Value
GEOCODE_STREET_NAME
Logical representing whether or not a match for
StreetName is set.
GEOCODE_STREET_NUMBER
Logical representing whether or not a match for
StreetNumber is set.
GEOCODE_MUNICIPALITY
Logical representing whether or not a match for
municipality is set.
GEOCODE_MUNICIPALITY2
Logical representing whether or not a match for
MunicipalitySubdivision is set.
GEOCODE_COUNTRY_SUBDIVISION
Logical representing whether a match for
CountrySubdivision is set.
GEOCODE_COUNTRY_SUBDIVISION2
Logical representing whether or not a match for
CountrySecondarySubdivision is set.
GEOCODE_POSTAL_CODE
Logical representing whether or not a match for
PostalCode is set.
GEOCODE_DICTIONARY
SmallInt value representing one of these five values:
•
•
•
•
•
DICTIONARY_ALL
DICTIONARY_ADDRESS_ONLY
DICTIONARY_USER_ONLY
DICTIONARY_PREFER_ADDRESS
DICTIONARY_PREFER_USER
GEOCODE_BATCH_SIZE
Integer value representing the batch size.
GEOCODE_FALLBACK_GEOGRAPHIC
Logical representing whether or not the geocoder
should fall back to a geographic centroid when other
options fail.
GEOCODE_FALLBACK_POSTAL
Logical representing whether or not the geocoder
should fall back to a postal centroid when other
options fail.
Reference Guide
319
GeocodeInfo( ) function
attribute Value
GeoCodeInfo( ) Return Value
GEOCODE_OFFSET_CENTER
Float value representing the distance from the center
of the road that the point is returned.
GEOCODE_OFFSET_CENTER_UNITS
String value representing the units of the center of
the road values.
GEOCODE_OFFSET_END
Float value representing the distance from the end of
the road that the point is returned.
GEOCODE_OFFSET_END_UNITS
String value representing the units of the offset from
end of street value
GEOCODE_MIXED_CASE
Logical representing whether MapInfo should format
the strings returned in mixed case or leave them as
uppercase. This option may not be available for all
countries. The option uses a country specific
algorithm that has knowledge of what address parts
and what items should be capitalized and what
should be made lower case.
GEOCODE_RESULT_MARK_MULTIPLE
Logical representing whether MapInfo Professional
should change the result code returned from the
server by adding an indicator to the result code that
the result was based on an arbitrary choice between
multiple close matches. This flag only affects the
behavior under the following circumstances:
1. The geocoding was not interactive so no
possibility of presenting the candidates dialog
was possible.
2. The non-interactive command flag was to pick the
first candidate returned rather than none. (see
Geocode command “First”). This forces MapInfo
to pick one of the candidates.
3. The actual request returned more than one close
match for a particular record.
320
GEOCODE_COUNT_GEOCODED
Integer value representing the number of records
geocoded during the last operation.
GEOCODE_COUNT_NOTGEOCODED
Integer value representing the number of records not
geocoded during the last operation.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute Value
GeoCodeInfo( ) Return Value
GEOCODE_UNABLE_TO_CONVERT_D
ATA
Logical representing whether a column was not
updated during the last operation because of a data
type problem. The case where this occurs is when
integer columns are erroneously specified for nonnumeric postal codes.
GEOCODE_PASSTHROUGH
Integer specifying the number of passthrough items
set on this connection. There are two items for each
pair. This value is used to know when to stop the
enumeration of these values without error.
GEOCODE_PASSTHROUGH + n
String values alternately representing name and
value for each passthrough pair. n is valid up to the
value returned via
GEOCODE_INFO_PASSTHROUGH.
GEOCODE_MAX_BATCH_SIZE
Integer value representing the maximum number of
records (i.e., addresses) that the server will permit to
be sent to the service at one time.
Example
The following MapBasic snippet will print the Envinsa Location Utility Constraints to the message
window in MapInfo Professional:
Include "MapBasic.Def"
declare sub main
sub main
dim iConnect as integer
Open Connection Service Geocode Envinsa
URL
"http://envinsa_server:8066/LocationUtility/services/LocationUtility"
User "john"
Password "green"
into variable iConnect
Print "Geocode Max Batch Size: " +
GeoCodeInfo(iConnect,GEOCODE_MAX_BATCH_SIZE)
end sub
See Also
Open Connection statement, Set Connection Geocode statement
Reference Guide
321
Get statement
Get statement
Purpose
Reads from a file opened in Binary or Random access mode.
Syntax
Get [#] filenum, [ position ], var_name
filenum is the number of a file opened through an Open File statement.
position is the file position to read from.
var_name is the name of a variable where MapBasic will store results.
Description
The Get statement reads from an open file. The behavior of the Get statement and the set of
parameters which it expects are affected by the options specified in the preceding Open File
statement.
If the Open File statement specified Random file access, the Get statement's Position clause can
be used to indicate which record of data to read. When the file is opened, the file position points to
the first record of the file (record 1). A Get automatically increments the file position, and thus the
Position clause does not need to be used if sequential access is being performed. However, you can
use the Position clause to set the record position before the record is read.
If the Open File statement specified Binary file access, one variable can be read at a time. What
data is read depends on the byte-order format of the file and the var_name variable being used to
store the results. If the variable type is integer, then 4 bytes of the binary file will be read, and
converted to a MapBasic variable. Variables are stored the following way:
Variable Type
322
Storage In File
Logical
One byte, either 0 or non-zero.
SmallInt
Two byte integer.
Integer
Four byte integer.
Float
Eight byte IEEE format.
String
Length of string plus a byte for a 0 string terminator.
Date
Four bytes: SmallInt year, byte month, byte day.
Other data types
Cannot be read.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
With Binary file access, the position parameter is used to position the file pointer to a specific offset
in the file. When the file is opened, the position is set to one (the beginning of the file). As a Get is
performed, the position is incremented by the same amount read. If the Position clause is not used,
the Get reads from where the file pointer is positioned.
Note: The Get statement requires two commas, even if the optional position parameter is omitted.
If a file was opened in Binary mode, the Get statement cannot specify a variable-length string
variable; any string variable used in a Get statement must be fixed-length.
See Also
Open File statement, Put statement
GetDate function
Purpose
Returns the Date component of a DateTime.
Syntax
GetDate (DateTime)
Return Value
Date
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim dtX as datetime
dim Z as date
dtX = "03/07/2007 12:09:09.000 AM"
Z = GetDate(dtX)
Print FormatDate$(Z)
Reference Guide
323
GetFolderPath$( ) function
GetFolderPath$( ) function
Purpose
Returns the path of a special MapInfo Professional or Windows directory.
Syntax
GetFolderPath$( folder_id )
folder_id is one of the following values:
FOLDER_MI_APPDATA
FOLDER_MI_LOCAL_APPDATA
FOLDER_MI_PREFERENCE
FOLDER_MI_COMMON_APPDATA
FOLDER_APPDATA
FOLDER_LOCAL_APPDATA
FOLDER_COMMON_APPDATA
FOLDER_COMMON_DOCS
FOLDER_MYDOCS
FOLDER_MYPICS
Return Value
String
Description
Given the ID of a special MapInfo or Windows directory, GetFolderPath$( ) function returns the path
of the directory. An example of a special Windows directory is the My Documents directory. An
example of a special MapInfo directory is the preference directory; the default location to which
MapInfo Professional writes out the preference file.
The location of many of these directories varies between versions of Windows. They can also vary
depending on which user is logged in. Note that FOLDER_MI_APPDATA,
FOLDER_MI_LOCAL_APPDATA, and FOLDER_MI_COMMON_APPDATA may not exist. Before
attempting to access those directories, test for their existence by using FileExists( ) function.
FOLDER_MI_PREFERENCE always exists.
IDs beginning in FOLDER_MI return the path for directories specific to MapInfo Professional. The
rest of the IDs return the path for Windows directories and correspond to the IDs defined for WIN32
API function SHGetFolderPath. The most common of these IDs have been defined for easy use in
MapBasic applications. Any ID valid to SHGetFolderPath will work with GetFolderPath$( ).
324
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
include "mapbasic.def"
declare sub main
sub main
dim sMiPrfFile as string
sMiPrfFile = GetFolderPath$(FOLDER_MI_PREFERENCE)
Print sMiPrfFile
end subet128
See Also
LocateFile$( ) function
GetMetadata$( ) function
Purpose
Retrieves metadata from a table.
Syntax
GetMetadata$( table_name, key_name )
table_name is the name of an open table, specified either as an explicit table name (for example,
World) or as a string representing a table name (for example, “World”).
key_name is a string representing the name of a metadata key.
Return Value
String, up to 239 bytes long. If the key does not exist, or if there is no value for the key, MapInfo
Professional returns an empty string.
Description
This function returns a metadata value from a table. For more information about querying a table's
metadata, see Metadata statement on page 394, or see the MapBasic User Guide.
Example
If the Parcels table has a metadata key called “\Copyright” then the following statement reads the
key's value:
Print GetMetadata$(Parcels, "\Copyright")
See Also
Metadata statement
Reference Guide
325
GetSeamlessSheet( ) function
GetSeamlessSheet( ) function
Purpose
Prompts the user to select one sheet from a seamless table, and then returns the name of the
chosen sheet.
Syntax
GetSeamlessSheet( table_name )
table_name is the name of a seamless table that is open.
Return Value
String, representing a table name (or an empty string if user cancels).
Description
This function displays a dialog box listing all of the sheets that make up a seamless table. If the user
chooses a sheet and clicks OK, this function returns the table name the user selected. If the user
cancels, this function returns an empty string.
Example
Sub Browse_A_Table(ByVal s_tab_name As String)
Dim s_sheet As String
If TableInfo(s_tab_name, TAB_INFO_SEAMLESS) Then
s_sheet = GetSeamlessSheet(s_tab_name)
If s_sheet <> "" Then
Browse * From s_sheet
End If
Else
Browse * from s_tab_name
End If
End Sub
See Also
Set Table statement, TableInfo( ) function
326
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
GetTime function
Purpose
Returns the Time component of a DateTime.
Syntax
GetTime (DateTime)
Return Value
Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim dtX as datetime
dim Z as time
dtX = "03/07/2007 12:09:09.000 AM"
Z = GetTime(dtX)
Print FormatTime$(Z,"hh:mm:ss.fff tt")
Global statement
Purpose
Defines one or more global variables.
Syntax
Global var_name [ , var_name... ] As var_type
[ , var_name... ] As var_type... ]
var_name is the name of a global variable to define.
var_type is integer, float, date, logical, string, or a custom variable Type.
Description
A Global statement defines one or more global variables. Global statements may only appear
outside of a sub procedure.
The syntax of the Global statement is identical to the syntax of the Dim statement; the difference is
that variables defined through a Global statement are global in scope, while variables defined
through a Dim statement are local. A local variable may only be examined or modified by the sub
procedure which defined it, whereas any sub procedure in a program may examine or modify any
global variable. A sub procedure may define local variables with names which coincide with the
names of global variables. In such a case, the sub procedure's own local variables take precedence
(i.e., within the sub procedure, any references to the variable name will utilize the local variable, not
Reference Guide
327
Goto statement
the global variable by the same name). Global array variables may be re-sized with the ReDim
statement. Windows, global variables are “visible” to other Windows applications through DDE
conversations.
Example
Declare Sub testing( )
Declare Sub Main( )
Global gi_var As Integer
Sub Main( )
Call testing
Note Str$(gi_var) ' this displays "23"
End Sub
Sub testing( )
gi_var = 23
End Sub
See Also
Dim statement, ReDim statement, Type statement, UBound( ) function
Goto statement
Purpose
Jumps to a different spot (in the same procedure), identified by a label.
Restrictions
You cannot issue a Goto statement through the MapBasic window.
Syntax
Goto label
label is a label appearing elsewhere in the same procedure.
Description
The Goto statement performs an unconditional jump. Program execution continues at the statement
line identified by the label. The label itself should be followed by a colon; however, the label name
should appear in the Goto statement without the colon.
Generally speaking, the Goto statement should not be used to exit a loop prematurely. The Exit Do
statement and Exit For statement provide the ability to exit a loop. Similarly, you should not use a
Goto statement to jump into the body of a loop.
A Goto statement may only jump to a label within the same procedure.
328
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Goto endproc
...
endproc: End Program
See Also
Do Case…End Case statement, Do…Loop statement, For…Next statement, OnError
statement, Resume statement
Graph statement
Purpose
Opens a new Graph window.
Syntax (5.5 and later)
Graph
label_column, expr [ , ... ]
From table
[ Position ( x, y ) [ Units paperunits ] ]
[ Width window_width [ Units paperunits ] ]
[ Height window_height [ Units paperunits ] ]
[ Min | Max ]
[ Using template_file [ Restore ] [ Series In Columns ] ]
label_column is the name of the column to use for labelling the y-axis.
expr is an expression providing values to be graphed.
table is the name of an open table.
paperunits is the name of a paper unit (for example, “in”).
x, y specifies the position of the upper left corner of the Grapher, in paper units.
window_width and window_height specify the size of the Grapher, in paper units.
template_file is a valid graph template file.
Syntax (pre-version 5.5)
Graph
label_column, expr [ , ... ]
From table
[ Position ( x, y ) [ Units paperunits ] ]
[ Width window_width [ Units paperunits ] ]
[ Height window_height [ Units paperunits ] ]
[ Min | Max ]
label_column is the name of the column to use for labelling the y-axis.
Reference Guide
329
Graph statement
expr is an expression providing values to be graphed.
table is the name of an open table.
paperunits is the name of a paper unit (for example, “in”).
x, y specifies the position of the upper left corner of the Grapher, in paper units.
window_width and window_height specify the size of the Grapher, in paper units.
Description
If the Using clause is present and template_file specifies a valid graph template file, then a graph is
created based on the specified template file. Otherwise a 5.0 graph is created. If the Restore clause
is included, then title text in the template file is used in the graph window. Otherwise default text is
used for each title in the graph. The Restore keyword is included when writing the Graph command
to a workspace, so when the workspace is opened the title text is restored exactly as is was when
the workspace was saved. The Restore keyword is not used in the Graph command constructed by
the Create Graph wizard, so the default text is used for each title. If Series In Columns is included,
then the graph series are based on the table columns. Otherwise the series are based on the table
rows.
Graph commands in workspaces or programs that were created prior to version 5.5 will still create a
5.0 graph window. When a 5.0 graph window is active in MapInfo Professional 5.5 or later, the 5.0
graph menu will be also be active, so the user can modify the graph using the 5.0 editing dialog
boxes. The Create Graph wizard will always created a 5.5 or later version graph window.
The Graph statement adds a new Grapher window to the screen, displaying the specified table. The
graph will appear as a rotated bar chart; subsequent Set Graph statements can re-configure the
specifics of the graph (for example, the graph rotation, graph type, title, etc.).
MapInfo Professional 's Window > Graph dialog box is limited in that it only allows the user to
choose column names to graph. MapBasic's Graph statement, however, is able to graph full
expressions which involve column names. Similarly, although the Graph dialog box only allows the
user to choose four columns to graph, the Graph statement can construct a graph with up to 255
columns.
If the Graph statement includes the optional Max keyword, the resultant Grapher window is
maximized, taking up all of the screen space available to MapInfo Professional. Conversely, if the
Graph statement includes the Min keyword, the window is minimized.
Example (5.5 and later graphs)
Graph State_Name, Pop_1980, Pop_1990, Num_Hh_80 From States Using
"C:\Program Files\MapInfo\GRAPHSUPPORT\Templates\Column\Percent.3tf"
Graph City, Tot_hu, Tot_pop From City_125 Using "C:\Program
Files\MapInfo\GRAPHSUPPORT\Templates\Bar\Clustered.3tf" Series In Columns
Example (pre-5.5 graphs)
Graph Country, Population From Selection
See Also
Set Graph statement
330
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
HomeDirectory$( ) function
Purpose
Returns a string indicating the user's home directory path.
Syntax
HomeDirectory$( )
Return Value
String
Description
The HomeDirectory$( ) function returns a string which indicates the user's home directory path.
The significance of a home directory path depends on the hardware platform on which the user is
running. The table below summarizes the platform-dependent home directory path definitions.
Environment
Windows
Definition of “Home Directory”
The directory path to the user's Windows directory. This is the directory
containing Windows system files, such as SYSTEM.INI and WIN.INI. In a
networked environment, each user has a private Windows directory, to allow
each user to have a unique configuration.
Example
Dim s_home_dir As String
s_home_dir = HomeDirectory$( )
See Also
ApplicationDirectory$( ) function, ProgramDirectory$( ) function, SystemInfo( ) function
HotlinkInfo function
Purpose
Returns information about a HotLink definition in a map layer.
Syntax
HotlinkInfo ( map_window_id, layer_number, hotlink_number, attribute )
map_window_id is a Map window identifier.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer);
to determine the number of layers in a Map window, call the MapperInfo( ) function.
Reference Guide
331
Hour function
hotlink_number - the index of the hotlink definition being queried. The first hotlink definition in a
layer has index of 1.
attribute - the following attribute values are allowed:
HOTLINK_INFO_EXPR
Returns the filename expression for this hotlink definition.
HOTLINK_INFO_MODE
Returns the mode for this hotlink definition, one of the
following predefined values:
•
•
•
HOTLINK_MODE_LABEL
HOTLINK_MODE_OBJ
HOTLINK_MODE_BOTH
HOTLINK_INFO_RELATIVE
Returns TRUE if the relative path option is on for this hotlink
definition.
HOTLINK_INFO_ENABLED
Returns TRUE if this hotlink definition is enabled.
See Also
Set Map statement, LayerInfo( ) function,
Hour function
Purpose
Returns the hour component of a Time.
Syntax
Hour (Time)
Return Value
Number
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim Z as time
dim iHour as integer
Z = CurDateTime()
iHour = Hour(Z)
Print iHour
332
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If…Then statement
Purpose
Decides which block of statements to execute (if any), based on the current value of one or more
expressions.
Syntax
If if_condition Then
if_statement_list
[ ElseIf elseif_condition Then
elseif_statement_list ]
[ ElseIf ... ]
[ Else
else_statement_list ]
End If
Each condition is a condition which will evaluate to TRUE or FALSE
Each statement_list is a list of zero or more statements.
Restrictions
You cannot issue an If…Then statement through the MapBasic window.
Description
The If…Then statement allows conditional execution of different groups of statements.
In its simplest form, the If statement does not include an ElseIf clause, nor an Else clause:
If if_condition Then
if_statement_list
End If
With this arrangement, MapBasic evaluates the if_condition at run-time. If the if_condition is TRUE,
MapBasic executes the if_statement_list; otherwise, MapBasic skips the if_statement_list.
An If statement may also include the optional Else clause:
If if_condition Then
if_statement_list
Else
else_statement_list
End If
With this arrangement, MapBasic will either execute the if_statement_list (if the condition is TRUE)
or the else_statement_list (if the condition is FALSE).
Reference Guide
333
If…Then statement
Additionally, an If statement may include one or more ElseIf clauses, following the If clause (and
preceding the optional Else clause):
If if_condition Then
if_statement_list
ElseIf elseif_condition Then
elseif_statement_list
Else
else_statement_list
End If
With this arrangement, MapBasic tests a series of two or more conditions, continuing until either one
of the conditions turns out to be TRUE or until the Else clause or the End If is reached. If the
if_condition is TRUE, MapBasic will perform the if_statement_list, and then jump down to the
statement which follows the End If. But if that condition is FALSE, MapBasic then evaluates the
else_if_condition; if that condition is TRUE, MapBasic will execute the elseif_statement_list.
An If statement may include two or more ElseIf clauses, thus allowing you to test any number of
possible conditions. However, if you are testing for one out of a large number of possible conditions,
the Do Case…End Case statement is more elegant than an If statement with many ElseIf clauses.
Example
Dim today As Date
Dim today_mon, today_day, yearcount As Integer
today = CurDate( ) ' get current date
today_mon = Month(today) ' get the month value
today_day = Day(today) ' get the day value (1-31)
If today_mon = 1 And today_day = 1 Then
Note "Happy New Year!"
yearcount = yearcount + 1
ElseIf today_mon = 2 And today_day = 14 Then
Note "Happy Valentine's Day!"
ElseIf today_mon = 12 And today_day = 25 Then
Note "Merry Christmas!"
Else
Note "Good day."
End If
See Also
Do Case…End Case statement
334
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Import statement
Purpose
Creates a new MapInfo Professional table by importing an exported file, such as a GML or DXF file.
Syntax 1 (for importing MIF/MID files, PICT files, or MapInfo for DOS files)
Import file_name
[ Type file_type ]
[ Into table_name ]
[ Overwrite ]
Syntax 2 (for importing DXF files)
Import file_name
[ Type "DXF" ]
[ Into table_name ]
[ Overwrite ]
[ Warnings { On | Off } ]
[ Preserve
[ AttributeData ] [ Preserve ] [ Blocks As MultiPolygonRgns ] ]
[ CoordSys... ]
[ Autoflip ]
[ Transform
( DXF_x1, DXF_y1 ) ( DXF_x2, DXF_y2 )
( MI_x1, MI_y1 ) ( MI_x2, MI_y2 ) ]
[ Read
[ Integer As Decimal ] [ Read ] [ Float As Decimal ] ]
[ Store [ Handles ] [ Elevation ] [ VisibleOnly ] ]
[ Layer DXF_layer_name
[ Into table_name ]
[ Preserve
[ AttributeData ] [ Preserve ] [ Blocks As MultiPolygonRgns ] ]
]
[ Layer... ]
Syntax 3 (for GML files)
Import file_name
[ Type "GML" ]
[ Layer layer_name ]
[ Into table_name ]
[ Style Auto [ On | Off ] ]
Reference Guide
335
Import statement
Syntax 4 (for GML 2.1 files)
Import file_name
[ Type "GML21" ]
[ Layer layer_name]
[ Into table_name ]
[ Overwrite ]
[ CoordSys... ]
file_name is a string that specifies the name of the file to import.
file_type is a string that specifies the import file format (MIF, MBI, MMI, IMG, GML GML21, or PICT).
table_name specifies the name of the new table to create.
DXF_x1, DXF_y1, etc. are numbers that represent coordinates in the DXF file.
MI_x1, MI_y1, etc. are numbers that represent coordinates in the MapInfo table.
DXF_layer_name is a string representing the name of a layer in the DXF file.
layer_name is a string representing the name of a layer in the GML file.
Description
The Import statement creates a new MapInfo table by importing the contents of an existing file.
Note: To create a MapInfo table based on a spreadsheet or database file, use the Register Table
statement, not the Import statement.
The Into clause lets you override the name and location of the MapInfo table that is created. If no
Into clause is specified, the new table is created in the same directory location as the original file,
with a corresponding file name. For example, on Windows, if you import the text file “WORLD.MIF”,
the new table's default name is “WORLD.TAB”.
The optional Type clause specifies the format of the file you want to import. The Type clause can
take one of the following forms:
Type clause
File Format Specified
Type “DXF”
DXF file (a format supported by CAD packages, such as AutoCAD).
Type “MIF”
MIF/MID file pair, created by exporting a MapInfo table.
Type “MBI”
MapInfo Boundary Interchange, created by MapInfo for DOS.
Type “MMI”
MapInfo Map Interchange, created by MapInfo for DOS.
Type “IMG”
MapInfo Image file, created by MapInfo for DOS.
Type “GML”
GML files
Type “GML21”
GML 2.1 files.
If you omit the Type clause, MapInfo Professional assumes that the file's extension indicates the file
format. For example, a file named “PARCELS.DXF” is assumed to be a DXF file.
336
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If you include the optional Overwrite keyword, MapInfo Professional creates a new table, regardless
of whether a table by that name already exists; the new table replaces the existing table. If you omit
the Overwrite keyword, and the table already exists, MapInfo Professional does not overwrite the
table.
Import Options for DXF Files
If you import a DXF file, the Import statement can include the following DXF-specific clauses.
Note: The order of the clauses is important; placing the clauses in the wrong order can cause
compilation errors.
Warnings On or Warnings Off
Controls whether warning messages are displayed during the import operation. By default, warnings
are off.
Preserve AttributeData
Include this clause if you want MapInfo Professional to preserve the attribute data from the DXF file.
Preserve Blocks As MultiPolygonRgns
Include this clause if you want MapInfo Professional to store all of the polygons from a DXF block
record into one multiple-polygon region object. If you omit this clause, each DXF polygon becomes a
separate MapInfo Professional region object.
CoordSys
Controls the projection and coordinate system of the table. For details, see CoordSys clause on
page 163.
Autoflip
Include this option if you want the map's x-coordinates to be flipped around the center line of the
map. This option is only allowed if you specify a non-Earth coordinate system.
Transform
Specifies a coordinate transformation. In the Transform clause, you specify the minimum and
maximum x- and y-coordinates of the imported file, and you specify the minimum and maximum
coordinates that you want to have in the MapInfo table.
Read Integer As Decimal
Include this clause if you want to store whole numbers from the DXF file in a decimal column in the
new table. This clause is only allowed when you include the Preserve AttributeData clause.
Reference Guide
337
Import statement
Read Float As Decimal
Include this clause if you want to store floating-point numbers from the DXF file in a decimal column
in the new table. This clause is only allowed when you include the Preserve AttributeData clause.
Store [Handles] [Elevation] [VisibleOnly]
If you include Handles, the MapInfo table stores handles (unique ID numbers of objects in the
drawing) in a column called _DXFHandle. If you include Elevation, MapInfo Professional stores
each object's center elevation in a column called _DXFElevation. (For lines, MapInfo Professional
stores the elevation at the center of the line; for regions, MapInfo Professional stores the average of
the object's elevation values.) If you include VisibleOnly, MapInfo Professional ignores invisible
objects.
Layer clause
If you do not include any Layer clauses, all objects from the DXF file are imported into a single
MapInfo table. If you include one or more Layer clauses, each DXF layer that you name becomes a
separate MapInfo table.
If your DXF file contains multiple layers, and if your Import statement includes one or more Layer
clauses, MapInfo Professional only imports the layers that you name. For example, suppose your
DXF file contains four layers (layers 0, 1, 2, and 3). The following Import statement imports all four
layers into a single MapInfo table:
Import "FLOORS.DXF"
Into "FLOORS.TAB"
Preserve AttributeData
The following statement imports layers 1 and 3, but does not import layers 0 or 2:
Import "FLOORS.DXF"
Layer "1"
Into "FLOOR_1.TAB"
Preserve AttributeData
Layer "3"
Into "FLOOR_3.TAB"
Preserve AttributeData
Importing GML Files
MapInfo Professional supports importing OSGB (Ordnance Survey of Great Britain) GML files.
Cartographic Symbol, Topographic Point, Topographic Line, Topographic Area, and Boundary Line
are supported; Cartographic Text is not supported. Topographic Area can be distributed in two
forms; MapInfo Professional supports the non-topological form. If the files contains XLINKS, MapInfo
Professional only imports attribute data, and does not import spatial objects. These XLINKs are
stored in the GML file as “xlink:href=”. If topological objects are included in the file, a warning
displays indicating that spatial objects cannot be imported. Access the Browser view to see the
display of attribute data.
Importing GML Files
file_name is the name of the GML 2.1 file to import.
338
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Type is “GML21” for GML 2.1 files.
layer_name is the name of the GML layer.
table_name is the MapInfo table name.
Overwrite causes the TAB file to be automatically overwritten. If Overwrite is not specified, an error
will result if the TAB file already exists.
The Coordsys clause is optional. If the GML file contains a supported projection and the Coordsys
clause is not specified, the projection from the GML file will be used. If the GML file contains a
supported projection and the Coordsys clause is specified, the projection from the Coordsys
clause will be used. If the GML file does not contain a supported projection, the Coordsys clause
must be specified.
Note: If the Coordsys clause does not match the projection of the GML file, your data may not
import correctly. The coordinate system must match the coordinate system of the data in the
GML file. It will not transform the data from one projection to another.
Examples
Sample importing using GML style:
Import "D:\midata\GML\est.gml" Type "GML" layer "LandformArea" style auto
on Into "D:\midata\GML\est_LandformArea.TAB" Overwrite
Sample importing using GML21 style:
Import "D:\midata\GML\GML2.1\mi_usa.xml" Type "GML21" layer "USA" Into
"D:\midata\GML\GML2.1\mi_usa_USA.TAB" Overwrite CoordSys Earth Projection
1, 104
Sample importing using current MapInfo style:
Import "D:\midata\GML\test.gml" Type "GML" layer "TopographicLine" style
auto off Into "D:\midata\GML\test_TopographicLine.TAB" Overwrite
The following example imports a MIF (MapInfo Interchange Format) file:
Import "WORLD.MIF"
Type "MIF"
Into "world_2.tab"
Map From world_2
See Also
Export statement
Reference Guide
339
Include statement
Include statement
Purpose
Incorporates the contents of a separate text file as part of a MapBasic program.
Syntax
Include "filename"
filename is the name of an existing text file.
Restrictions
You cannot issue an Include statement through the MapBasic window.
Description
When MapBasic is compiling a program file and encounters an Include statement, the entire
contents of the included file are inserted into the program file. The file specified by an Include
statement should be a text file, containing only legitimate MapBasic statements.
If the filename parameter does not specify a directory path, and if the specified file does not exist in
the current directory, the MapBasic compiler looks for the file in the program directory. This
arrangement allows you to leave standard definitions files, such as MAPBASIC.DEF, in one
directory, rather than copying the definitions files to the directories where you keep your program
files.
The most common use of the Include statement is to include the file of standard MapBasic
definitions, MAPBASIC.DEF. This file, which is provided with MapBasic, defines a number of
important identifiers, such as TRUE and FALSE.
Whenever you change the contents of a file that you use through an Include statement, you should
then recompile any MapBasic programs which Include that file.
Example
Include "MAPBASIC.DEF"
Input # statement
Purpose
Reads data from a file, and stores the data in variables.
Syntax
Input # filenum, var_name [ , var_name... ]
filenum is the number of a file opened through the Open File statement.
var_name is the name of a variable.
340
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Input # statement reads data from a file which was opened in a sequential mode (for example,
INPUT mode), and stores the data in one or more MapBasic variables.
The Input # statement reads data (up to the next end-of-line) into the variable(s) indicated by the
var_name parameter(s). MapInfo Professional treats commas and end-of-line characters as field
delimiters. To read an entire line of text into a single string variable, use Line Input statement.
MapBasic automatically converts the data to the type of the variable(s). When reading data into a
string variable, the Input # statement treats a blank line as an empty string. When reading data into
a numeric variable, the Input # statement treats a blank line as a zero value.
After issuing an Input # statement, call the EOF( ) function to determine if MapInfo Professional
was able to read the data. If the input was successful, the EOF( ) function returns FALSE; if the
end-of-file was reached before the input was completed, the EOF( ) function returns TRUE.
For an example of the Input # statement, see the sample program NVIEWS (Named Views).
The following data types are not available with the Input # statement:
•
•
•
•
•
•
Alias
Pen
Brush
Font
Symbol
Object
See Also
EOF( ) function, Line Input statement, Open File statement, Write # statement
Insert statement
Purpose
Appends new rows to an open table.
Syntax
Insert Into table
[ ( columnlist ) ]
{ Values ( exprlist ) | Select columnlist From table }
table is the name of an open table.
columnlist is a list of column expressions, comma-separated.
exprlist is a list of one or more expressions, comma-separated.
Reference Guide
341
Insert statement
Description
The Insert statement inserts new rows into an open table. There are two main forms of this
statement, allowing you to either add one row at a time, or insert groups of rows from another table
(via the Select clause). In either case, the number of column values inserted must match the
number of columns in the column list. If no column list is specified, all fields are assumed. Note that
you must use a Commit Table statement if you want to permanently save newly-inserted records to
disk.
If you know exactly how many columns are in the table you are modifying, and if you have values to
store in each of those columns, then you do not need to specify the optional columnlist clause.
In the following example, we know that the table has four columns (Name, Address, City, and State),
and we provide MapBasic with a value for each of those columns.
Insert Into customers
Values ("Mary Ryan", "23 Main St", "Dallas", "TX")
The preceding statement would generate an error at run-time if it turned out that the table had fewer
than (or more than) four columns. In cases where you do not know exactly how many columns are in
a table or the exact order in which the columns appear, you should use the optional columnlist
clause.
Examples
The following example inserts a new row into the customer table, while providing only one column
value for the new row; thus, all other columns in the new row will initially be blank. Here, the one
value specified by the Values clause will be stored in the “Name” column, regardless of how many
columns are in the table, and regardless of the position of the “Name” column in the table structure.
Insert Into customers (Name)
Values ("Steve Harris")
The following statement creates a point object and inserts the object into a new row of the Sites
table. Note that Obj is a special column name representing the table's graphical objects.
Insert Into sites (Obj)
Values ( CreatePoint(-73.5, 42.8) )
The following example illustrates how the Insert statement can append records from one table to
another. In this example, we assume that the table NY_ZIPS contains ZIP Code boundaries for New
York state, and NJ_ZIPS contains ZIP Code boundaries for New Jersey. We want to put all ZIP Code
boundaries into a single table, for convenience's sake (since operations such as Find can only work
with one table at a time).
Accordingly, the Insert statement below appends all of the records from the New Jersey table into
the New York table.
Insert Into NY_ZIPS
Select * From NJ_ZIPS
342
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
In the following example, we select the graphical objects from the table World, then insert each
object as a new record in the table Outline.
Open Table "world"
Open Table "outline"
Insert Into outline (Obj)
Select Obj From World
See Also
Commit Table statement, Delete statement, Rollback statement
InStr( ) function
Purpose
Returns a character position, indicating where a substring first appears within another string.
Syntax
InStr( position, string, substring )
position is a positive integer, indicating the start position of the search.
string is a string expression.
substring is a string expression which we will try to locate in string.
Return Value
Integer
Description
The InStr( ) function tests whether the string expression string contains the string expression
substring. MapBasic searches the string expression, starting at the position indicated by the position
parameter; thus, if the position parameter has a value of one, MapBasic will search from the very
beginning of the string parameter.
If string does not contain substring, the InStr( ) function returns a value of zero.
If string does contain substring, the InStr( ) function returns the character position where the
substring appears. For example, if the substring appears at the very start of the string, InStr( ) will
return a value of one.
If the substring parameter is a null string, the InStr( ) function returns zero.
The InStr( ) function is case-sensitive. In other words, the InStr( ) function cannot locate the
substring “BC” within the larger string “abcde”, because “BC” is upper-case.
Error Conditions
ERR_FCN_ARG_RANGE error generated if an argument is outside of the valid range
Reference Guide
343
Int( ) function
Example
Dim fullname As String, pos As Integer
fullname = "New York City"
pos = InStr(1, fullname, "York")
' pos will now contain a value of 5 (five)
pos = InStr(1, fullname, "YORK")
' pos will now contain a value of 0;
' YORK is uppercase, so InStr will not locate it
' within the string "New York City"
See Also
Mid$( ) function
Int( ) function
Purpose
Returns an integer value obtained by removing the fractional part of a decimal value.
Syntax
Int( num_expr )
num_expr is a numeric expression.
Return Value
Integer
Description
The Int( ) function returns the nearest integer value that is less than or equal to the specified
num_expr expression. The Fix( ) function is similar to, but not identical to, the Int( ) function. The
two functions differ in the way that they treat negative fractional values. When passed a negative
fractional number, Fix( ) function will return the nearest integer value greater than or equal to the
original value; so, the function call Fix(-2.3) will return a value of -2. But when the Int( ) function
is passed a negative fractional number, it returns the nearest integer value that is less than or equal
to the original value. So, the function call Int(-2.3) returns a value of -3.
Example
Dim whole As Integer
whole = Int(5.999)
' whole now has the value 5
whole = Int(-7.2)
' whole now has the value -8
344
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Fix( ) function, Round( ) function
IntersectNodes( ) function
Purpose
Calculates the set of points at which two objects intersect, and returns a polyline object that contains
each of the points of intersection.
Syntax
IntersectNodes( object1, object2, points_to_include )
object1 and object2 are object expressions; may not be point or text objects.
points_to_include is one of the following SmallInt values:
•
•
•
INCL_CROSSINGS returns points where segments cross.
INCL_COMMON returns end-points of segments that overlap.
INCL_ALL returns points where segments cross and points where segments overlap.
Return Value
A polyline object that contains the specified points of intersection.
Description
The IntersectNodes( ) function returns a polyline object that contains all nodes at which two objects
intersect.
IsogramInfo( ) function
Purpose
Returns any and all attributes that were set on a connection using the Set Connection Isogram
statement. Includes attributes to handle the maximum number of records for server, time, and
distance values.
Syntax
IsogramInfo( connection_handle, attribute )
connection_handle is an integer signifying the number of the connection returned from the Open
Connection statement.
attribute is an Integer code, indicating which type of information should be returned.
Return Value
Float, Logical, or String, depending on the attribute parameter.
Reference Guide
345
IsogramInfo( ) function
Description
This function returns the properties defaulted by the connection or the properties that have been
changed using the Set Connection Isogram statement.
There are several attributes that IsogramInfo( ) can return. Codes are defined in MAPBASIC.DEF.
attribute setting
346
IsogramInfo( ) Return Value
ISOGRAM_BANDING
Logical representing the Banding option
ISOGRAM_MAJOR_ROADS_ONLY
Logical representing the MajorRoadsOnly
option
ISOGRAM_RETURN_HOLES
Logical representing the choice of returning
regions with holes or not.
ISOGRAM_MAJOR_POLYGON_ONLY
Logical representing the choice of returning only
the main polygon of a region.
ISOGRAM_MAX_OFF_ROAD_DISTANCE
Float value representing the Maximum off Road
Distance value
ISOGRAM_MAX_OFF_ROAD_DISTANCE_UN
ITS
The unit string associated with the value
ISOGRAM_SIMPLIFICATION_FACTOR
Float value representing the Simplification
Factor. (a percent value represented as a value
between 0 and 1
ISOGRAM_DEFAULT_AMBIENT_SPEED
Float value representing the default ambient
speed.
ISOGRAM_DEFAULT_AMBIENT_SPEED_DIS
TANCE_UNIT
String value representing the distance unit (“mi”,
“km”).
ISOGRAM_DEFAULT_AMBIENT_SPEED_TIM
E_UNIT
String value representing the time unit (“hr”,
“min”, “sec”).
ISOGRAM_DEFAULT_PROPAGATION_FACT
OR
Determines the off-road network percentage of
the remaining cost (distance) for which off
network travel is allowed when finding the
Distance boundary. Roads not identified in the
network can be driveways or access roads,
among others. The propagation factor is a
percentage of the cost used to calculate the
distance between the starting point and the
Distance. The default value for this property is
0.16.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute setting
IsogramInfo( ) Return Value
ISOGRAM_BATCH_SIZE
Integer value representing the maximum
number of records that are sent to the service at
one time.
ISOGRAM_POINTS_ONLY
Logical representing the whether or not records
that contain non-point objects should be
skipped.
ISOGRAM_RECORDS_INSERTED
Integer value representing the number of
records inserted in the last command.
ISOGRAM_RECORDS_NOTINSERTED
Integer value representing the number of
records NOT inserted in the last command.
ISOGRAM_MAX_BATCH_SIZE
Integer value representing the maximum
number of records (i.e., points) that the server
will permit to be sent to the service at one time.
ISOGRAM_MAX_BANDS
Integer value representing the maximum
number of Iso bands (i.e., distances or times)
allowed.
ISOGRAM_MAX_DISTANCE
Float value representing the maximum distance
permitted for an Isodistance request. The
distance units are specified by
ISOGRAM_MAX_DISTANCE_UNITS.
ISOGRAM_MAX_DISTANCE_UNITS
String value representing the units for
ISOGRAM_MAX_DISTANCE.
ISOGRAM_MAX_TIME
Float value representing the maximum time
permitted for an Isochrone request. The time
units are specified by
ISOGRAM_MAX_TIME_UNITS.
ISOGRAM_MAX_TIME_UNITS
String value representing the units for
ISOGRAM_MAX_TIME.
Reference Guide
347
IsPenWidthPixels( ) function
Example
The following MapBasic snippet will print the Envinsa Routing Constraints to the message window in
MapInfo Professional:
Include "MapBasic.Def"
declare sub main
sub main
dim iConnect as integer
Open Connection Service Isogram
URL "http://envinsa_server:8062/Route/services/Route"
User "john"
Password "green"
into variable iConnect
Print "Isogram_Max_Batch_Size: " +
IsogramInfo(iConnect,Isogram_Max_Batch_Size)
Print "Isogram_Max_Bands: " + IsogramInfo(iConnect, Isogram_Max_Bands)
Print "Isogram_Max_Distance: " + IsogramInfo(iConnect,
Isogram_Max_Distance)
Print "Isogram_Max_Distance_Units: " + IsogramInfo(iConnect,
Isogram_Max_Distance_Units)
Print "Isogram_Max_Time: " + IsogramInfo(iConnect,Isogram_Max_Time)
Print "Isogram_Max_Time_Units: " +
IsogramInfo(iConnect,Isogram_Max_Time_Units)
Close Connection iConnect
end sub
See Also
Create Object statement, Open Connection statement, Set Connection Isogram statement
IsPenWidthPixels( ) function
Purpose
The IsPenWidthPixels function determines if a pen width is in pixels or in points.
Syntax
IsPenWidthPixels( penwidth )
penwidth is a small integer representing the pen width.
Return Value
True if the width value is in pixels. False if the width value is in points.
Description
The IsPenWidthPixels( ) function will return TRUE if the given pen width is in pixels. The pen width
for a line may be determined using the StyleAttr( ) function.
348
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Include "MAPBASIC.DEF"
Dim CurPen As Pen
Dim Width As Integer
Dim PointSize As Float
CurPen = CurrentPen( )
Width = StyleAttr(CurPen, PEN_WIDTH)
If Not IsPenWidthPixels(Width) Then
PointSize = PenWidthToPoints(Width)
End If
See Also
CurrentPen( ) function, MakePen( ) function, Pen clause, PenWidthToPoints( ) function,
StyleAttr( ) function
Kill statement
Purpose
Deletes a file.
Syntax
Kill filespec
filespec is a string which specifies a filename (and, optionally, the file's path).
Return Value
String
Description
The Kill statement deletes a file from the disk. There is no “undo” operation for a Kill statement.
Therefore, the Kill statement should be used with caution.
Example
Kill "C:\TEMP\JUNK.TXT"
See Also
Open File statement
Reference Guide
349
LabelFindByID( ) function
LabelFindByID( ) function
Purpose
Initializes an internal label pointer, so that you can query the label for a specific row in a map layer.
Syntax
LabelFindByID( map_window_id, layer_number, row_id, table, b_mapper )
map_window_id is an integer window id, identifying a Map window.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer).
row_id is a positive integer value, indicating the row number of the row whose label you wish to
query.
table is a table name or an empty string (""): when you query a table that belongs to a seamless
table, specify the name of the member table; otherwise, specify an empty string.
b_mapper is a logical value. Specify TRUE to query the labels that appear when the Map is active;
specify FALSE to query the labels that appear when the map is inside a Layout.
Return Value
Logical value: TRUE means that a label exists for the specified row.
Description
Call LabelFindByID( ) when you want to query the label for a specific row in a map layer. If the
return value is TRUE, then a label exists for the row, and you can query the label by calling the
LabelInfo( ) function.
350
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example maps the World table, displays automatic labels, and then determines
whether a label was drawn for a specific row in the table.
Include "mapbasic.def"
Dim b_morelabels As Logical
Dim i_mapid As Integer
Dim obj_mytext As Object
Open Table "World" Interactive As World
Map From World
i_mapid = FrontWindow( )
Set Map Window i_mapid Layer 1 Label Auto On
' Make sure all labels draw before we continue...
Update Window i_mapid
' Now see if row # 1 was auto-labeled
b_morelabels = LabelFindByID(i_mapid, 1, 1, "", TRUE)
If b_morelabels Then
' The object was labeled; now query its label.
obj_mytext = LabelInfo(i_mapid, 1, LABEL_INFO_OBJECT)
' At this point, you could save the obj_mytext object
' in a permanent table; or you could query it by
' calling ObjectInfo( ) or ObjectGeography( ).
End If
See Also
LabelFindFirst( ) function, LabelFindNext( ) function, LabelInfo( ) function
LabelFindFirst( ) function
Purpose
Initializes an internal label pointer, so that you can query the first label in a map layer.
Syntax
LabelFindFirst( map_window_id, layer_number, b_mapper )
map_window_id is an integer window id, identifying a Map window.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer).
b_mapper is a logical value. Specify TRUE to query the labels that appear when the Map is active;
specify FALSE to query the labels that appear when the map is inside a Layout.
Return Value
Logical value: TRUE means that labels exist for the specified layer (either labels are currently
visible, or the user has edited labels, and those edited labels are not currently visible).
Reference Guide
351
LabelFindNext( ) function
Description
Call LabelFindFirst( ) when you want to loop through a map layer's labels to query the labels.
Querying labels is a two-step process:
1. Set MapBasic's internal label pointer by calling the LabelFindFirst( ) function, the
LabelFindNext( ) function, or the LabelFindByID( ) function.
2. If the function you called in step 1 did not return FALSE, you can query the current label by
calling the LabelInfo( ) function.
To continue querying additional labels, return to step 1.
Example
For an example, see LabelInfo( ) function on page 353.
See Also
LabelFindByID( ) function, LabelFindNext( ) function, LabelInfo( ) function
LabelFindNext( ) function
Purpose
Advances the internal label pointer, so that you can query the next label in a map layer.
Syntax
LabelFindNext( map_window_id, layer_number )
map_window_id is an integer window id, identifying a Map window.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer).
Return Value
Logical value: TRUE means the label pointer was advanced to the next label; FALSE means there
are no more labels for this layer.
Description
After you call the LabelFindFirst( ) function to begin querying labels, you can call
LabelFindNext( ) to advance to the next label in the same layer.
Example
For an example, see LabelInfo( ) function on page 353.
See Also
LabelFindByID( ) function, LabelFindFirst( ) function, LabelInfo( ) function
352
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
LabelInfo( ) function
Purpose
Returns information about a label in a map. LabeIInfo can return a label as text object and the
text object returned can be curved or can be returned as rotated straight text. However, if
the label is curved, it will be returned as rotated flat text.
Syntax
Labelinfo( map_window_id, layer_number, attribute )
map_window_id is an integer window id, identifying a Map window.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer).
attribute is a code indicating the type of information to return; see table below.
Return Value
Return value depends on attribute.
Description
The Labelinfo( ) function returns information about a label in a Map window.
Note: Labels are different than text objects. To query a text object, call functions such as
ObjectInfo( ) function or ObjectGeography( ) function.
Before calling Labelinfo( ), you must initialize MapBasic's internal label pointer by calling the
LabelFindFirst( ) function, the LabelFindNext( ) function, or the LabelFindByID( ) function. See
the example below.
The attribute parameter must be one of the codes from the following table; codes are defined in
MAPBASIC.DEF.
attribute code
Labelinfo( ) Return Value
LABEL_INFO_ANCHORX
Float value, indicating the x-coordinate of the label's
anchor location.
LABEL_INFO_ANCHORY
Float value, indicating the y-coordinate of the label's
anchor location.
LABEL_INFO_DRAWN
Logical value; TRUE if label is currently visible.
LABEL_INFO_EDIT
Logical value; TRUE if label has been edited.
LABEL_INFO_EDIT_ANCHOR
Logical value; TRUE if label has been moved.
LABEL_INFO_EDIT_ANGLE
Logical value; TRUE if label's rotation angle has been
modified.
Reference Guide
353
LabelInfo( ) function
attribute code
Labelinfo( ) Return Value
LABEL_INFO_EDIT_FONT
Logical value; TRUE if label's font has been modified.
LABEL_INFO_EDIT_OFFSET
Logical value; TRUE if label's offset has been modified.
LABEL_INFO_EDIT_PEN
Logical value; TRUE if callout line's Pen style has been
modified.
LABEL_INFO_EDIT_POSITION
Logical value; TRUE if label's position (relative to anchor)
has been modified.
LABEL_INFO_EDIT_TEXT
Logical value; TRUE if label's text has been modified.
LABEL_INFO_EDIT_TEXTARROW
Logical value; TRUE if label's text arrow setting has been
modified.
LABEL_INFO_EDIT_TEXTLINE
Logical value; TRUE if callout line has been moved.
LABEL_INFO_EDIT_VISIBILITY
Logical value; TRUE if label visibility has been set to OFF.
LABEL_INFO_OBJECT
Text object is returned, which is an approximation of the
label. This feature allows you to convert a label into a text
object, which you can save in a permanent table.
Note: LABEL_INFO_OBJECT returns a text object,
but if the label is curved, it will return a label
with a Parallel orientation. MapBasic does not
support curved labels as text objects.
LABEL_INFO_OFFSET
Integer value between 0 and 200, indicating the distance
(in points) the label is offset from its anchor location.
LABEL_INFO_ORIENTATION
Returns Smallint value indicating the 'current' label's
orientation. The current label is initialized by using one of
the following Label functions: LabelFindFirst,
LabelFindByID, or LabelFindNext. The Return value will be
one of these:
•
•
•
354
LAYER_INFO_LABEL_ORIENT_HORIZONTAL (label
has angle equal to 0)
LAYER_INFO_LABEL_ORIENT_PARALLEL (label has
non-zero angle)
LAYER_INFO_LABEL_ORIENT_CURVED (label is
curved)
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute code
LABEL_INFO_POSITION
Labelinfo( ) Return Value
Integer value between 0 and 8, indicating the label's
position relative to its anchor location. The return value will
match one of these codes:
•
•
•
•
•
•
•
•
•
LAYER_INFO_LBL_POS_CC (0),
LAYER_INFO_LBL_POS_TL (1),
LAYER_INFO_LBL_POS_TC (2),
LAYER_INFO_LBL_POS_TR (3),
LAYER_INFO_LBL_POS_CL (4),
LAYER_INFO_LBL_POS_CR (5),
LAYER_INFO_LBL_POS_BL (6),
LAYER_INFO_LBL_POS_BC (7),
LAYER_INFO_LBL_POS_BR (8).
For example, if the label is Below and to the Right of the
anchor, its position is 8; if the label is Centered horizontally
and vertically over its anchor, its position is zero.
LABEL_INFO_ROWID
Integer value, representing the ID number of the row that
owns this label; returns zero if no label exists.
LABEL_INFO_SELECT
Logical value; TRUE if label is selected.
LABEL_INFO_TABLE
String value, representing the name of the table that owns
this label. Useful if you are using seamless tables and you
need to know which member table owns the label.
Example
The following example shows how to loop through all of the labels for a row, using the Labelinfo( )
function to query each label.
Dim b_morelabels As Logical
Dim i_mapid, i_layernum As Integer
Dim obj_mytext As Object
' Here, you would assign a Map window's ID to i_mapid,
' and assign a layer number to i_layernum.
b_morelabels = LabelFindFirst(i_mapid, i_layernum, TRUE)
Do While b_morelabels
obj_mytext = LabelInfo(i_mapid, i_layernum, LABEL_INFO_OBJECT)
' At this point, you could save the obj_mytext object
' in a permanent table; or you could query it by
' calling ObjectInfo( ) or ObjectGeography( ).
b_morelabels = LabelFindNext(i_mapid, i_layernum)
Loop
See Also
LabelFindByID( ) function, LabelFindFirst( ) function, LabelFindNext( ) function
Reference Guide
355
LayerInfo( ) function
LayerInfo( ) function
Purpose
Returns information about a layer in a Map window.
Syntax
LayerInfo( map_window_id, layer_number, attribute )
map_window_id is a Map window identifier.
layer_number is the number of a layer in the current Map window (for example, 1 for the top layer);
to determine the number of layers in a Map window, call the MapperInfo( ) function.
attribute is a code indicating the type of information to return; see table below.
New attribute value LAYER_INFO_HOTLINK_COUNT will allow you to query the number of hotlink
definitions in a layer.
For backwards compatibility, the original set of attributes will still work, and will return the values for
the layer's first hotlink definition. If no hotlinks are defined when the function is called, then the
following values are returned:
•
•
•
LAYER_INFO_HOTLINK_EXPR - empty string ("")
LAYER_INFO_HOTLINK_MODE - returns default value HOTLINK_MODE_LABEL
LAYER_INFO_HOTLINK_RELATIVE - returns default value FALSE
LAYER_INFO_LABEL_ORIENTATION - Returns Smallint value indicating the setting for the layer's
auto label orientation. Return value will be one of these values:
LAYER_INFO_LABEL_ORIENT_HORIZONTAL (labels have angle equal to 0)
LAYER_INFO_LABEL_ORIENT_PARALLEL
(labels have non-zero angle)
LAYER_INFO_LABEL_ORIENT_CURVED
(labels are curved)
Note: If LAYER_INFO_LABEL_ORIENT_PARALLEL is returned, then
LAYER_INFO_LABEL_PARALLEL will return TRUE.
Return Value
Return value depends on attribute parameter.
Restrictions
Many of the settings that you can query using LayerInfo( ) function only apply to conventional map
layers (as opposed to Cosmetic map layers, thematic map layers, and map layers representing
raster image tables). See example below.
356
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The LayerInfo( ) function returns information about one layer in an existing Map window. The
layer_number must be a valid layer (0 is the cosmetic layer, 1 is the topmost table layer, and so on).
The attribute parameter must be one of the codes from the following table; codes are defined in
MAPBASIC.DEF. From here you can also query the Hotlink options using the LAYER_HOTLINK_*
attributes.
attribute code
LayerInfo( ) Return Value
LAYER_INFO_NAME
String indicating the name of the table associated with this
map layer. If the specified layer is the map's Cosmetic
layer, the string will be a table name such as “Cosmetic1”;
this table name can be used with other statements (for
example, Select statement).
LAYER_INFO_EDITABLE
Logical value; TRUE if the layer is editable.
LAYER_INFO_LBL_PARTIALSEGS
Logical value; TRUE if the Label Partial Objects check
box is selected for this layer.
LAYER_INFO_SELECTABLE
Logical value; TRUE if the layer is selectable.
LAYER_INFO_PATH
String value representing the full directory path of the table
associated with the map layer.
LAYER_INFO_ZOOM_LAYERED
Logical; TRUE if zoom-layering is enabled.
LAYER_INFO_ZOOM_MIN
Float value, indicating the minimum zoom value (in
MapBasic's current distance units) at which the layer
displays. (To set MapBasic's distance units, use Set
Distance Units statement.)
LAYER_INFO_ZOOM_MAX
Float value, indicating the maximum zoom value at which
the layer displays.
LAYER_INFO_COSMETIC
Logical; TRUE if this is the Cosmetic layer.
LAYER_INFO_DISPLAY
SmallInt indicating how and whether this layer is
displayed; return value will be one of these values:
•
•
•
•
Reference Guide
LAYER_INFO_DISPLAY_OFF (the layer is not
displayed).
LAYER_INFO_DISPLAY_GRAPHIC (objects in this
layer appear in their “default” style—the style saved in
the table).
LAYER_INFO_DISPLAY_GLOBAL (objects in this
layer are displayed with a “style override” specified in
Layer Control).
LAYER_INFO_DISPLAY_VALUE (objects in this layer
appear as thematic shading).
357
LayerInfo( ) function
attribute code
LAYER_INFO_LABEL_
ORIENTATION *
LayerInfo( ) Return Value
Returns Smallint value indicating the setting for the layer's
auto label orientation. Return value will be one of these
values:
•
•
•
LAYER_INFO_LABEL_ORIENT_HORIZONTAL
(labels have angle equal to 0)
LAYER_INFO_LABEL_ORIENT_PARALLEL (labels
have non-zero angle)
LAYER_INFO_LABEL_ORIENT_CURVED (labels are
curved)
Note: If LAYER_INFO_LABEL_ORIENT_PARALLEL is
returned then LAYER_INFO_LABEL_PARALLEL
returns TRUE.
LAYER_INFO_OVR_LINE
Pen style used for displaying linear objects.
LAYER_INFO_OVR_PEN
Pen style used for displaying the borders of filled objects.
LAYER_INFO_OVR_BRUSH
Brush style used for displaying filled objects.
LAYER_INFO_OVR_SYMBOL
Symbol style used for displaying point objects.
LAYER_INFO_OVR_FONT
Font style used for displaying text objects.
LAYER_INFO_LBL_CURFONT
For applications compiled with MapBasic 3.x, this query
returns the following values:
Logical value: TRUE if layer is set to use the current font,
or FALSE if layer is set to use the custom font (see
LAYER_INFO_LBL_FONT).
For applications compiled with MapBasic 4.0 or later, this
query always returns FALSE.
LAYER_INFO_LBL_FONT
Font style used in labels.
LAYER_INFO_LBL_EXPR
String value: the expression used in labels.
LAYER_INFO_LBL_LT
SmallInt value indicating what type of line, if any, connects
a label to its original location after you move the label. The
return value will match one of these values:
•
•
•
LAYER_INFO_LBL_PARALLEL
358
LAYER_INFO_LBL_LT_NONE (no line)
LAYER_INFO_LBL_LT_SIMPLE (simple line)
LAYER_INFO_LBL_LT_ARROW (line with an
arrowhead)
Logical value: TRUE if layer is set for parallel labels.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute code
LAYER_INFO_LBL_POS
LayerInfo( ) Return Value
SmallInt value, indicating label position. Return value will
match one of these values (T=Top, B=Bottom, C=Center,
R=Right, L=Left):
•
•
•
•
•
•
•
•
•
LAYER_INFO_LBL_VISIBILITY
LAYER_INFO_LBL_POS_TL
LAYER_INFO_LBL_POS_TC
LAYER_INFO_LBL_POS_TR
LAYER_INFO_LBL_POS_CL
LAYER_INFO_LBL_POS_CC
LAYER_INFO_LBL_POS_CR
LAYER_INFO_LBL_POS_BL
LAYER_INFO_LBL_POS_BC
LAYER_INFO_LBL_POS_BR
SmallInt value, indicating whether labels are visible; see
the Visibility clause of the Set Map statement on
page 608. Return value will be one of these values:
•
•
•
LAYER_INFO_LBL_VIS_ON (labels always visible)
LAYER_INFO_LBL_VIS_OFF (labels never visible)
LAYER_INFO_LBL_VIS_ZOOM (labels visible when in
zoom range)
LAYER_INFO_LBL_ZOOM_MIN
Float value, indicating the minimum zoom distance for this
layer's labels.
LAYER_INFO_LBL_ZOOM_MAX
Float value, indicating the maximum zoom distance for this
layer's labels.
LAYER_INFO_LBL_AUTODISPLAY
Logical value: TRUE if this layer is set to display labels
automatically. See the Auto clause of the Set Map
statement on page 608.
LAYER_INFO_LBL_OVERLAP
Logical value; TRUE if overlapping labels are allowed.
LAYER_INFO_LBL_DUPLICATES
Logical value; TRUE if duplicate labels are allowed.
LAYER_INFO_LBL_OFFSET
SmallInt value from 0 to 50, indicating how far the labels
are offset from object centroids. The offset value
represents a distance, in points.
LAYER_INFO_LBL_MAX
Integer value, indicating the maximum number of labels
allowed for this layer. If no maximum has been set, return
value is 2,147,483,647.
LAYER_INFO_LBL_PARTIALSEGS
Logical value; TRUE if the Label Partial Segments check
box is checked for this layer.
Reference Guide
359
LayerInfo( ) function
attribute code
LayerInfo( ) Return Value
LAYER_INFO_ARROWS
Logical value; TRUE if layer displays direction arrows on
linear objects.
LAYER_INFO_NODES
Logical value; TRUE if layer displays object nodes.
LAYER_INFO_CENTROIDS
Logical value; TRUE if layer displays object centroids.
LAYER_INFO_SELECTABLE
Logical value; TRUE if the layer is selectable.
LAYER_INFO_PATH
String value representing the full directory path of the table
associated with the map layer.
LAYER_INFO_TYPE
SmallInt value, indicating this layer's file type:
•
•
•
•
•
•
LAYER_INFO_TYPE_NORMAL for a normal layer
LAYER_INFO_TYPE_COSMETIC for the Cosmetic
layer;
LAYER_INFO_TYPE_IMAGE for a raster image layer
LAYER_INFO_TYPE_THEMATIC for a thematic layer
LAYER_INFO_TYPE_GRID for a grid image layer
LAYER_INFO_TYPE_WMS for a layer from a Web
Service Map
LAYER_HOTLINK_EXPR
Returns the layer's Hotlink filename expression. Can
return empty string (““)
LAYER_INFO_HOTLINK_COUNT
Allows you to query the number of hotlink definitions in a
layer.
LAYER_HOTLINK_MODE
Returns the layer's Hotlink mode, one of the following
predefined values:
•
•
•
LAYER_HOTLINK_RELATIVE
HOTLINK_MODE_LABEL (default)
HOTLINK_MODE_OBJ
HOTLINK_MODE_BOTH
Returns TRUE if the relative path option is on, FALSE
otherwise. FALSE is default.
Note: *The values returned by LayerInfo() for LAYER_INFO_LABEL_ORIENTATION and
LabeInfo() for LABEL_INFO_ORIENTATION -- these defines correspond to the MapBasic
defines in MAPBASIC.DEF. If you alter these you must alter MAPBASIC.DEF.
#define LAYER_INFO_LABEL_ORIENT_HORIZONTAL 0
360
#define LAYER_INFO_LABEL_ORIENT_PARALLEL
1
#define LAYER_INFO_LABEL_ORIENT_CURVED
2
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Many of the settings that you can query using LayerInfo( ) only apply to conventional map layers (as
opposed to cosmetic map layers, thematic map layers, and map layers representing raster image
tables).
To determine whether a map layer is a conventional layer, use the LAYER_INFO_TYPE setting, as
shown below:
i_lay_type = LayerInfo( map_id, layer_number, LAYER_INFO_TYPE)
If i_lay_type = LAYER_INFO_TYPE_NORMAL Then
'
' ... then this is a "normal" layer
'
End If
See Also
MapperInfo( ) function, Set Map statement
Layout statement
Purpose
Opens a new layout window.
Syntax
Layout
[ Position ( x, y ) [ Units paperunits ] ]
[ Width window_width [ Units paperunits ] ]
[ Height window_height [ Units paperunits ] ]
[ { Min | Max } ]
paperunits is a string representing the name of a paper unit (for example, “in” or “mm”).
x, y specifies the position of the upper left corner of the Layout, in paper units, where 0,0 represents
the upper-left corner of the MapInfo Professional window.
window_width and window_height dictate the size of the window, in Paper units.
Description
The Layout statement opens a new Layout window. If the statement includes the optional Min
keyword, the window is minimized before it is displayed. If the statement includes the optional Max
keyword, the window appears maximized, filling all of MapInfo Professional 's screen space.
The Width and Height clauses control the size of the Layout window, not the size of the page layout
itself. The page layout size is controlled by the paper size currently in use and the number of pages
included in the Layout.
See Set Layout statement on page 603 for more information on setting the number of pages in a
Layout.
Reference Guide
361
LCase$( ) function
MapInfo Professional assigns a special hidden table name to each Layout window. The first Layout
window opened has the table name Layout1, the next Layout window that is opened has the table
name Layout2, etc.
A MapBasic program can create, select, or modify objects on a Layout window by issuing
statements which refer to these table names. For example, the following statement selects all
objects from a Layout window:
Select * From Layout1
Example
The following example creates a Layout window two inches wide by four inches high, located at the
upper-left corner of the MapInfo Professional workspace.
Layout Position (0, 0) Width 2 Height 4
See Also
Open Window statement, Set Layout statement
LCase$( ) function
Purpose
Returns a lower-case equivalent of a string.
Syntax
LCase$( string_expr )
string_expr is a string expression.
Return Value
String
Description
The LCase$( ) function returns the string which is the lower-case equivalent of the string expression
string_expr.
Conversion from upper- to lower-case only affects alphabetic characters (A through Z); numeric
digits, and punctuation marks are not affected. Thus, the function call:
LCase$( "A#12a" )
returns the string value “a#12a”.
362
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim regular, lower_case As String
regular = "Los Angeles"
lower_case = LCase$(regular)
'
' Now, lower_case contains the value "los angeles"
'
See Also
Proper$( ) function, UCase$( ) function
Left$( ) function
Purpose
Returns part or all of a string, beginning at the left end of the string.
Syntax
Left$( string_expr, num_expr )
string_expr is a string expression.
num_expr is a numeric expression, zero or larger.
Return Value
String
Description
The Left$( ) function returns a string which consists of the leftmost num_expr characters of the string
expression string_expr.
The num_expr parameter should be an integer value, zero or larger. If num_expr has a fractional
value, MapBasic rounds to the nearest integer. If num_expr is zero, Left$( ) returns a null string. If
the num_expr parameter is larger than the number of characters in the string_expr string, Left$( )
returns a copy of the entire string_expr string.
Example
Dim whole, partial As String
whole = "Afghanistan"
partial = Left$(whole, 6)
' at this point, partial contains the string: "Afghan"
See Also
Mid$( ) function, Right$( ) function
Reference Guide
363
LegendFrameInfo( ) function
LegendFrameInfo( ) function
Purpose
Returns information about a frame within a legend.
Syntax
LegendFrameInfo( window_id, frame_id, attribute )
window_id is a number that specifies which legend window you want to query.
frame_id is a number that specifies which frame within the legend window you want to query.
Frames are numbered 1 to n where n is the number of frames in the legend.
attribute is an integer code indicating which type of information to return.
Return Value
Depends on the attribute parameter.
Attribute codes
FRAME_INFO_TYPE
LegendFrameInfo( ) Return Value
Returns one of the following predefined constant indicating
frame type:
•
•
364
FRAME_TYPE_STYLE
FRAME_TYPE_THEME
FRAME_INFO_MAP_LAYER_ID
Returns the ID of the layer to which the frame corresponds.
FRAME_INFO_REFRESHABLE
Returns TRUE if the frame was created without the
Norefresh keyword. Always returns TRUE for theme
frames.
FRAME_INFO_POS_X
Returns the distance of the frame’s upper left corner from the
left edge of the legend canvas (in paper units).
FRAME_INFO_POS_Y
Returns the distance of the frame's upper left corner from the
top edge of the legend canvas (in paper units).
FRAME_INFO_WIDTH
Returns the width of the frame (in paper units).
FRAME_INFO_HEIGHT
Returns the height of the frame (in paper units).
FRAME_INFO_TITLE
Returns the title of a style frame or theme frame.
FRAME_INFO_TITLE_FONT
Returns the font of a style frame title. Returns the default title
font if the frame has no title or if it is a theme frame.
FRAME_INFO_SUBTITLE
Returns the subtitle of a style frame or theme frame.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Attribute codes
LegendFrameInfo( ) Return Value
FRAME_INFO_SUBTITLE_FONT
Same as FRAME_INFO_TITLE_FONT.
FRAME_INFO_BORDER_PEN
Returns the pen used to draw the border.
FRAME_INFO_NUM_STYLES
Returns the number of styles in a frame. Zero if theme
frame.
FRAME_INFO_VISIBLE
Returns TRUE if the frame is visible (theme frames can be
invisible).
FRAME_INFO_COLUMN
Returns the legend attribute column name as a string if there
is one. Returns an empty string for a theme frame.
FRAME_INFO_LABEL
Returns the label expression as a string if there is one.
Returns an empty string for a theme frame.
LegendInfo( ) function
Purpose
Returns information about a legend.
Syntax
LegendInfo( window_id, attribute )
window_id is a number that specifies which legend window you want to query.
attribute is an integer code indicating which type of information to return.
Return Value
Depends on the attribute parameter.
Attribute Code
LegendInfo( ) Return Value
LEGEND_INFO_MAP_ID
Returns the ID of the parent map window (can also
get this value by calling the WindowInfo( ) function
with the WIN_INFO_TABLE code).
LEGEND_INFO_ORIENTATION
Returns predefined value to indicate the layout of the
legend:
•
•
•
Reference Guide
ORIENTATION_PORTRAIT
ORIENTATION_LANDSCAPE
ORIENTATION_CUSTOM
365
LegendStyleInfo( ) function
Attribute Code
LegendInfo( ) Return Value
LEGEND_INFO_NUM_FRAMES
Returns the number of frames in the legend.
LEGEND_INFO_STYLE_SAMPLE_SIZE
Returns 0 for small legend sample size style or 1 for
large legend sample size style.
Example
LegendInfo(FrontWindow( ) LEGEND_INFO_STYLE_SAMPLE_SIZE)
See Also:
LegendStyleInfo( ) function
LegendStyleInfo( ) function
Purpose
Returns information about a style item within a legend frame.
Syntax
LegendStyleInfo( window_id, frame_id, style_id, attribute )
window_id is a number that specifies which legend window you want to query.
frame_id is a number that specifies which frame within the legend window you want to query.
Frames are numbered 1 to n where n is the number of frames in the legend.
style_id is a number that specifies which style within a frame you want to query. Styles are numbered
1 to n where n is the number of styles in the frame.
attribute is an integer code indicating which type of information to return.
Return Value
Attribute Code
LegendStyleInfo( ) Return Values
LEGEND_STYLE_INFO_TEXT
Returns the text of the style.
LEGEND_STYLE_INFO_FONT
Returns the font of the style.
LEGEND_STYLE_INFO_OBJ
Returns the object of the style.
Error Conditions
Generates an error when issued on a frame that has no styles (theme frame).
See Also
LegendInfo( ) function
366
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Len( ) function
Purpose
Returns the number of characters in a string or the number of bytes in a variable.
Syntax
Len( expr )
expr is a variable expression. expr cannot be a Pen, Brush, Symbol, Font, or Alias.
Return Value
SmallInt
Description
The behavior of the Len( ) function depends on the data type of the expr parameter.
If the expr expression represents a character string, the Len( ) function returns the number of
characters in the string.
Otherwise, if expr is a MapBasic variable, Len( ) returns the size of the variable, in bytes. Thus, if
you pass an integer variable, Len( ) will return the value 4 (because each integer variable occupies
4 bytes), while if you pass a SmallInt variable, Len( ) will return the value 2 (because each SmallInt
variable occupies 2 bytes).
Example
Dim name_length As SmallInt
name_length = Len("Boswell")
' name_length now has the value: 7
See Also
ObjectLen( ) function
Like( ) function
Purpose
Returns TRUE or FALSE to indicate whether a string satisfies pattern-matching criteria.
Syntax
Like( string, pattern_string, escape_char )
string is a string expression to test.
pattern_string is a string that contains regular characters or special wild-card characters.
Reference Guide
367
Line Input statement
escape_char is a string expression defining an escape character. Use an escape character (for
example, “\”) if you need to test for the presence of one of the wild-card characters (“%” and “_”) in
the string expression. If no escape character is desired, use an empty string ("").
Return Value
Logical value (TRUE if string matches pattern_string).
Description
The Like( ) function performs string pattern-matching. This string comparison is case-sensitive; to
perform a comparison that is case-insensitive, use the Like operator.
The pattern_string parameter can contain the following wildcard characters:
_ (underscore)
matches a single character.
% (percent)
matches zero or more characters.
To search for instances of the underscore or percent characters, specify an escape_char parameter,
as shown in the table below.
To determine if a string…
Specify these parameters:
starts with “South”
Like( string_var, "South%", "")
ends with “America”
Like( string_var, "%America", "")
contains “ing” at any point
Like( string_var, "%ing%", "" )
starts with an underscore
Like( string_var, "\_%", "\")
See Also
Len( ) function, StringCompare( ) function
Line Input statement
Purpose
Reads a line from a sequential text file into a variable.
Syntax
Line Input [#] filenum, var_name
filenum is an integer value, indicating the number of an open file.
var_name is the name of a string variable.
368
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Line Input statement reads an entire line from a text file, and stores the results in a string
variable. The text file must already be open, in Input mode.
The Line Input statement treats each line of the file as one long string. If each line of a file contains
a comma-separated list of expressions, and you want to read each expression into a separate
variable, use the Input # statement instead of Line Input.
Example
The following program opens an existing text file, reads the contents of the text file one line at a time,
and copies the contents of the file to a separate text file.
Dim str As String
Open File "original.txt" For Input As #1
Open File "copy.txt" For Output As #2
Do While Not EOF(1)
Line Input #1, str
If Not EOF(1) Then
Print #2, str
End If
Loop
Close File #1
Close File #2
See Also
Input # statement, Open File statement, Print # statement
LocateFile$( ) function
Purpose
Return the path to one of the MapInfo application data files.
Syntax
LocateFile$( file_id )
file_id is one of the following values
Value
Description
LOCATE_PREF_FILE
Preference file (mapinfow.prf).
LOCATE_DEF_WOR
Default workspace file (mapinfow.wor).
LOCATE_CLR_FILE
Color file (mapinfow.clr).
LOCATE_PEN_FILE
Pen file (mapinfow.pen).
Reference Guide
369
LocateFile$( ) function
Value
Description
LOCATE_FNT_FILE
Symbol file (mapinfow.fnt).
LOCATE_ABB_FILE
Abbreviation file (mapinfow.abb).
LOCATE_PRJ_FILE
Projection file (mapinfow.prj).
LOCATE_MNU_FILE
Menu file (mapinfow.mnu).
LOCATE_CUSTSYMB_DIR
Custom symbol directory (custsymb).
LOCATE_THMTMPLT_DIR
Theme template directory (thmtmpl).
LOCATE_GRAPH_DIR
Graph support directory (GraphSupport).
LOCATE_WMS_SERVERLIST
XML list of WMS servers (MIWMSServers.xml).
LOCATE_WFS_SERVERLIST
XML list of WFS servers (MIWFSServers.xml).
LOCATE_GEOCODE_SERVERLIST
XML list of geocode servers (MIGeocodeServers.xml).
LOCATE_ROUTING_SERVERLIST
XML list of routing servers (MIRoutingServers.xml).
Return Value
String
Description
Given the ID of a MapInfo application data file, this function returns the location where MapInfo
Professional found that file. In versions prior to 6.5, these files where, for the most part, installed into
the program directory (same directory as mapinfow.exe). As of 6.5, MapInfo Professional installs
these files under the user's Application Data directory, but there are several valid locations for these
files, including the program directory. MapBasic applications should not assume the location of these
files, instead LocateFile$( ) should be used to determine the actual location.
Example
include "mapbasic.def"
declare sub main
sub main
dim sGraphLocations as string
sGraphLocations = LocateFile$(LOCATE_GRAPH_DIR)
Print sGraphLocations
end sub
See Also
GetFolderPath$( ) function
370
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
LOF( ) function
Purpose
Returns the length of an open file.
Syntax
LOF( filenum )
filenum is the number of an open file.
Return Value
Integer
Description
The LOF( ) function returns the length of an open file, in bytes.
The file parameter represents the number of an open file; this is the same number specified in the
As clause of the Open File statement.
Error Conditions
ERR_FILEMGR_NOTOPEN error generated if the specified file is not open.
Example
Dim size As Integer
Open File "import.txt" For Binary As #1
size = LOF(1)
' size now contains the # of bytes in the file
See Also
Open File statement
Log( ) function
Purpose
Returns the natural logarithm of a number.
Syntax
Log( num_expr )
num_expr is a numeric expression.
Return Value
Float
Reference Guide
371
LTrim$( ) function
Description
The Log( ) function returns the natural logarithm of the numeric expression specified by the
num_expr parameter.
The natural logarithm represents the number to which the mathematical value e must be raised in
order to obtain num_expr. e has a value of approximately 2.7182818.
The logarithm is only defined for positive numbers; accordingly, the Log( ) function will generate an
error if num_expr has a negative value.
You can calculate logarithmic values in other bases (for example, base 10) using the natural
logarithm. To obtain the base-10 logarithm of the number n, divide the natural log of n ( Log( n ) ) by
the natural logarithm of 10 ( Log( 10 ) ).
Example
Dim original_val, log_val As Float
original_val = 2.7182818
log_val = Log(original_val)
' log_val will now have a value of 1 (approximately),
' since E raised to the power of 1 equals
' 2.7182818 (approximately)
See Also
Exp( ) function
LTrim$( ) function
Purpose
Trims space characters from the beginning of a string and returns the results.
Syntax
LTrim$( string_expr )
string_expr is a string expression.
Return Value
String
Description
The LTrim$( ) function removes any spaces from the beginning of the string_expr string, and returns
the resultant string.
372
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim name As String
name = " Mary Smith"
name = LTrim$(name)
' name now contains the string "Mary Smith"
See Also
RTrim$( ) function
Main procedure
Purpose
The first procedure called when an application is run.
Syntax
Declare Sub Main
Sub Main
statement_list
End Sub
statement_list is a list of statements to execute when an application is run.
Description
Main is a special-purpose MapBasic procedure name. If an application contains a sub procedure
called Main, MapInfo Professional runs that procedure automatically when the application is first
run. The Main procedure can then take actions (for example, issuing Call statements) to cause
other sub procedures to be executed.
However, you are not required to explicitly declare the Main procedure. Instead of declaring a
procedure named Main, you can simply place one or more statements at or near the top of your
program file, outside of any procedure declaration. MapBasic will then treat that group of statements
as if they were in a Main procedure. This is known as an “implicit” Main procedure (as opposed to
an “explicit” Main procedure).
Example
A MapBasic program can be as short as a single line. For example, you could create a MapBasic
program consisting only of the following statement:
Note "Testing, one two three."
If the statement above comprises your entire program, MapBasic considers that program to be in an
implicit Main procedure. When you run that application, MapBasic will execute the Note statement.
Reference Guide
373
MakeBrush( ) function
Alternately, the following example explicitly declares the Main procedure, producing the same
results (i.e., a Note statement).
Declare Sub Main
Sub Main
Note "Testing, one two three."
End Sub
The next example contains an implicit Main procedure, and a separate sub procedure called Talk.
The implicit Main procedure calls the Talk procedure through the Call statement.
Declare Sub Talk(ByVal msg As String)
Call Talk("Hello")
Call Talk("Goodbye")
Sub Talk(ByVal msg As String)
Note msg
End Sub
The next example contains an explicit Main procedure, and a separate sub procedure called Talk.
The Main procedure calls the Talk procedure through the Call statement.
Declare Sub Main
Declare Sub Talk(ByVal msg As String)
Sub Main
Call Talk("Hello")
Call Talk("Goodbye")
End Sub
Sub Talk(ByVal msg As String)
Note msg
End Sub
See Also
EndHandler procedure, RemoteMsgHandler procedure, SelChangedHandler procedure,
Sub…End Sub statement, ToolHandler procedure, WinClosedHandler procedure
MakeBrush( ) function
Purpose
Returns a Brush value.
Syntax
MakeBrush( pattern, forecolor, backcolor)
pattern is an integer value from 1 to 8 or from 12 to 71, dictating a fill pattern. See Brush clause on
page 109 for a listing of the patterns.
forecolor is the integer RGB color value of the foreground of the pattern. See RGB( ) function on
page 501 for details.
374
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
backcolor is the integer RGB color value of the background of the pattern. To make the background
transparent, specify -1 as the background color, and specify a pattern of 3 or greater.
Return Value
Brush
Description
The MakeBrush( ) function returns a Brush value. The return value can be assigned to a Brush
variable, or may be used as a parameter within a statement that takes a Brush setting as a
parameter (such as Create Ellipse, Set Map, Set Style, or Shade).
See Brush clause on page 109 for more information about Brush settings.
Example
Include "mapbasic.def"
Dim b_water As Brush
b_water = MakeBrush(64, CYAN, BLUE)
See Also
Brush clause, CurrentBrush( ) function, RGB( ) function, StyleAttr( ) function
MakeCustomSymbol( ) function
Purpose
Returns a Symbol value based on a bitmap file.
Syntax
MakeCustomSymbol( filename, color, size, customstyle )
filename is a string up to 31 characters long, representing the name of a bitmap file. The file must be
in the CustSymb directory inside the user's MapInfo directory.
color is an integer RGB color value; see RGB( ) function on page 501 for details.
size is an integer point size, from 1 to 48.
customstyle is an integer code controlling color and background attributes. See table below.
Return Value
Symbol
Description
The MakeCustomSymbol( ) function returns a Symbol value based on a bitmap file. See Symbol
clause on page 680 for information about other symbol types.
Reference Guide
375
MakeDateTime function
The following table describes how the customstyle argument controls the symbol's style:
customstyle value
Symbol Style
0
The Show Background, the Apply Color, and the Display at Actual Size
settings are off; the symbol appears in its default state at the point size
specified by the size parameter. White pixels in the bitmap are displayed as
transparent, allowing whatever is behind the symbol to show through.
1
The Show Background setting is on; white pixels in the bitmap are opaque.
2
The Apply Color setting is on; non-white pixels in the bitmap are replaced
with the symbol's color setting.
3
Both Show Background and Apply Color are on.
4
The Display at Actual Size setting is on; the bitmap image is rendered at its
native width and height in pixels.
5
The Show Background and Display at Actual Size settings are on.
7
The Show Background, the Apply Color, and the Display at Actual Size
settings are on.
Example
Include "mapbasic.def"
Dim sym_marker As Symbol
sym_marker = MakeCustomSymbol("CAR1-64.BMP", BLUE, 18, 0)
See Also
CurrentSymbol( ) function, MakeFontSymbol( ) function, MakeSymbol( ) function, StyleAttr( )
function, Symbol clause
MakeDateTime function
Purpose
Returns a DateTime made from the specified Date and Time.
Syntax
MakeDateTime (Date, Time)
Return Value
DateTime
376
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim tX as time
dim dX as date
dim dtX as datetime
tX = 105604123
dX = 20070908
dtX = MakeDateTime(dX,tX)
Print FormatDate$(GetDate(dtX))
Print FormatTime$(GetTime(dtX), "hh:mm:ss.fff tt")
MakeFont( ) function
Purpose
Returns a Font value.
Syntax
MakeFont( fontname, style, size, forecolor, backcolor )
fontname is a text string specifying a font (for example, “Helv”). This argument is case sensitive.
style is a positive integer expression; 0 = plain text, 1 = bold text, etc. See Font clause for details.
size is an integer point size, one or greater.
forecolor is the RGB color value for the text. See RGB( ) function on page 501.
backcolor is the RGB color value for the background (or the halo color, if the style setting specifies a
halo). To make the background transparent, specify -1 as the background color.
Return Value
Font
Description
The MakeFont( ) function returns a Font value. The return value can be assigned to a Font variable,
or may be used as a parameter within a statement that takes a Font setting as a parameter (such as
Create Text statement or Set Style statement).
See Font clause on page 299 for more information about Font settings.
Example
Include "mapbasic.def"
Dim big_title As Font
big_title = MakeFont("Helvetica", 1, 20,BLACK,WHITE)
See Also
CurrentFont( ) function, Font clause, StyleAttr( ) function
Reference Guide
377
MakeFontSymbol( ) function
MakeFontSymbol( ) function
Purpose
Returns a Symbol value, using a character from a TrueType font as the symbol.
Syntax
MakeFontSymbol( shape, color, size, fontname, fontstyle, rotation )
shape is a SmallInt value, 31 or larger (31 is invisible), specifying a character code from a TrueType
font.
color is an integer RGB color value; see RGB( ) function on page 501 for details.
size is a SmallInt value from 1 to 48, dictating the point size of the symbol.
fontname is a string representing the name of a TrueType font (for example, “WingDings”). This
argument is case sensitive.
fontstyle is a numeric code controlling bold, outline, and other attributes; see below.
rotation is a floating-point number indicating the symbol's rotation angle, in degrees.
Return Value
Symbol
Description
The MakeFontSymbol( ) function returns a Symbol value based on a character in a TrueType font.
See Symbol clause on page 680 for information about other symbol types.
The following table describes how the fontstyle parameter controls the symbol's style:
fontstyle value
Symbol Style
0
Plain
1
Bold
16
Border (black outline)
32
Drop Shadow
256
Halo (white outline)
To specify two or more style attributes, add the values from the left column. For example, to specify
both the Bold and the Drop Shadow attributes, use a fontstyle value of 33. Border and Halo are
mutually exclusive.
378
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Include "mapbasic.def"
Dim sym_marker As Symbol
sym_marker = MakeFontSymbol(65,RED,24,"WingDings",32,0)
See Also
CurrentSymbol( ) function, MakeCustomSymbol( ) function, MakeSymbol( ) function,
StyleAttr( ) function, Symbol clause
MakePen( ) function
Purpose
Returns a Pen value.
Syntax
MakePen( width, pattern, color)
width specifies a pen width.
pattern specifies a line pattern; see Pen clause for a listing.
color is the RGB color value; see RGB( ) function on page 501 for details.
Return Value
Pen
Description
The MakePen( ) function returns a Pen value, which defines a line style. The return value can be
assigned to a Pen variable, or may be used as a parameter within a statement that takes a Pen
setting as a parameter (such as Create Line statement, Create Pline statement, Set Style
statement, or Set Map statement).
See Pen clause on page 461 for more information about Pen settings.
Example
Include "mapbasic.def"
Dim p_bus_route As Pen
p_bus_route = MakePen(3, 9, RED)
See Also
CurrentPen( ) function, Pen clause, StyleAttr( ) function, RGB( ) function
Reference Guide
379
MakeSymbol( ) function
MakeSymbol( ) function
Purpose
Returns a Symbol value, using a character from the MapInfo 3.0 symbol set. The MapInfo 3.0
symbol set is the symbol set that was originally published with MapInfo for Windows 3.0 and has
been maintained in subsequent versions of MapInfo Professional.
Syntax
MakeSymbol( shape, color, size )
shape is a SmallInt value, 31 or larger (31 is invisible), specifying a symbol shape; standard symbol
set provides symbols 31 through 67; see Symbol clause on page 680 for a listing.
color is an integer RGB color value; see RGB( ) function on page 501 for details.
size is a SmallInt value from 1 to 48, dictating the point size of the symbol.
Return Value
Symbol
Description
The MakeSymbol( ) function returns a Symbol value. The return value can be assigned to a Symbol
variable, or may be used as a parameter within a statement that takes a Symbol clause as a
parameter (such as Create Point statement, Set Map statement, Set Style statement, or Shade
statement).
To create a symbol from a character in a TrueType font, call the MakeFontSymbol( ) function.
To create a symbol from a bitmap file, call the MakeCustomSymbol( ) function.
See Symbol clause on page 680 for more information about Symbol settings.
Example
Include "mapbasic.def"
Dim sym_marker As Symbol
sym_marker = MakeSymbol(44, RED, 16)
See Also
CurrentSymbol( ) function, MakeCustomSymbol( ) function, MakeFontSymbol( ) function,
StyleAttr( ) function, Symbol clause
380
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Map statement
Purpose
Opens a new Map window.
Syntax
Map From table [ , table ... ]
[ Position ( x, y ) [ Units paperunits ] ]
[ Width window_width [ Units paperunits ] ]
[ Height window_height [ Units paperunits ] ]
[ { Min | Max } ]
table is the name of an open table.
paperunits is the name of a paper unit (for example, “in”).
x, y specifies the position of the upper left corner of the Map window, in paper units.
window_width and window_height specify the size of the Map window, in paper units.
Description
The Map statement opens a new Map window. After you open a Map window, you can modify the
window by issuing Set Map statements.
The table name specified must already be open. The table must also be mappable; in other words,
the table must be able to have graphic objects associated with the records. The table does not need
to actually contain any graphical objects, but the structure of the table must specify that objects may
be attached.
The Map statement must specify at least one table, since any Map window must contain at least one
layer. Optionally, the Map statement can specify multiple table names (separated by commas) to
open a multi-layer Map window. The first table name in the Map statement will be drawn last
whenever the Map window is redrawn; thus, the first table in the Map statement will always appear
on top. Typically, tables with point objects appear earlier in Map statements, and tables with region
(boundary) objects appear later in Map statements.
The default size of the resultant Map window is roughly a quarter of the screen size; the default
position of the window depends on how many windows are currently on the screen. Optional
Position, Height, and Width clauses allow you to control the size and position of the new Map
window. The Height and Width clauses dictate the window size, in inches. Note that the Position
clause specifies a position relative to the upper left corner of the MapInfo application, not relative to
the upper left corner of the screen.
If the Map statement includes the optional Max keyword, the new Map window is maximized, taking
up all of the screen space available to MapInfo Professional. Conversely, if the Map statement
includes the Min keyword, the window is minimized immediately.
Reference Guide
381
Map3DInfo( ) function
Each Map window can have its own projection. MapInfo Professional decides a Map window's initial
projection based on the native projection of the first table mapped. A user can change a map's
projection by choosing the Map > Options command. A MapBasic program can change the
projection by issuing a Set Map statement.
Example
The following example opens a Map window three inches wide by two inches high, inset one inch
from the upper left corner of the MapInfo application. The map has two layers.
Open Table "world"
Open Table "cust1994" As customers
Map from customers, world
Position (1,1) Width 3 Height 2
See Also
Add Map statement, Remove Map statement, Set Map statement, Set Shade statement, Shade
statement
Map3DInfo( ) function
Purpose
Returns properties of a 3DMap window.
Syntax
Map3DInfo( window_id, attribute )
window_id is an integer window identifier.
attribute is an integer code, indicating which type of information should be returned.
Return Value
Float, logical, or string, depending on the attribute parameter.
Description
The Map3DInfo( ) function returns information about a 3DMap window.
The window_id parameter specifies which 3DMap window to query. To obtain a window identifier,
call the FrontWindow( ) function immediately after opening a window, or call the WindowID( )
function at any time after the window's creation.
There are several numeric attributes that Map3DInfo( ) can return about any given 3DMap window.
The attribute parameter tells the Map3DInfo( ) function which Map window statistic to return. The
attribute parameter should be one of the codes from the following table; codes are defined in
MAPBASIC.DEF.
382
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Attribute
Return Value
MAP3D_INFO_SCALE
Float result representing the 3DMaps scale factor.
MAP3D_INFO_RESOLUTION_X
Integer result representing the X resolution of the
grid(s) in the 3DMap window.
MAP3D_INFO_RESOLUTION_Y
Integer result representing the Y resolution of the
grid(s) in the 3DMap window.
MAP3D_INFO_BACKGROUND
Integer result representing the background color, see
the RGB function.
MAP3D_INFO_UNITS
String representing the map's abbreviated area unit
name, for example, “mi” for miles.
MAP3D_INFO_LIGHT_X
Float result representing the x-coordinate of the Light in
the scene.
MAP3D_INFO_LIGHT_Y
Float result representing the y-coordinate of the Light in
the scene.
MAP3D_INFO_LIGHT_Z
Float result representing the z-coordinate of the Light in
the scene.
MAP3D_INFO_LIGHT_COLOR
Integer result representing the Light color, see RGB( )
function on page 501.
MAP3D_INFO_CAMERA_X
Float result representing the x-coordinate of the
Camera in the scene.
MAP3D_INFO_CAMERA_Y
Float result representing the y-coordinate of the
Camera in the scene.
MAP3D_INFO_CAMERA_Z
Float result representing the z-coordinate of the
Camera in the scene.
MAP3D_INFO_CAMERA_FOCAL_X
Float result representing the x-coordinate of the
Cameras FocalPoint in the scene.
MAP3D_INFO_CAMERA_FOCAL_Y
Float result representing the y-coordinate of the
Cameras FocalPoint in the scene.
MAP3D_INFO_CAMERA_FOCAL_Z
Float result representing the z-coordinate of the
Cameras FocalPoint in the scene.
MAP3D_INFO_CAMERA_VU_1
Float result representing the first value of the ViewUp
Unit Normal Vector.
MAP3D_INFO_CAMERA_VU_2
Float result representing the second value of the
ViewUp Unit Normal Vector.
Reference Guide
383
Map3DInfo( ) function
Attribute
384
Return Value
MAP3D_INFO_CAMERA_VU_3
Float result representing the third value of the ViewUp
Unit Normal Vector.
MAP3D_INFO_CAMERA_VPN_1
Float result representing the first value of the
ViewPlane Unit Normal Vector.
MAP3D_INFO_CAMERA_VPN_2
Float result representing the second value of the
ViewPlane Unit Normal Vector.
MAP3D_INFO_CAMERA_VPN_3
Float result representing the third value of the
ViewPlane Unit Normal Vector.
MAP3D_INFO_CAMERA_CLIP_NEAR
Float result representing the cameras near clipping
plane.
MAP3D_INFO_CAMERA_CLIP_FAR
Float result representing the cameras far clipping
plane.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Prints out all the state variables specific to the 3DMap window:
include "Mapbasic.def"
Print "MAP3D_INFO_SCALE: " + Map3DInfo(FrontWindow( ), MAP3D_INFO_SCALE)
Print "MAP3D_INFO_RESOLUTION_X: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_RESOLUTION_X)
Print "MAP3D_INFO_RESOLUTION_Y: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_RESOLUTION_Y)
Print "MAP3D_INFO_BACKGROUND: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_BACKGROUND)
Print "MAP3D_INFO_UNITS: " + Map3DInfo(FrontWindow( ), MAP3D_INFO_UNITS)
Print "MAP3D_INFO_LIGHT_X : " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_LIGHT_X )
Print "MAP3D_INFO_LIGHT_Y : " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_LIGHT_Y )
Print "MAP3D_INFO_LIGHT_Z: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_LIGHT_Z)
Print "MAP3D_INFO_LIGHT_COLOR: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_LIGHT_COLOR)
Print "MAP3D_INFO_CAMERA_X: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_X)
Print "MAP3D_INFO_CAMERA_Y : " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_Y )
Print "MAP3D_INFO_CAMERA_Z : " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_Z )
Print "MAP3D_INFO_CAMERA_FOCAL_X: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_FOCAL_X)
Print "MAP3D_INFO_CAMERA_FOCAL_Y: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_FOCAL_Y)
Print "MAP3D_INFO_CAMERA_FOCAL_Z: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_FOCAL_Z)
Print "MAP3D_INFO_CAMERA_VU_1: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VU_1)
Print "MAP3D_INFO_CAMERA_VU_2: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VU_2)
Print "MAP3D_INFO_CAMERA_VU_3: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VU_3)
Print "MAP3D_INFO_CAMERA_VPN_1: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VPN_1)
Print "MAP3D_INFO_CAMERA_VPN_2: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VPN_2)
Print "MAP3D_INFO_CAMERA_VPN_3: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_VPN_3)
Print "MAP3D_INFO_CAMERA_CLIP_NEAR: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_CLIP_NEAR)
Print "MAP3D_INFO_CAMERA_CLIP_FAR: " + Map3DInfo(FrontWindow( ),
MAP3D_INFO_CAMERA_CLIP_FAR)
See Also
Create Map3D statement, Set Map3D statement
Reference Guide
385
MapperInfo( ) function
MapperInfo( ) function
Purpose
Returns coordinate or distance information about a Map window.
Syntax
MapperInfo( window_id, attribute )
window_id is an integer window identifier.
attribute is an integer code, indicating which type of information should be returned. See table below
for values.
Return Value
Float, logical, or string, depending on the attribute parameter.
Description
The MapperInfo( ) function returns information about a Map window.
The window_id parameter specifies which Map window to query. To obtain a window identifier, call
the FrontWindow( ) function immediately after opening a window, or call the WindowID( )
function at any time after the window's creation.
There are several numeric attributes that MapperInfo( ) can return about any given Map window.
The attribute parameter tells the MapperInfo( ) function which Map window statistic to return. The
attribute parameter should be one of the codes from the following table; codes are defined in
MAPBASIC.DEF.
attribute setting
386
MapperInfo( ) Return Value
MAPPER_INFO_AREAUNITS
String representing the map's abbreviated area unit
name, for example, “sq mi” for square miles.
MAPPER_INFO_CENTERX
The x-coordinate of the Map window's center.
MAPPER_INFO_CENTERY
The y-coordinate of the Map window's center.
MAPPER_INFO_CLIP_REGION
Returns a string to indicate if a clip region is
enabled. Returns the string “on” if a clip region is
enabled in the Mapper window. Otherwise, it returns
the string “off”.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute setting
MAPPER_INFO_CLIP_TYPE
MapperInfo( ) Return Value
The type of clipping being implemented. Choices
include:
•
•
•
MAPPER_INFO_CLIP_DISPLAY_ALL
MAPPER_INFO_CLIP_DISPLAY_POLYOBJ
MAPPER_INFO_CLIP_OVERLAY
MAPPER_INFO_COORDSYS_CLAUSE
string result, indicating the window's CoordSys
clause.
MAPPER_INFO_COORDSYS_CLAUSE_
WITH_BOUNDS
String result, indicating the window's CoordSys
clause including the bounds.
MAPPER_INFO_COORDSYS_NAME
String result, representing the name of the map's
CoordSys as listed in MAPINFOW.PRJ (but without
the optional “\p…” suffix that appears in
MAPINFOW.PRJ). Returns empty string if
CoordSys is not found in MAPINFOW.PRJ.
MAPPER_INFO_DISPLAY
Small integer, indicating what aspect of the map is
displayed on the status bar. Corresponds to Set
Map Display. Return value will be one of these:
•
•
•
MAPPER_INFO_DISPLAY_DMS
Small integer, indicating whether the map displays
coordinates in decimal degrees, DMS (degrees,
minutes, seconds), or Military Grid Reference
System format. Return value is one of the following:
•
•
•
MAPPER_INFO_DIST_CALC_TYPE
Reference Guide
MAPPER_INFO_DISPLAY_DECIMAL
MAPPER_INFO_DISPLAY_DMS
MAPPER_INFO_DISPLAY_MGRS (Military
Grid Reference System)
Small integer, indicating type of calculation to use
for distance, length, perimeter, and area
calculations for mapper. Corresponds to Set Map
Distance Type. Return values include:
•
•
MAPPER_INFO_DISTUNITS
MAPPER_INFO_DISPLAY_SCALE
MAPPER_INFO_DISPLAY_ZOOM
MAPPER_INFO_DISPLAY_POSITION
MAPPER_INFO_DIST_SPHERICAL
MAPPER_INFO_DIST CARTESIAN
String representing the map's abbreviated distance
unit name, for example, “mi” for miles.
387
MapperInfo( ) function
attribute setting
MapperInfo( ) Return Value
MAPPER_INFO_EDIT_LAYER
A SmallInt indicating the number of the currentlyeditable layer. A value of zero means that the
Cosmetic layer is editable. A value of -1 means that
no layer is editable.
MAPPER_INFO_LAYERS
Returns number of layers in the Map window as a
SmallInt (excludes the cosmetic layer).
MAPPER_INFO_MAXX
The largest x-coordinate shown in the window.
MAPPER_INFO_MAXY
The largest y-coordinate shown in the window.
MAPPER_INFO_MERGE_MAP
String value: the string of MapBasic statements that
a user needs to merge one map window into the
current map window.
MAPPER_INFO_MINX
The smallest x-coordinate shown in the window.
MAPPER_INFO_MINY
The smallest y-coordinate shown in the window.
MAPPER_INFO_MOVE_DUPLICATE_NO
DES
Small integer, indicating whether duplicate nodes
should be moved when reshaping objects in this
Map window. If the value is 0, duplicate nodes are
not moved. If the value is 1, any duplicate nodes
within the same layer will be moved. To return to
using the default from the map preferences, call Set
Map Move Nodes Default.
MAPPER_INFO_NUM_THEMATIC
Small integer, indicating the number of thematic
layers in this Map window.
MAPPER_INFO_REPROJECTION
String value indicating the current value of the
reprojection mode. The value can be either:
•
•
•
MAPPER_INFO_RESAMPLING
String value indicating the method for calculating
the pixel values of the source image being
reprojected. The value can be either:
•
•
388
None - Never reproject the map.
Always - Always reproject the map.
Auto - Optimize whether or not to reproject the
map; allow Mapinfo Professional to decide.
CubicConvolution
NearestNeighbor
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute setting
MapperInfo( ) Return Value
MAPPER_INFO_SCALE
The Map window's current scale, defined in terms of
the number of map distance units (for example,
Miles) per paper unit (for example, Inches)
displayed in the window. This returns a value in
MapBasic's current distance units.
MAPPER_INFO_SCROLLBARS
Logical value indicating whether the Map window
shows scrollbars.
MAPPER_INFO_XYUNITS
String representing the map's abbreviated
coordinate unit name, for example, “degree”.
MAPPER_INFO_ZOOM
The Map window's current zoom value (i.e., the
East-West distance currently displayed in the Map
window), specified in MapBasic's current distance
units; see Set Distance Units statement on
page 592.
When you call MapperInfo( ) to obtain coordinate values (for example, by specifying
MAPPER_INFO_CENTERX as the attribute), the value returned represents a coordinate in
MapBasic's current coordinate system, which may be different from the coordinate system of the
Map window. Use the Set CoordSys statement to specify a different coordinate system.
A setting for each Map window and providing MapBasic support to set and get the current setting for
each mapper. During Reshape, the move duplicate nodes can be set to none or move all duplicates
within the same layer.
Whenever a new Map window is created, the initial move duplicate nodes setting will be retrieved
from the mapper preference (Options / Preference / Map Window / Move Duplicate Nodes in).
An existing Map window can be queried for its current Move Duplicate Nodes setting using a new
attribute in MapperInfo( ) function.
The current state can be changed for a mapper window using the Set Map statement.
Coordinate Value Returns
MapperInfo( ) does not return coordinates (i.e. MINX, MAXX, MINY, MAXY) in the units set for the
map window. Instead, the coordinate values are returned in the units of the internal coordinate
system of the MapInfo Professional session or the MapBasic application that calls the function (if the
coordinate system was changed within the application). Also, the MAPPER_INFO_XYUNITS
attribute returns the units that are used to display the cursor location in the Status Bar (set by using
Set Map Window Frontwindow( ) XY Units).
Clip Region Information
Beginning with MapInfo Professional 6.0, there are three methods that are used for Clip Region
functionality. The MAPPER_INFO_CLIP_OVERLAY method is the method that has been the only
option until MapInfo Professional 6.0. Using this method, the Overlap( ) function (Object > Erase
Reference Guide
389
Maximum( ) function
Outside) is used internally. Since the Overlap( ) function cannot produce result with Text objects,
text objects are never clipped. For Point objects, a simple point in region test is performed to either
include or exclude the Point. Label objects are treated similar to Point objects and are either
completely displayed (is the label point is inside the clip region object) or ignored. Since the clipping
is done at the spatial object level, styles (wide lines, symbols, text) are never clipped.
The MAPPER_INFO_DISPLAY_ALL method uses the Windows Display to perform the clipping. All
object types are clipped. Thematics, rasters, and grids are also clipped. Styles (wide lines, symbols,
text) are always clipped. This is the default clipping type.
The MAPPER_INFO_CLIP_DISPLAY_POLYOBJ uses the Windows Display to selectively perform
clipping which mimics the functionality produced by MAPPER_INFO_CLIP_OVERLAY. Windows
Display Clipping is used to clip all Poly Objects (Regions and Polylines) and objects than can be
converted to Poly Objects (rectangles, rounded rectangles, ellipses, and arcs). These objects will
always have their symbology clipped. Points, Labels, and Text are treated as they would be in the
MAPPER_INFO_CLIP_OVERLAY method. In general, this method should provide better
performance that the MAPPER_INFO_CLIP_OVERLAY method.
Error Conditions
ERR_BAD_WINDOW error generated if parameter is not a valid window number.
ERR_FCN_ARG_RANGE error generated if an argument is outside of the valid range.
ERR_WANT_MAPPER_WIN error generated if window id is not a Map window.
See Also
LayerInfo( ) function, Set Distance Units statement, Set Map statement
Maximum( ) function
Purpose
Returns the larger of two numbers.
Syntax
Maximum( num_expr, num_expr )
num_expr is a numeric expression.
Return Value
Float
Description
The Maximum( ) function returns the larger of two numeric expressions.
390
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim
x =
y =
z =
x, y, z As Float
42
27
Maximum(x, y)
' z now contains the value: 42
See Also
Minimum( ) function
MBR( ) function
Purpose
Returns a rectangle object, representing the minimum bounding rectangle (MBR) of another object.
Syntax
MBR( obj_expr )
obj_expr is an object expression.
Return Value
Object (a rectangle)
Description
The MBR( ) function calculates the minimum bounding rectangle (MBR) which encompasses the
specified obj_expr object.
A minimum bounding rectangle is defined as being the smallest rectangle which is large enough to
encompass a particular object. In other words, the MBR of the United States extends east to the
eastern tip of Maine, south to the southern tip of Hawaii, west to the western tip of Alaska, and north
to the northern tip of Alaska.
The MBR of a point object has zero width and zero height.
Example
Dim o_mbr As Object
Open Table "world"
Fetch First From world
o_mbr = MBR(world.obj)
See Also
Centroid( ) function, CentroidX( ) function, CentroidY( ) function
Reference Guide
391
Menu Bar statement
Menu Bar statement
Purpose
Shows or hides the menu bar.
Syntax
Menu Bar { Hide | Show }
Description
The Menu Bar statement shows or hides MapInfo Professional's menu bar. An application might
hide the menu bar in order to provide more screen room for windows.
Following a Menu Bar Hide statement, the menu bar remains hidden until a Menu Bar Show
statement is executed. Since users can be severely handicapped without the menu bar, you should
be very careful when using the Menu Bar Hide statement. Every Menu Bar Hide statement should
be followed (eventually) by a Menu Bar Show statement.
While the menu bar is hidden, MapInfo Professional ignores any menu-related hotkeys. For
example, an MapInfo Professional user might ordinarily press Ctrl-O to bring up the Open dialog
box; but while the menu bar is hidden, MapInfo Professional ignores the Ctrl-O hotkey.
See Also
Alter Menu Bar statement, Create Menu Bar statement
MenuItemInfoByHandler( ) function
Purpose
Returns information about a MapInfo Professional menu item.
Syntax
MenuItemInfoByHandler( handler, attribute )
handler is either a string (containing the name of a handler procedure specified in a Calling clause)
or an integer (which was specified as a constant in a Calling clause).
attribute is an integer code indicating which attribute to return; see table below.
Description
The handler parameter can be an integer or a string. If you specify a string (a procedure name), and
if two or more menu items call that procedure, MapInfo Professional returns information about the
first menu item that calls the procedure. If you need to query multiple menu items that call the same
handler procedure, give each menu item an ID number (for example, using the optional ID clause in
the Create Menu statement), and call MenuItemInfoByID( ) function instead of calling
MenuitemInfoByHandler( ).
392
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The attribute parameter is a numeric code (defined in MAPBASIC.DEF) from the following table:
attribute setting
Return value
MENUITEM_INFO_ACCELERATOR
String: The code sequence for the menu item's
accelerator (for example, “/W^Z” or “/W#%119”) or an
empty string if the menu item has no accelerator. For
details on menu accelerators, see Create Menu
statement on page 192.
MENUITEM_INFO_CHECKABLE
Logical: TRUE if this menu item is checkable (specified
by the “!” prefix in the menu text).
MENUITEM_INFO_CHECKED
Logical: TRUE if the menu item is checkable and
currently checked; also return TRUE if the menu item
has alternate menu text (for example, if the menu item
toggles between Show… and Hide…), and the menu
item is in its “show” state. Otherwise, return FALSE.
MENUITEM_INFO_ENABLED
Logical: TRUE if the menu item is enabled.
MENUITEM_INFO_HANDLER
Integer: The menu item's handler number. If the menu
item's Calling clause specified a numeric constant (for
example, Calling M_FILE_SAVE), this call returns the
value of the constant. If the Calling clause specified
“OLE”, “DDE”, or the name of a procedure, this call
returns a unique integer (an internal handler number)
which can be used in subsequent calls to
MenuitemInfoByHandler( ) or in the Run Menu
Command statement.
MENUITEM_INFO_HELPMSG
String: the menu item's help message (as specified in
the HelpMsg clause in Create Menu statement) or
empty string if the menu item has no help message.
MENUITEM_INFO_ID
Integer: The menu ID number (specified in the optional
ID clause in a Create Menu statement), or 0 if the menu
item has no ID.
MENUITEM_INFO_SHOWHIDEABLE
Logical: TRUE if this menu item has alternate menu text
(i.e., if the menu item toggles between Show… and
Hide…). An item has alternate text if it was created with
“!” at the beginning of the menu item text (in a Create
Menu statement or Alter Menu statement) and it has a
caret (^) in the string.
MENUITEM_INFO_TEXT
String: the full text used (for example, in a Create Menu
statement) to create the menu item.
Reference Guide
393
MenuItemInfoByID( ) function
See Also
MenuItemInfoByID( ) function
MenuItemInfoByID( ) function
Purpose
Returns information about a MapInfo Professional menu item.
Syntax
MenuItemInfoByID( menuitem_ID, attribute )
menuitem_ID is an integer menu ID (specified in the ID clause in Create Menu).
attribute is an integer code indicating which attribute to return.
Description
This function is identical to the MenuItemInfoByHandler( ) function, except that the first argument
to this function is an integer ID.
Call this function to query the status of a menu item when you know the ID of the menu item you
need to query. Call the MenuItemInfoByHandler( ) function to query the status of a menu item if
you would rather identify the menu item by its handler.
The attribute argument is a code from MAPBASIC.DEF, such as MENUITEM_INFO_CHECKED. For
a listing of codes you can use, see MenuItemInfoByHandler( ) function on page 392.
See Also
MenuItemInfoByHandler( ) function
Metadata statement
Purpose
Manages a table's metadata.
Syntax 1
Metadata Table table_name
{ SetKey key_name To key_value |
DropKey key_name [ Hierarchical ] |
SetTraverse starting_key_name [ Hierarchical ]
Into ID traverse_ID_var }
table_name is the name of an open table.
key_name is a string, representing the name of a metadata key. The string must start with a
backslash (“\”), and it cannot end with a backslash.
key_value is a string up to 239 characters long, representing the value to assign to the key.
394
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
starting_key_name is a string representing the first key name to retrieve from the table. To set up the
traversal at the very beginning of the list of keys, specify “\” (backslash).
traverse_ID_var is the name of an integer variable; MapInfo Professional stores a traversal ID in the
variable, which you can use in subsequent Metadata Traverse… statements.
Syntax 2
Metadata Traverse traverse_ID
{ Next Into Key key_name_var In key_value_var |
Destroy }
traverse_ID is an integer value (such as the value of the traverse_ID_var variable described above).
key_name_var is the name of a string variable; MapInfo Professional stores the fetched key's name
in this variable.
key_value_var is the name of a string variable; MapInfo Professional stores the fetched key's value
in this variable.
Description
The Metadata statement manages the metadata stored in MapInfo tables. Metadata is information
that is stored in a table's .TAB file, instead of being stored as rows and columns.
Each table can have zero or more keys. Each key represents an information category, such as an
author's name, a copyright notice, etc. Each key has a string value associated with it. For example,
a key called “\Copyright” might have the value “Copyright 2001 MapInfo Corporation.” For more
information about Metadata, see the MapBasic User Guide.
Modifying a Table's Metadata
To create, modify, or delete metadata, use Syntax 1. The following clauses apply:
SetKey
Assigns a value to a metadata key. If the key already exists, MapInfo Professional assigns it a new
value. If the key does not exist, MapInfo Professional creates a new key. When you create a new
key, the changes take effect immediately; you do not need to perform a Save operation.
MetaData Table Parcels SetKey "\Info\Date" To Str$(CurDate( ))
Note: MapInfo Professional automatically creates a metadata key called “\IsReadOnly” (with a
default value of “FALSE”) the first time you add a metadata key to a table. The \IsReadOnly
key is a special key, reserved for internal use by MapInfo Professional.
DropKey
Deletes the specified key from the table. If you include the Hierarchical keyword, MapInfo
Professional deletes the entire metadata hierarchy at and beneath the specified key. For example, if
a table has the keys “\Info\Author” and “\Info\Date” you can delete both keys with the following
statement:
MetaData Table Parcels DropKey "\Info" Hierarchical
Reference Guide
395
Metadata statement
Reading a Table's Metadata
To read a table's metadata values, use the SetTraverse clause to initialize a traversal, and then use
the Next clause to fetch key values. After you are finished fetching key values, use the Destroy
clause to free the memory used by the traversal. The following clauses apply:
SetTraverse
Prepares to traverse the table's keys, starting with the specified key. To start at the beginning of the
list of keys, specify “\” as the starting key name. If you include the Hierarchical keyword, the
traversal can hierarchically fetch every key. If you omit the Hierarchical keyword, the traversal is
flat, meaning that MapInfo Professional will only fetch keys at the root level (for example, the
traversal will fetch the “\Info” key, but not the “\Info\Date” key).
Next Into Key… Into Value…
Attempts to read the next key. If there is a key to read, MapInfo Professional stores the key's name
in the key_name_var variable, and stores the key's value in the key_value_var variable. If there are
no more keys to read, MapInfo Professional stores empty strings in both variables.
Destroy
Ends the traversal, and frees the memory that was used by the traversal.
Note: A hierarchical metadata traversal can traverse up to ten levels of keys (for example,
“\One\Two\Three\Four\Five\Six\Seven\Eight\Nine\Ten”) if you begin the traversal at the root
level (“\”). If you need to retrieve a key that is more than ten levels deep, begin the traversal
at a deeper level (for example, begin the traversal at “\One\Two\Three\Four\Five”).
396
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following procedure reads all metadata values from a table; the table name is specified by the
caller. This procedure prints the key names and key values to the Message window.
Sub Print_Metadata(ByVal table_name As String)
Dim i_traversal As Integer
Dim s_keyname, s_keyvalue As String
' Initialize the traversal:
Metadata Table table_name
SetTraverse "\" Hierarchical Into ID i_traversal
' Attempt to fetch the first key:
Metadata Traverse i_traversal
Next Into Key s_keyname Into Value s_keyvalue
' Now loop for as long as there are key values;
' with each iteration of the loop, retrieve
' one key, and print it to the Message window.
Do While s_keyname <> ""
Print " "
Print "Key name: " & s_keyname
Print "Key value: " & s_keyvalue
Metadata Traverse i_traversal
Next Into Key s_keyname Into Value s_keyvalue
Loop
' Release this traversal to free memory:
MetaData Traverse i_traversal Destroy
End Sub
See Also
GetMetadata$( ) function, TableInfo( ) function
MGRSToPoint( ) function
Purpose
Converts a string representing an MGRS (Military Grid Reference System) coordinate into a point
object in the current MapBasic coordinate system.
Syntax
MGRSToPoint( string )
string is a string expression representing an MGRS coordinate.
The default Longitude/Latitude coordinate system is used as the initial selection.
Reference Guide
397
MGRSToPoint( ) function
Return Value
Object
Description
The returned point will be in the current MapBasic coordinate system, which by default is Long/Lat
(no datum). For the most accurate results when saving the resulting points to a table, set the
MapBasic coordinate system to match the destination table's coordinate system before calling
MGRSToPoint( ). This will prevent MapInfo Professional from doing an intermediate conversion to
the datumless Long/Lat coordinate system, which can cause a significant loss of precision.
Example
Example 1:
dim obj1 as Object
dim s_mgrs As String
dim obj2 as Object
obj1 = CreatePoint(-74.669, 43.263)
s_mgrs = PointToMGRS$(obj1)
obj2 = MGRSToPoint(s_mgrs)
Example 2:
Open Table "C:\Temp\MyTable.TAB" as MGRSfile
' When using the PointToMGRS$( ) or MGRSToPoint( ) functions,
' it is very important to make sure that the current MapBasic
' coordsys matches the coordsys of the table where the
' point object is being stored.
'Set the MapBasic coordsys to that of the table used
Set CoordSys Table MGRSfile
'Update a Character column (for example COL2) with MGRS strings from
'a table of points
Update MGRSfile
Set Col2 = PointToMGRS$(obj)
'Update two float columns (Col3 & Col4) with
'CentroidX & CentroidY information
'from a character column (Col2) that contains MGRS strings.
Update MGRSfile
Set Col3 = CentroidX(MGRSToPoint(Col2))
Update mgrstestfile ' MGRSfile
Set Col4 = CentroidY(MGRSToPoint(Col2))
Commit Table MGRSfile
Close Table MGRSfile
See Also
PointToMGRS$( ) function
398
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Mid$( ) function
Purpose
Returns a string extracted from the middle of another string.
Syntax
Mid$( string_expr, position, length )
string_expr is a string expression.
position is a numeric expression, indicating a starting position in the string.
length is a numeric expression, indicating the number of characters to extract.
Return Value
String
Description
The Mid$( ) function returns a substring copied from the specified string_expr string.
Mid$( ) copies length characters from the string_expr string, starting at the character position
indicated by position. A position value less than or equal to one tells MapBasic to copy from the very
beginning of the string_expr string.
If the string_expr string is not long enough, there may not be length characters to copy; thus,
depending on all of the parameters, the Mid$( ) may or may not return a string length characters
long. If the position parameter represents a number larger than the number of characters in
string_expr, Mid$( ) returns a null string. If the length parameter is zero, Mid$( ) returns a null string.
If the length or position parameters are fractional, MapBasic rounds to the nearest integer.
Example
Dim str_var, substr_var As String
str_var = "New York City"
substr_var = Mid$(str_var, 10, 4)
' substr_var now contains the string "City"
See Also
InStr( ) function, Left$( ) function, Right$( ) function
Reference Guide
399
MidByte$( ) function
MidByte$( ) function
Purpose
Accesses individual bytes of a string on a system with a double-byte character system.
Syntax
MidByte$( string_expr, position, length )
string_expr is a string expression.
position is an integer numeric expression, indicating a starting position in the string.
length is an integer numeric expression, indicating the number of bytes to return.
Return Value
String
Description
The MidByte$( ) function returns individual bytes of a string.
Use the MidByte$( ) function when you need to extract a range of bytes from a string, and the
application is running on a system that uses a double-byte character set (DBCS systems). For
example, the Japanese version of Microsoft Windows uses a double-byte character system.
On systems with single-byte character sets, the results returned by the MidByte$( ) function are
identical to the results returned by the Mid$( ) function.
See Also
InStr( ) function, Left$( ) function, Right$( ) function
Minimum( ) function
Purpose
Returns the smaller of two numbers.
Syntax
Minimum( num_expr, num_expr )
num_expr is a numeric expression.
Return Value
Float
400
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Minimum( ) function returns the smaller of two numeric expressions.
Example
Dim
x =
y =
z =
x, y, z As Float
42
-100
Minimum(x, y)
' z now contains the value: -100
See Also
Maximum( ) function
Minute function
Purpose
Returns the minute component of a Time.
Syntax
Minute (Time)
Return Value
Number
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as time
dim iMin as integer
X = CurDateTime()
iMin = Minute(X)
Print iMin
Month( ) function
Purpose
Returns the month component (1 - 12) of a date value.
Syntax
Month( date_expr )
date_expr is a date expression.
Reference Guide
401
Nearest statement
Return Value
SmallInt value from 1 to 12, inclusive.
Description
The Month( ) function returns an integer, representing the month component (one to twelve) of the
specified date.
Examples
The following example shows how you can extract just the month component from a particular date
value, using the Month( ) function.
If Month(CurDate( )) = 12 Then
'
' ... then it is December...
'
End If
You can also use the Month( ) function within the SQL Select statement. The following Select
statement extracts only particular rows from the Orders table. This example assumes that the
Orders table has a Date column, called Order_Date. The Select statement's Where clause tells
MapInfo Professional to only select the orders from December of 1993.
Open Table "orders"
Select *
From orders
Where Month(orderdate) = 12 And Year(orderdate) = 1993
See Also
CurDate( ) function, Day( ) function, Weekday( ) function, Year( ) function
Nearest statement
Purpose
Find the object in a table that is closest to a particular object. The result is a 2-point Polyline object
representing the closest distance.
Syntax
Nearest [ N | All ]
From { Table fromtable | Variable fromvar }
To totable Into intotable
[ Type { Spherical | Cartesian }]
[ Ignore [ Contains ] [ Min min_value ] [ Max max_value ]
Units unitname ] [ Data clause ]
N is an optional parameter representing the number of “nearest” objects to find. The default is 1. If
All is used, then a distance object is created for every combination.
fromtable represents a table of objects that you want to find closest distances from.
402
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
fromvar represents a MapBasic variable representing an object that you want to find the closest
distances from.
totable represents a table of objects that you want to find closest distances to.
intotable represents a table to place the results into.
min_value is the minimum distance to include in the results.
max_value is the maximum distance to include in the results.
unitname is string representing the name of a distance unit (for example, “km”) used for min_value
and/or max_value.
clause is an expression that specifies the tables that the results come from.
Description
The Nearest statement finds all the objects in the fromtable that are nearest to a particular object.
Every object in the fromtable is considered. For each object in the fromtable, the nearest object in
the totable is found. If N is defined, then the N nearest objects in totable are found. A two-point
Polyline object representing the closest points between the fromtable object and the chosen totable
object is placed in the intotable. If All is specified, then an object is placed in the intotable
representing the distance between the fromtable object and each totable object.
If there are multiple objects in the totable that are the same distance from a given fromtable object,
then only one of them may be returned. If multiple objects are requested (i.e., if N is greater than 1),
then objects of the same distance will fill subsequent slots. If the tie exists at the second closest
object, and three objects are requested, then the object will become the third closest object.
The types of the objects in the fromtable and totable can be anything except Text objects. For
example, if both tables contain Region objects, then the minimum distance between Region objects
is found, and the two-point Polyline object produced represents the points on each object used to
calculate that distance. If the Region objects intersect, then the minimum distance is zero, and the
two-point Polyline returned will be degenerate, where both points are identical and represent a point
of intersection.
The distances calculated do not take into account any road route distance. It is strictly a “as the bird
flies” distance.
Type is the method used to calculate the distances between objects. It can either be Spherical or
Cartesian. The type of distance calculation must be correct for the coordinate system of the
intotable or an error will occur. If the coordinate system of the intotable is NonEarth and the distance
method is Spherical, then an error will occur. If the coordinate system of the intotable is
Latitude/Longitude, and the distance method is Cartesian, then an error will occur.
The Ignore clause limits the distances returned. Any distances found which are less than or equal to
min_value or greater than max_value are ignored. min_value and max_value are in the distance unit
signified by unitname. If unitname is not a valid distance unit, an error will occur. One use of the Min
distance could be to eliminate distances of zero. This may be useful in the case of two point tables to
eliminate comparisons of the same point. For example, if there are two point tables representing
Cities, and we want to find the closest cities, we may want to exclude cases of the same city. The
entire Ignore clause is optional, as are the Min and Max subclauses within it.
Reference Guide
403
Nearest statement
The Max distance can be used to limit the objects to consider in the totable. This may be most useful
in conjunction with N or All. For example, we may want to search for the five airports that are closest
to a set of cities (where the fromtable is the set of cities and the totable is a set of airports), but we
don't care about airports that are farther away than 100 miles. This may result in less than five
airports being returned for a given city. This could also be used in conjunction with the All parameter,
where we would find all airports within 100 miles of a city. Supplying a Max parameter can improve
the performance of the Nearest statement, since it effectively limits the number of totable objects
that are searched.
The effective distances found are strictly greater than the min_value and less than or equal to the
max_value:
min_value < distance <= max_value
This can allow ranges or distances to be returned in multiple passes using the Nearest statement.
For example, the first pass may return all objects between 0 and 100 miles, and the second pass
may return all objects between 100 and 200 miles, and the results should not contain duplicates (i.e.,
a distance of 100 should only occur in the first pass and never in the second pass).
Normally, if one object is contained within another object, the distance between the objects is zero.
For example, if the fromtable is WorldCaps and the totable is World, then the distance between
London and the United Kingdom would be zero. If the Contains flag is set within the Ignore clause,
then the distance will not be automatically be zero. Instead, the distance from London to the
boundary of the United Kingdom will be returned. In effect, this will treat all closed objects, such as
regions, as polylines for the purpose of this operation.
Data Clause
The Data clause can be used to mark which fromtable object and which totable object the result
came from.
Data IntoColumn1=column1, IntoColumn2=column2
The IntoColumn on the left hand side of the equals must be a valid column in intotable. The column
name on the right hand side of the equals sign must be a valid column name from either totable or
fromtable. If the same column name exists in both totable and fromtable, then the column in totable
will be used (e.g., totable is searched first for column names on the right hand side of the equals
sign). To avoid any conflicts such as this, the column names can be qualified using the table alias:
Data name1=states.state_name, name2=county.state_name
To fill a column in the intotable with the distance, we can either use the Table > Update Column
functionality from the menu or use the Update statement.
Examples
Assume that we have a point table representing locations of ATM machines and that there are at
least two columns in this table: Business, which represents the name of the business which contains
the ATM; and Address, which represents the street address of that business. Assume that the
current selection represents our current location. Then the following will find the closest ATM to
where we currently are:
Nearest From Table selection To atm Into result Data
where=Business,address=Address
404
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If we wanted to find the closest five ATM machines to our current location:
Nearest 5 From Table selection To atm Into result Data
where=Business,address=Address
If we want to find all ATM machines within a 5 mile radius:
Nearest All From Table selection To atm Into result Ignore Max 5 Units
"mi" Data where=buisness,address=address
Assume we have a table of house locations (the fromtable) and a table representing the coastline
(the totable). To find the distance from a given house to the coastline:
Nearest From Table customer To coastline Into result Data
who=customer.name,
where=customer.address,coast_loc=coastline.county,type=coastline.designat
ion
If we don't care about customer locations which are greater than 30 miles from any coastline:
Nearest From Table customer To coastline Into result Ignore Max 30 Units
"mi" Data who=customer.name,
where=customer.address,coast_loc=coastline.county,
type=coastline.designation
Assume we have a table of cities (the fromtable) and another table of state capitals (the totable), and
we want to find the closest state capital to each city, but we want to ignore the case where the city in
the fromtable is also a state capital:
Nearest From Table uscty_1k To usa_caps Into result Ignore Min 0 Units
"mi" Data city=uscty_1k.name,capital=usa_caps.capital
See Also
Farthest statement, CartesianObjectDistance( ) function, ObjectDistance( ) function,
SphericalObjectDistance( ) function, CartesianConnectObjects( ) function, ConnectObjects( )
function, SphericalConnectObjects( ) function
Note statement
Purpose
Displays a simple message in a dialog box.
Syntax
Note message
message is an expression to be displayed in a dialog box.
Description
The Note statement creates a dialog box to display a message. The dialog box contains an OK
button; the message dialog box remains on the screen until the user clicks the OK button.
Reference Guide
405
NumAllWindows( ) function
The message expression does not need to be a string expression. If message is an object
expression, MapBasic will automatically produce an appropriate string (for example, “Region”) for
display in the Note dialog box. If the message expression is a string, the string can be up to 300
characters long, and can occupy up to 6 rows.
Example
Note "Total # of records processed: " + Str$( i_count )
See Also
Ask( ) function, Dialog statement, Print statement
NumAllWindows( ) function
Purpose
Returns the number of windows owned by MapInfo Professional, including special windows such as
ButtonPads and the Info window.
Syntax
NumAllWindows( )
Return Value
SmallInt
Description
The NumAllWindows( ) function returns the number of windows owned by MapInfo Professional.
To determine the number of document windows opened by MapInfo Professional (Map, Browse,
Graph, and Layout windows), call NumWindows( ).
See Also
NumWindows( ) function, WindowID( ) function
NumberToDate( ) function
Purpose
Returns a Date value, given an integer.
Syntax
NumberToDate( numeric_date )
numeric_date is an eight-digit integer in the form YYYYMMDD (for example, 19951231).
406
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Return Value
Date
Description
The NumberToDate( ) function returns a Date value represented by an eight-digit integer. For
example, the following function call returns a Date value of December 31, 2006:
NumberToDate(20061231)
Example
The following example subtracts one Date value from another Date. The result of the subtraction is
the number of days between the two dates.
Dim i_elapsed As Integer
i_elapsed = CurDate( ) - NumberToDate(20060101)
' i_elapsed now contains the number of days
' since January 1, 2006
See Also
StringToDate( ) function
NumberToDateTime function
Purpose
Returns a DateTime value.
Syntax
NumberToDateTime( numeric_datetime )
numeric_datetime is an seventeen-digit integer in the form YYYYMMDDHHMMSSFFF. For
example, 20070301214237582 represents March 1, 2007 9:42:37.582 PM.
Return Value
Date/Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim fNum as float
dim Y as datetime
fNum = 20070301214237582
Y = NumbertoDateTime (fNum)
Print FormatDate$(Y)
Print FormatTime$(Y,"hh:mm:ss.fff tt")
Reference Guide
407
NumberToTime function
NumberToTime function
Purpose
Returns a Time value.
Syntax
NumberToTime( numeric_time )
numeric_time is an nine-digit integer in the form HHMMSSFFF. For example, 214237582 represents
9:42:37.582 P.M.
Return Value
Time
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim fNum as float
dim Y as time
fNum = 214237582
Y = NumberToTime(fNum)
Print FormatTime$(Y,"hh:mm:ss.fff tt")
NumCols( ) function
Purpose
Returns the number of columns in a specified table.
Syntax
NumCols( table )
table is the name of an open table.
Return Value
SmallInt
Description
The NumCols( ) function returns the number of columns contained in the specified open table.
The number of columns returned by NumCols( ) does not include the special column known as
Object (or Obj for short), which refers to the graphical objects attached to mappable tables. Similarly,
the number of columns returned does not include the special column known as RowID.
Note: If a table has temporary columns (for example, because of an Add Column statement), the
number returned by NumCols( ) includes the temporary column(s).
408
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Error Conditions
ERR_TABLE_NOT_FOUND error generated if the specified table is not available.
Example
Dim i_counter As Integer
Open Table "world"
i_counter = NumCols(world)
See Also
ColumnInfo( ) function, NumTables( ) function, TableInfo( ) function
NumTables( ) function
Purpose
Returns the number of tables currently open.
Syntax
NumTables( )
Return Value
SmallInt
Description
The NumTables( ) function returns the number of tables that are currently open.
A street-map table may consist of two “companion” tables. For example, when you open the
Washington, DC street map named DCWASHS, MapInfo Professional secretly opens the two
companion tables DCWASHS1.TAB and DCWASHS2.TAB. However, MapInfo Professional treats
the DCWASHS table as a single table; for example, the Layer Control dialog box shows only the
table name DCWASHS. Similarly, the NumTables( ) function counts a street map as a single table,
although it may actually be composed of two companion tables.
Example
If NumTables( ) < 1 Then
Note "You must open a table before continuing."
End If
See Also
Open Table statement, TableInfo( ) function, ColumnInfo( ) function
Reference Guide
409
NumWindows( ) function
NumWindows( ) function
Purpose
Returns the number of open document windows (Map, Browse, Graph, Layout).
Syntax
NumWindows( )
Return Value
SmallInt
Description
The NumWindows( ) function returns the number of Map, Browse, Graph, and Layout windows that
are currently open. The result is independent of whether windows are minimized or not.
To determine the total number of windows opened by MapInfo Professional (including ButtonPads
and special windows such as the Info window), call NumAllWindows( ).
Example
Dim num_open_wins As SmallInt
num_open_wins = NumWindows( )
See Also
NumAllWindows( ) function, WindowID( ) function
410
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
ObjectDistance( ) function
Purpose
Returns the distance between two objects.
Syntax
ObjectDistance( object1, object2, unit_name )
object1 and object2 are object expressions.
unit_name is a string representing the name of a distance unit.
Return Value
Float
Description
ObjectDistance( ) returns the minimum distance between object1 and object2 using a spherical
calculation method with the return value in unit_name. If the calculation cannot be done using a
spherical distance method (e.g., if the MapBasic Coordinate System is NonEarth), then a cartesian
distance method will be used.
ObjectGeography( ) function
Purpose
Returns coordinate or angle information describing a graphical object.
Syntax
ObjectGeography( object, attribute )
object is an Object expression.
attribute is an integer code specifying which type of information should be returned.
Return Value
Float
Description
The attribute parameter controls which type of information will be returned. The table below
summarizes the different codes that you can use as the attribute parameter; codes in the left column
(for example, OBJ_GEO_MINX) are defined in MAPBASIC.DEF.
Reference Guide
411
ObjectGeography( ) function
Some attributes apply only to certain types of objects. For example, arc objects are the only objects
with begin-angle or end-angle attributes, and text objects are the only objects with the text-angle
attribute. If an object does not support z- or m-values, or a z- or m-value for this node is not defined,
then an error is thrown.
attribute setting
412
Return value (Float)
OBJ_GEO_MINX
Minimum x-coordinate of an object's minimum bounding rectangle
(MBR), unless the object is a line; if the object is a line, returns
same value as OBJ_GEO_LINEBEGX.
OBJ_GEO_MINY
Minimum y-coordinate of object's MBR. For lines, returns
OBJ_GEO_LINEBEGY value.
OBJ_GEO_MAXX
Maximum x-coordinate of object's MBR. Does not apply to Point
objects. For lines, returns OBJ_GEO_LINEENDX value.
OBJ_GEO_MAXY
Maximum y-coordinate of the object's MBR. Does not apply to
Point objects. For lines, returns OBJ_GEO_LINEENDY value.
OBJ_GEO_ARCBEGANGLE
Beginning angle of an Arc object.
OBJ_GEO_ARCENDANGLE
Ending angle of an Arc object.
OBJ_GEO_LINEBEGX
X-coordinate of the starting node of a Line object.
OBJ_GEO_LINEBEGY
Y-coordinate of the starting node of a Line object.
OBJ_GEO_LINEENDX
X-coordinate of the ending node of a Line object.
OBJ_GEO_LINEENDY
Y-coordinate of the ending node of a Line object.
OBJ_GEO_POINTX
X-coordinate of a Point object.
OBJ_GEO_POINTY
Y-coordinate of a Point object.
OBJ_GEO_POINTZ
Z-value of a Point object.
OBJ_GEO_POINTM
M-value of a Point object.
OBJ_GEO_ROUNDRADIUS
Diameter of the circle that defines the rounded corner of a
Rounded Rectangle object, expressed in terms of coordinate
units (for example, degrees).
OBJ_GEO_CENTROID
Returns a point object for centroid of regions, collections,
multipoints, and polylines. This is most commonly used with the
Alter Object statement.
OBJ_GEO_TEXTLINEX
X-coordinate of the end of a Text object's label line.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute setting
Return value (Float)
OBJ_GEO_TEXTLINEY
Y-coordinate of the end of a Text object's label line.
OBJ_GEO_TEXTANGLE
Rotation angle of a Text object.
The ObjectGeography( ) function has been extended to support Multipoints and Collections. Both
types support attributes 1 - 4 (coordinates of object's minimum bounding rectangle (MBR).
.
OBJ_GEO_MINX (1)
Minimum x-coordinate of an object's MBR.
OBJ_GEO_MINY (2)
Minimum y-coordinate of an object's MBR.
OBJ_GEO_MAXX (3)
Maximum x-coordinate of an object's MBR.
OBJ GEO_MAXY (4)
Maximum y-coordinate of an object's MBR.
Example
The following example reads the starting coordinates of a line object from the table City. A Set Map
statement then uses these coordinates to re-center the Map window.
Include "MAPBASIC.DEF"
Dim i_obj_type As Integer, f_x, f_y As Float
Open Table "city"
Map From city
Fetch First From city
' at this point, the expression:
' city.obj
' represents the graphical object that's attached
' to the first record of the CITY table.
i_obj_type = ObjectInfo(city.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_LINE Then
f_x = ObjectGeography(city.obj, OBJ_GEO_LINEBEGX)
f_y = ObjectGeography(city.obj, OBJ_GEO_LINEBEGY)
Set Map Center (f_x, f_y)
End If
See Also
Centroid( ) function, CentroidX( ) function, CentroidY( ) function, ObjectInfo( ) function
Reference Guide
413
ObjectInfo( ) function
ObjectInfo( ) function
Purpose
Returns Pen, Brush, or other values describing a graphical object.
Syntax
ObjectInfo( object, attribute )
object is an Object expression.
attribute is an integer code specifying which type of information should be returned.
Return Value
SmallInt, integer, string, float, Pen, Brush, Symbol, or Font, depending on the attribute parameter
OBJ_INFO_NPOLYGONS (21) is an integer that indicates the number of polygons (in the case of a
region) or sections (in the case of a polyline) which make up an object.
OBJ_INFO_NPOLYGONS+N (21) is an integer that indicates the number of nodes in the Nth
polygon of a region or the Nth section of a polyline.
Note: With region objects, MapInfo Professional counts the starting node twice (once as the start
node and once as the end node). For example, ObjectInfo( ) returns a value of 4 for a
triangle-shaped region.
Description
The ObjectInfo( ) function returns general information about one aspect of a graphical object. The
first parameter should be an object value (for example, the name of an Object variable, or a table
expression of the form tablename.obj).
Each object has several attributes. For example, each object has a “type” attribute, identifying
whether the object is a point, a line, or a region, etc. Most types of objects have Pen and/or Brush
attributes, which dictate the object's appearance. The ObjectInfo( ) function returns one attribute of
the specified object. Which attribute is returned depends on the value used in the attribute
parameter. Thus, if you need to find out several pieces of information about an object, you will need
to call ObjectInfo( ) a number of times, with different attribute values in each call.
The table below summarizes the various attribute settings, and the corresponding return values.
414
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute Setting
Return Value
OBJ_INFO_TYPE (1)
SmallInt, representing the object type; the return value is
one of the values listed in the table below (for example,
OBJ_TYPE_LINE). This attribute from the DEF file is 1
(ObjectInfo( Object, 1 )).
OBJ_INFO_PEN (2)
Pen style is returned; this query is only valid for the following
object types: Arc, Ellipse, Line, Polyline, Frame, Regions,
Rectangle, and Rounded Rectangle.
OBJ_INFO_BRUSH (3)
Brush style is returned; this query is only valid for the
following object types: Ellipse, Frame, Region, Rectangle,
and Rounded Rectangle.
OBJ_INFO_TEXTFONT (2)
Font style is returned; this query is only valid for Text objects.
Note: If the Text object is contained in a mappable table (as
opposed to a Layout window), the Font specifies a
point size of zero, and the text height is controlled by
the Map window's zoom distance.
OBJ_INFO_SYMBOL (2)
Symbol style; this query is only valid for Point objects.
OBJ_INFO_NPNTS (20)
Integer, indicating the total number of nodes in a polyline or
region object.
OBJ_INFO_SMOOTH (4)
Logical, indicating whether the specified Polyline object is
smoothed.
OBJ_INFO_FRAMEWIN (4)
Integer, indicating the window ID of the window attached to a
Frame object.
OBJ_INFO_FRAMETITLE (6)
String, indicating a Frame object's title.
OBJ_INFO_NPOLYGONS (21)
SmallInt, indicating the number of polygons (in the case of a
region) or sections (in the case of a polyline) which make up
an object.
OBJ_INFO_NPOLYGONS+N (21)
Integer, indicating the number of nodes in the Nth polygon of
a region or the Nth section of a polyline.
Note: With region objects, MapInfo Professional counts the
starting node twice (once as the start node and once
as the end node). For example, ObjectInfo( ) returns
a value of 4 for a triangle-shaped region.
OBJ_INFO_TEXTSTRING (3)
Reference Guide
String, representing the body of a Text object; if the object
has multiple lines of text, the string includes embedded linefeeds (Chr$( 10 ) values).
415
ObjectInfo( ) function
attribute Setting
Return Value
OBJ_INFO_TEXTSPACING (4)
Float value of 1, 1.5, or 2, representing a Text object's line
spacing.
OBJ_INFO_TEXTJUSTIFY (5)
SmallInt, representing justification of a Text object: 0 = left, 1
= center, 2 = right.
OBJ_INFO_TEXTARROW (6)
SmallInt, representing the line style associated with a Text
object: 0 = no line, 1 = simple line, 2 = arrow line.
OBJ_INFO_FILLFRAME (7)
Logical: TRUE if the object is a frame that contains a Map
window, and the frame's “Fill Frame With Map” setting is
checked.
OBJ_INFO_NONEMPTY (11)
Logical, returns TRUE if a Multipoint object has nodes, or
FALSE if the object is empty.
OBJ_INFO_REGION (8)
Object value representing the region part of a collection
object. If the collection object does not have a region, it
returns an empty region. This query is valid only for
collection objects.
OBJ_INFO_PLINE (9)
Object value representing polyline part of a collection object.
If the collection object does not have a polyline, it returns an
empty polyline object. This query is valid only for collection
objects.
OBJ_INFO_MPOINT (10)
Object value representing the Multipoint part of a collection
object. If the collection object does not have a Multipoint, it
returns an empty Multipoint object. This query is valid only
for collection objects.
OBJ_INFO_Z_UNIT_SET(12)
Logical, indicating whether z units are defined.
OBJ_INFO_Z_UNIT(13)
String result: indicates distance units used for z-values.
Returns an empty string if units are not specified.
OBJ_INFO_HAS_Z(14)
Logical, indicating whether the object has z-values.
OBJ_INFO_HAS_M(15)
Logical, indicating whether the object has m-values.
The codes in the left column (for example, OBJ_INFO_TYPE) are defined through the MapBasic
definitions file, MAPBASIC.DEF. Your program should Include “MAPBASIC.DEF” if you intend to call
the ObjectInfo( ) function.
Each graphic attribute only applies to some types of graphic objects. For example, point objects are
the only objects with Symbol attributes, and text objects are the only objects with Font attributes.
Therefore, the ObjectInfo( ) function cannot return every type of attribute setting for every type of
object.
416
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If you specify OBJ_INFO_TYPE as the attribute setting, the ObjectInfo( ) function returns one of the
object types listed in the table below.
OBJ_INFO_TYPE values
OBJ_INFO_TYPE values
Corresponding object type
OBJ_TYPE_ARC
Arc object
OBJ_TYPE_ELLIPSE
Ellipse / circle objects
OBJ_TYPE_LINE
Line object
OBJ_TYPE_PLINE
Polyline object
OBJ_TYPE_POINT
Point object
OBJ_TYPE_FRAME
Layout window Frame object
OBJ_TYPE_REGION
Region object
OBJ_TYPE_RECT
Rectangle object
OBJ_TYPE_ROUNDRECT
Rounded rectangle object
OBJ_TYPE_TEXT
Text object
OBJ_TYPE_MULTIPOINT
Collection text object
Example
Include "MAPBASIC.DEF"
Dim counter, obj_type As Integer
Open Table "city"
Fetch First From city
' at this point, the expression: city.obj
' represents the graphical object that's attached
' to the first record of the CITY table.
obj_type = ObjectInfo(city.obj, OBJ_INFO_TYPE)
Do Case obj_type
Case OBJ_TYPE_LINE
Note "First object is a line."
Case OBJ_TYPE_PLINE
Note "First object is a polyline..."
counter = ObjectInfo(city.obj, OBJ_INFO_NPNTS)
Note " ... with " + Str$(counter) + " nodes."
Case OBJ_TYPE_REGION
Note "First object is a region..."
counter = ObjectInfo(city.obj, OBJ_INFO_NPOLYGONS)
Note ", made up of " + Str$(counter) + " polygons..."
counter = ObjectInfo(city.obj, OBJ_INFO_NPOLYGONS+1)
Note "The 1st polygon has" + Str$(counter) + " nodes"
End Case
Reference Guide
417
ObjectLen( ) function
See Also
Alter Object statement, Brush clause, Font clause, ObjectGeography( ) function, Pen clause,
Symbol clause
ObjectLen( ) function
Purpose
Returns the geographic length of a line or polyline object.
Syntax
ObjectLen( expr, unit_name )
expr is an object expression.
unit_name is a string representing the name of a distance unit (for example, “mi” for miles).
Return Value
Float
Description
The ObjectLen( ) function returns the length of an object expression. Note that only line and polyline
objects have length values greater than zero; to measure the circumference of a rectangle, ellipse,
or region, use the Perimeter( ) function.
The ObjectLen( ) function returns a length measurement in the units specified by the unit_name
parameter; for example, to obtain a length in miles, specify “mi” as the unit_name parameter. See
Set Distance Units statement on page 592 for the list of valid unit names.
For the most part, MapInfo Professional performs a Cartesian or Spherical operation. Generally, a
Spherical operation is performed unless the coordinate system is nonEarth, in which case, a
Cartesian operation is performed.
Example
Dim geogr_length As Float
Open Table "streets"
Fetch First From streets
geogr_length = ObjectLen(streets.obj, "mi")
' geogr_length now represents the length of the
' street segment, in miles
See Also
Distance( ) function, Perimeter( ) function, Set Distance Units statement
418
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
ObjectNodeHasM( ) function
Purpose
Returns TRUE if a specific node in a region, polyline or multipoint object has an m-value.
Syntax
ObjectNodeHasM( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
node_num is a positive integer value indicating which node to read.
Return Value
Logical
Description
The ObjectNodeHasM( ) function returns TRUE if the specific node from a region, polyline, or
multipoint object has an m-value.
The polygon_num parameter must have a value of one or more. This specifies which polygon (if
querying a region) or which section (if querying a polyline) should be queried. Call the ObjectInfo( )
function to determine the number of polygons or sections in an object. The ObjectNodeHasM( )
function supports Multipoint objects and returns TRUE if a specific node in a Multipoint object has an
m-value.
The node_num parameter must have a value of one or more; this tells MapBasic which of the
object's nodes should be queried. You can use the ObjectInfo( ) function to determine the number
of nodes in an object.
If the object does not support m-values or an m-value for this node is not defined, it returns FALSE.
Reference Guide
419
ObjectNodeHasZ( ) function
Example
The following example queries the first graphic object in the table Routes. If the first object is a
polyline, the program queries if the first node in the object has z-coordinates or m-values and
queries z-coordinates and m-values of the first node in the polyline.
Dim i_obj_type As SmallInt,
z, m As Float
hasZ, hasM as Logical
Open Table "routes"
Fetch First From routes
' at this point, the expression:
' routes.obj
' represents the graphical object that's attached
' to the first record of the routes table.
i_obj_type = ObjectInfo(routes.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_PLINE Then
' ... then the object is a polyline...
If (ObjectNodeHasZ(routes.obj, 1, 1)) Then
z = ObjectNodeZ(routes.obj, 1, 1) ' read z-coordinate
End If
If (ObjectNodeHasM(routes.obj, 1, 1)) Then
m = ObjectNodeM(routes.obj, 1, 1) ' read m-value
End If
End If
See Also
Querying Map Objects, ObjectInfo( ) function
ObjectNodeHasZ( ) function
Purpose
Returns TRUE if a specific node in a region, polyline, or multipoint object has a z-coordinate
Syntax
ObjectNodeHasZ( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
node_num is a positive integer value indicating which node to read.
Return Value
Logical
420
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The ObjectNodeHasZ( ) function returns TRUE if a specific node from a region, polyline, or
multipoint object has a z-coordinate. The polygon_num parameter must have a value of one or
more. This specifies which polygon (if querying a region) or which section (if querying a polyline)
should be queried. Call the ObjectInfo( ) function to determine the number of polygons or sections
in an object. The ObjectNodeHasZ( ) function supports Multipoint objects and returns TRUE if a
specific node in a Multipoint object has a z-coordinate.
The node_num parameter must have a value of one or more; this tells MapBasic which of the
object's nodes should be queried. You can use the ObjectInfo( ) function to determine the number
of nodes in an object.
If object does not support z-coordinates or a z-coordinate for this node is not defined, it returns
FALSE.
Example
The following example queries the first graphic object in the table Routes. If the first object is a
polyline, the program queries if the first node in the object has z-coordinates or m-values and
queries z-coordinates and m-values of the first node in the polyline.
Dim i_obj_type As SmallInt,
z, m As Float
hasZ, hasM as Logical
Open Table "routes"
Fetch First From routes
' at this point, the expression:
' routes.obj
' represents the graphical object that's attached
' to the first record of the routes table.
i_obj_type = ObjectInfo(routes.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_PLINE Then
' ... then the object is a polyline...
If (ObjectNodeHasZ(routes.obj, 1, 1)) Then
z = ObjectNodeZ(routes.obj, 1, 1) ' read z-coordinate
End If
If (ObjectNodeHasM(routes.obj, 1, 1)) Then
m = ObjectNodeM(routes.obj, 1, 1) ' read m-value
End If
End If
See Also
Querying Map Objects, ObjectInfo( ) function
Reference Guide
421
ObjectNodeM( ) function
ObjectNodeM( ) function
Purpose
Returns the m-value of a specific node in a region, polyline, or multipoint object.
Syntax
ObjectNodeM( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
node_num is a positive integer value indicating which node to read.
Return Value
Float
Description
The ObjectNodeM( ) function returns the m-value of a specific node from a region, polyline, or
multipoint object.
The polygon_num parameter must have a value of one or more. This specifies which polygon (if
querying a region), or which section (if querying a polyline), should be queried. Call the ObjectInfo( )
function to determine the number of polygons or sections in an object. The ObjectNodeM( )
function supports Multipoint objects and returns the m-value of a specific node in a Multipoint object.
The node_num parameter must have a value of one or more; this tells MapBasic which of the
object's nodes should be queried. You can use the ObjectInfo( ) function to determine the number
of nodes in an object.
If an object does not support m-values, or an m-value for this node is not defined, then an error is
thrown.
422
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example queries the first graphic object in the table Routes. If the first object is a
polyline, the program queries z-coordinates and m-values of the first node in the polyline.
Dim i_obj_type As SmallInt,
z, m As Float
Open Table "routes"
Fetch First From routes
' at this point, the expression:
' routes.obj
' represents the graphical object that's attached
' to the first record of the routes table.
i_obj_type = ObjectInfo(routes.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_PLINE Then
' ... then the object is a polyline...
z = ObjectNodeZ(routes.obj, 1, 1) ' read z-coordinate
m = ObjectNodeM(routes.obj, 1, 1) ' read m-value
End If
See Also
Querying Map Objects, ObjectInfo( ) function
ObjectNodeX( ) function
Purpose
Returns the x-coordinate of a specific node in a region or polyline object.
Syntax
ObjectNodeX( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
node_num is a positive integer value indicating which node to read.
Return Value
Float
Description
The ObjectNodeX( ) function returns the x-value of a specific node from a region or polyline object.
The corresponding ObjectNodeY( ) function returns the y-coordinate value.
Reference Guide
423
ObjectNodeY( ) function
The polygon_num parameter must have a value of one or more. This specifies which polygon (if
querying a region) or which section (if querying a polyline) should be queried. Call the ObjectInfo( )
function to determine the number of polygons or sections in an object. The ObjectNodeX( )
function supports Multipoint objects and returns the x-coordinate of a specific node in a Multipoint
object.
The node_num parameter must have a value of one or more; this tells MapBasic which of the
object's nodes should be queried. You can use the ObjectInfo( ) function to determine the number
of nodes in an object. The ObjectNodeX( ) function returns the value in the coordinate system
currently in use by MapBasic; by default, MapBasic uses a Longitude/Latitude coordinate system.
See Set CoordSys statement on page 588 for more information about coordinate systems.
Example
The following example queries the first graphic object in the table Routes. If the first object is a
polyline, the program queries the x- and y-coordinates of the first node in the polyline, then creates a
new Point object at the location of the polyline's starting node.
Dim i_obj_type As SmallInt, x, y As Float, new_pnt As Object
Open Table "routes"
Fetch First From routes
' at this point, the expression:
' routes.obj
' represents the graphical object that's attached
' to the first record of the routes table.
i_obj_type = ObjectInfo(routes.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_PLINE Then
' ... then the object is a polyline...
x = ObjectNodeX(routes.obj, 1, 1) ' read longitude
y = ObjectNodeY(routes.obj, 1, 1) ' read latitude
Create Point Into Variable new_pnt (x, y)
Insert Into routes (obj) Values (new_pnt)
End If
See Also
Alter Object statement, ObjectGeography( ) function, ObjectInfo( ) function, ObjectNodeY( )
function, Set CoordSys statement
ObjectNodeY( ) function
Purpose
Returns the y-coordinate of a specific node in a region or polyline object.
Syntax
ObjectNodeY( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
424
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
node_num is a positive integer value indicating which node to read.
Return Value
Float
Description
The ObjectNodeY( ) function returns the y-value of a specific node from a region or polyline object.
See ObjectNodeX( ) function on page 423 for more information.
Example
See ObjectNodeX( ) function on page 423.
See Also
Alter Object statement, ObjectGeography( ) function, ObjectInfo( ) function, Set CoordSys
statement
ObjectNodeZ( ) function
Purpose
Returns the z-value of a specific node in a region, polyline, or multipoint object.
Syntax
ObjectNodeZ( object, polygon_num, node_num )
object is an Object expression.
polygon_num is a positive integer value indicating which polygon or section to query. It is ignored for
Multipoint objects (it used for regions and polylines).
node_num is a positive integer value indicating which node to read
Return Value
Float
Description
The ObjectNodeZ( ) function returns the z-value of a specific node from a region, polyline, or
multipoint object.
The polygon_num parameter must have a value of one or more. This specifies which polygon (if
querying a region) or which section (if querying a polyline) should be queried. Call the ObjectInfo( )
function to determine the number of polygons or sections in an object. The ObjectNodeZ( )
function supports Multipoint objects and returns the z-coordinate of a specific node in a Multipoint
object.
Reference Guide
425
Objects Check statement
The node_num parameter must have a value of one or more; this tells MapBasic which of the
object's nodes should be queried. You can use the ObjectInfo( ) function to determine the number
of nodes in an object.
If object does not support Z-values, or Z-value for this node is not defined, then an error is thrown.
Example
The following example queries the first graphic object in the table Routes. If the first object is a
polyline, the program queries z-coordinates and m-values of the first node in the polyline.
Dim i_obj_type As SmallInt,
z, m As Float
Open Table "routes"
Fetch First From routes
' at this point, the expression:
' routes.obj
' represents the graphical object that's attached
' to the first record of the routes table.
i_obj_type = ObjectInfo(routes.obj, OBJ_INFO_TYPE)
If i_obj_type = OBJ_PLINE Then
' ... then the object is a polyline...
z = ObjectNodeZ(routes.obj, 1, 1) ' read z-coordinate
m = ObjectNodeM(routes.obj, 1, 1) ' read m-value
End If
See Also
Querying Map Objects, ObjectInfo( ) function
Objects Check statement
Purpose
Checks a given table for various aspects of incorrect data, or possible incorrect data, which may
cause problems and/or incorrect results in various operations.
Syntax
Objects Check From tablename Into Table tablename
[ SelfInt [ Symbol Clause] ]
[ Overlap [ Pen Clause ] [ Brush Clause ] ]
[ Gap Area [ Unit Units ] [ Pen Clause ] [ Brush Clause ] ] ]
tablename is a string representing the name of a table.
Clause is an expression.
Units is a value of an area.
426
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
Objects Check will check the table designated in the From clause for various aspects of bad data
which may cause problems or incorrect results with various operations. Only region objects will be
checked. The region objects will be optionally checked for self-intersections, and areas of overlap
and gaps.
Self-intersections may cause problems with various calculations, including the calculation for the
area of a region. They may also cause incorrect results from various object-processing operations,
such as combine, buffer, erase, erase outside, and split.
For any of these problems, a point object is created and placed into the output table. The output
table can be supplied through the Into Table clause. If no Into Table clause exists, the output data is
placed into the same table as the input table.
If the SelfInt option is included, then the table will be checked for self-intersections. Where found,
point objects are created using the style provided by the Symbol Clause. By default, this is a 28point red pushpin.
Many region tables are designed to be boundary tables. The states.tab and world.tab files provided
with the sample data are examples of boundary tables. In tables such as these, boundaries should
not overlap (for example, the state of Utah should not overlap with the state of Wyoming). The
Overlap option will check the table for places where regions overlap with other regions. Regions will
be created in the output table representing any areas of overlap. These regions will be created using
the Brush Clause to represent the interior of the regions, and the Pen Clause to represent the
boundary of the regions. By default, these regions are drawn with solid yellow interiors and thin
black boundaries.
Gaps are enclosed areas where no region object currently exists. In a boundary table, most regions
abut other regions and share a common boundary. Just as there should be no overlaps between the
regions, there should also be no gaps between the regions. In some cases, these boundary gaps
are legitimate for the data. An example of this would be the Great Lakes in the World map, which
separate parts of Canada from the USA. Most gaps that are data problems occur because adjacent
boundaries do not have common boundaries that completely align. These gap areas are generally
small.
To help weed out the legitimate gap areas, such as the Great Lakes, from problem gap areas, a Gap
Area is used. Any potential gap that is larger than this gap area is discarded and not reported. The
units that the Gap Area is in is presented by the Units clause. If the Units sub-clause is not present,
then the Gap Area value will be interpreted in MapBasic's current area unit.
Gaps will be presented using the Pen and Brush clauses that follow the Gap keyword. By default,
these regions are drawn with blue interiors and a thin black boundary.
Example
This example will run Objects Check on the table called TestFile and store the results in the table
called DumpFile. It will also use the Overlap keyword and change the default Point and Polygon
styles.
objects check from TestFile into table Dumpfile Overlap
Selfint Symbol (67,16711680,28)
Overlap Pen (1,2,0) Brush (2,16776960,0)
Gap 100000 Units "sq mi" Pen (1,2,0) Brush (2,255,0)
Reference Guide
427
Objects Clean statement
See Also
Objects Enclose statement
Objects Clean statement
Purpose
Cleans the objects from the given table, and optionally removes overlaps and gaps between regions.
The table may be the Selection table. All objects to be cleaned must be closed object types (i.e.,
regions, rectangles, rounded rectangles, or ellipses).
Syntax
Objects Clean From tablename
[ Overlap ]
[ Gap Area [ Unit Units ]]
tablename is a string representing the name of a table.
Units is a value of an area.
Description
The objects in the input tablename are first checked for various data problems and inconsistencies,
such as self-intersections, overlaps, and gaps. Self-intersecting regions in the form of a figure 8 will
be changed into a region containing two polygons that touch each other at a single point. Regions
containing spikes will have the spike portion removed. The resulting cleaned object will replace the
original input object.
If the Overlap keyword is included, then overlapping areas will be removed from regions. The
portion of the overlap will be removed from all overlapping regions except the one with the largest
area.
Note: Objects Clean removes the overlap when one object is completely inside another. This is an
exception to the rule of “biggest object wins”. If one object is completely inside another
object, then the object that is inside remains, and a hole is punched in the containing object.
The result does not contain any overlaps.
Gaps are enclosed areas where no region object currently exists. In a boundary table, most regions
abut other regions and share a common boundary. Just as there should be no overlaps between the
regions, there should also be no gaps between the regions. In some cases, both these boundary
gaps and holes are legitimate for the data. An example of this would be the Great Lakes in the World
map, which separate parts of Canada from the USA. Most gaps that are data problems occur
because adjacent boundaries do not have common boundaries that completely align. These gap
areas are generally small.
To help weed out the legitimate gap areas, such as the Great Lakes, from problem gap areas, a Gap
Area is used. Any potential gap that is larger than this gap area is discarded and not reported. The
units of the Gap Area are indicated by the Units sub-clause. If the Units sub-clause is not present,
then the Gap Area value is interpreted in MapBasic's current area unit. Gaps that are found will be
428
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
removed by combining the area defining the gap to the region with the largest area that touches the
gap. To help determine a reasonable Gap Area, use the Objects Check statement. Any gaps that
the Objects Check statement flags will be removed with the Objects Clean statement.
Example
Open Table "STATES.TAB" Interactive
Map From STATES
Set Map Layer 1 Editable On
select * from STATES
Objects Clean From Selection Overlap Gap 10 Units "sq m"
See Also
Create Object statement, Objects Disaggregate statement, Objects Check statement
Objects Combine statement
Purpose
Combines objects in a table; corresponds to MapInfo Professional's Objects > Combine command.
Syntax
Objects Combine
[ Into Target ]
[ Data column = expression [ , column = expression ... ] ]
column is a string representing the name of a column in the table being modified.
expression is an expression used to populate the column.
Description
Objects Combine creates an object representing the geographic union of the currently selected
objects. Optionally, Objects Combine can also perform data aggregation, calculating sums or
averages of the data values that are associated with the objects being combined.
The Objects Combine statement corresponds to MapInfo Professional's Objects > Combine menu
item. For an introduction to this operation, see the discussion of the Objects > Combine menu item
in the MapInfo Professional Reference. To see a demonstration of the Objects Combine statement,
run MapInfo, open MapInfo Professional's MapBasic Window, and use the Objects > Combine
command. Objects involved in the combine operation must either be all closed objects (for example,
regions, rectangles, rounded rectangles, or ellipses) or all linear objects (for example, lines,
polylines, or arcs). Mixed closed and linear objects as well as point and text objects are not allowed.
The optional Into Target clause is only valid if an editing target has been specified (either by the
user or through the Set Target statement), and only if the target consists of one object. If you
include the Into Target clause, MapInfo Professional combines the currently-selected objects with
the current target object. The object produced by the combine operation then replaces the object
that had been the editing target.
Reference Guide
429
Objects Combine statement
If you include the Into Target clause, and if the selected objects are from the same table as the
target object, MapInfo Professional deletes the rows corresponding to the selected objects.
If you include the Into Target clause, and if the selected objects are from a different table than the
target object, MapInfo Professional does not delete the selected objects. If you omit the Into Target
clause, MapInfo Professional combines the currently-selected objects without involving the current
editing target (if there is an editing target). The rows corresponding to the selected objects are
deleted, and a new row is added to the table, containing the object produced by the combine
operation.
The Data clause controls data aggregation. (For an introduction to data aggregation, see the
description of the Objects > Combine operation in the MapInfo Professional Reference.) The Data
clause includes a comma-separated list of assignments. You can assign any expression to a
column, assuming the expression is of the correct data type (numeric, string, etc.).
The following table lists the more common types of column assignments:
Expression
Description
col_name = col_name
The column contents are not altered.
col_name = value
MapBasic stores the hard-coded value in the column of
the result object.
col_name = Sum( col_name )
Used only for numeric columns. The column in the result
object contains the sum of the column values of all
objects being combined.
col_name = Avg( col_name )
Used only for numeric columns. The column in the result
object contains the average of column values of all
objects in the group.
col_name = WtAvg( colname,
wtcolname )
Used only for numeric columns. MapInfo Professional
performs weighted averaging, averaging all of the
col_name column values, and weighting the average
calculation based on the contents of the wt_colname
column.
The Data clause can contain an assignment for every column in the table. If the Data clause only
includes assignments for some of the columns, MapBasic assigns blank values to those columns
that are not listed in the Data clause. If you omit the Data clause entirely, but you include the Into
Target clause, then MapInfo Professional retains the target object's original column values.
If you omit both the Data clause and the Into Target clause, then the object produced by the
combine operation is stored in a new row, and MapInfo Professional assigns blank values to all of
the columns of the new row.
See Also
Combine( ) function, Set Target statement
430
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Objects Disaggregate statement
Purpose
Breaks an object into its component parts.
Syntax
Objects Disaggregate [ Into Table name ]
[ All | Collection ]
[ Data column_name = expression [ , column_name = expression ... ]
name is a string representing the name of a table to store the disaggregated objects.
column_name is a string representing the name of a column in the table being modified.
expression is an expression used to determine what is placed into the column_name columns.
Description
If an object contains multiple entities, then a new object is created in the output table for each entity.
By default, any multi-part object will be divided into its atomic parts. A Region object will be broken
down into some number of region objects, depending on the All flag. If the All flag is present, then
the Region will produce a series of single polygon Region objects, one object for each polygon
contained in the original object. Holes (interior boundaries) will produce solid single polygon Region
objects. If the All flag is not present, then Holes will be retained in the output objects. For example, if
an input Region contains three polygons, and one of those polygons is a Hole in another polygon,
then the output will be two Region objects, one of which will contain the hole.
Multiple-section Polyline objects will produce new single-section Polyline objects. Multipoint objects
will produce new Point objects, one Point object per node from the input Multipoint.
Collections will be treated recursively. If a Collection contains a Region, then new Region objects will
be produced as described above, depending on the All switch. If the Collection contains a Polyline
object, the new Polyline objects will be produced for each section that exists in the input object. If a
Collection contains a Multipoint, then new Point objects will be produced, one Point object for each
node in the Mutlipoint.All other object types, including Points, Lines, Arcs, Rectangles, Rounded
Rectangles, and Ellipses, which are already single component objects, will be moved to the output
unchanged.
If a Region contains a single polygon, it will be passed unchanged to the output. If a Polyline object
contains a single section, it will be passed unchanged to the output. If a Multipoint object contains a
single node, the output object will be changed into a Point object containing that node. Arcs,
Rectangles, Rounded Rectangles, and Ellipses will be passed unchanged to the output. Other object
types, such as Text, will not be accepted by the Objects Disaggregate statement, and will produce
an error.
The Collection keyword will only break up Collection objects. If a Collection object contains a
Region, then that Region will be a new object on output. If a Collection object contains a Polyline,
then that Polyline will be a new object in the output. If a Collection object contains a Multipoint, then
Reference Guide
431
Objects Disaggregate statement
that Multipoint will be a new object in the output. This differs from the above functionality since the
output Region may contain multiple polygons, the output Polyline may contain multiple segments.
The functionality above will never produce a Multipoint object.
With the Collection keyword, all other object types, including Points, Multipoints, Lines, Polylines,
Arcs, Regions, Rectangles, Rounded Rectangles, and Ellipses, will be passed to the output
unchanged.
If no Into Table is provided, the currently editable table is used as the output table. The input objects
are taken from the current selection.
The optional Data clause controls what values are stored in the columns of the target objects. The
Data clause can contain a comma-separated list of column assignments. Each column assignment
can take one of the forms listed in the following table:
Assignment
Effect
col_name = col_name
Does not alter the value stored in the column.
col_name = value
Stores a specific value in the column. If the
column is a character column, the value can be a
string. If the column is a numeric column, the
value can be a number.
col_name = Proportion( col_name )
Used only for numeric columns; reduces the
number stored in the column in proportion to how
much of the object's area was erased.
The Data clause can contain an assignment for every column in the table. If the Data clause only
specifies assignments for some of the columns, blank values are assigned to those columns that are
not listed in the Data clause. If you omit the Data clause entirely, all columns are blanked out of the
target objects, storing zero values in numeric columns and blank values in character columns.
Example
Open Table "STATES.TAB" Interactive
Map From STATES
Set Map Layer 1 Editable On
select * from STATES
Objects Disaggregate Into Table STATES
See Also
Create Object statement
432
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Objects Enclose statement
Purpose
Creates regions that are formed from collections of polylines; corresponds to MapInfo Professional's
Objects > Enclose menu item.
Syntax
Objects Enclose
[ Into Table tablename]
[ Region ]
tablename is a string representing the name of the table you want to place objects in.
Description
Objects Enclose creates objects representing closures linear objects (lines, polylines, and arcs). A
new region is created for each enclosed polygonal area. Input objects are obtained from the current
selection. Unlike the Objects Combine statement, the Objects Enclose statement does not
remove the original input objects. No data aggregation is done.
The optional Region clause allows closed objects (regions, rectangles, rounded rectangles, and
ellipses) to be used as input to the Objects Enclose statement. The input regions will be converted
to Polylines for the purpose of this operation. The effects are identical to first converting any closed
objects to Polyline objects, and then performing the Objects Enclose operation. All input objects
must be linear or closed, and any other objects (i.e., points, multipoints, collections, and text) will
cause the operation to produce an error. If closed objects exist in the selection, and the Region
keyword is not present, then those objects will be ignored.
The Objects Enclose statement corresponds to MapInfo Professional’s Objects > Enclose menu
item. For an introduction to this operation, see the discussion of the Objects > Enclose menu item
in the MapInfo Professional Reference. To see a demonstration of the Objects Enclose statement,
run MapInfo Professional, open the MapBasic Window, and use the Objects > Combine command.
The optional Into Table clause places the objects created by this command into the table.
Otherwise, the output objects are placed in the same table that contains the input objects.
Example
This will select all the objects in a table called testfile, performs an Objects Enclose and stores the
resulting objects in a table called dump_file.
select * from testfile
Objects Enclose Into Table dump_file
See Also
Objects Check statement, Objects Combine statement
Reference Guide
433
Objects Erase statement
Objects Erase statement
Purpose
Erases any portions of the target object(s) that overlap the selection; corresponds to choosing
Objects > Erase.
Syntax
Objects Erase Into Target
[ Data column_name = expression [ , column_name = expression ... ]
column_name is a string representing the name of a column in the table being modified.
expression is an expression used to determine what is erased from the column_name columns.
Description
The Objects Erase statement erases part of (or all of) the objects that are currently designated as
the editing target. Using the Objects Erase statement is equivalent to choosing MapInfo
Professional's Objects > Erase menu item. For an introduction to using Objects > Erase, see the
MapInfo Professional Reference.
Objects Erase erases any parts of the target objects that overlap the currently selected objects. To
erase only the parts of the target objects that do not overlap the selection, use the Objects Intersect
statement.
Before you call Objects Erase, one or more closed objects (regions, rectangles, rounded
rectangles, or ellipses) must be selected, and an editing target must exist. The editing target may
have been set by the user choosing Objects > Set Target, or it may have been set by the MapBasic
Set Target statement.
For each Target object, one object will be produced for that portion of the target that lies outside all
cutter objects. If the Target lies inside cutter objects, then no object is produced for output.
The optional Data clause controls what values are stored in the columns of the target objects. The
Data clause can contain a comma-separated list of column assignments.
Each column assignment can take one of the forms listed in the following table:
Assignment
col_name = col_name
434
Effect
MapBasic does not alter the value stored in the
column.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Assignment
Effect
col_name = value
MapBasic stores a specific value in the column. If
it is a character column, the value can be a string;
if it is a numeric column, the value can be a
number.
col_name = Proportion( col_name )
Used only for numeric columns; MapBasic
reduces the number stored in the column in
proportion to how much of the object's area was
erased. So, if the operation erases half of an
area's object, the object's column value is
reduced by half.
The Data clause can contain an assignment for every column in the table. If the Data clause only
specifies assignments for some of the columns, MapBasic assigns blank values to those columns
that are not listed in the Data clause.
If you omit the Data clause entirely, MapBasic blanks out all columns of the target object, storing
zero values in numeric columns and blank values in character columns.
Example
In the following example, the Objects Erase statement does not include a Data clause. As a result,
MapBasic stores blank values in the columns of the target object(s). This example assumes that one
or more target objects have been designated, and one or more objects have been selected.
Objects Erase Into Target
In the next example, the Objects Erase statement includes a Data clause, which specifies
expressions for three columns (State_Name, Pop_1990, and Med_Inc_80). This operation assigns
the string “area remaining” to the State_Name column and specifies that the Pop_1990 column
should be reduced in proportion to the amount of the object that is erased. The Med_Inc_80 column
retains the value it had before the Objects Erase statement. The target objects' other columns are
blanked out.
Objects Erase Into Target
Data
State_Name = "area remaining",
Pop_1990 = Proportion( Pop_1990 ),
Med_Inc_80 = Med_Inc_80
See Also
Erase( ) function, Objects Intersect statement
Reference Guide
435
Objects Intersect statement
Objects Intersect statement
Purpose
Erases any portions of the target object(s) that do not overlap the selection; corresponds to choosing
Objects > Erase Outside.
Syntax
Objects Intersect Into Target
[ Data column_name = expression [ , column_name = expression ... ] ]
column_name is a string representing the name of a column in the table being modified.
expression is an expression used to determine what is erased from the column_name columns.
Description
The Objects Intersect statement erases part or all of the object(s) currently designated as the
editing target. Using the Objects Intersect statement is equivalent to choosing MapInfo
Professional's Objects > Erase Outside menu item. For an introduction to using Objects > Erase
Outside, see the MapInfo Professional Reference.
The optional Data clause controls what values are stored in the columns of the target objects. The
Data clause can contain a comma-separated list of column assignments. Each column assignment
can take one of the forms listed in the following table:
Assignment
Effect
col_name = col_name
MapBasic does not alter the value stored in the
column.
col_name = value
MapBasic stores a specific value in the column. If
the column is a character column, the value can
be a string; if the column is a numeric column, the
value can be a number.
col_name = Proportion( col_name )
Used only for numeric columns; MapBasic
reduces the number stored in the column in
proportion to how much of the object's area was
erased. Thus, if the operation erases half of the
area of an object, the object's column value is
reduced by half.
The Data clause can contain an assignment for every column in the table. If the Data clause only
specifies assignments for some of the columns, MapBasic assigns blank values to those columns
that are not listed in the Data clause. If you omit the Data clause entirely, MapBasic blanks out all
columns of the target objects, storing zero values in numeric columns and blank values in character
columns.
436
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The Objects Intersect statement is very similar to the Objects Erase statement, with one
important difference: Objects Intersect erases the parts of the target objects(s) that do not overlap
the current selection, while the Objects Erase statement erases the parts of the target object. For
each Target object, a new object is created for each area that intersects a cutter object. For
example, if a target object is intersected by three cutter objects, then three new objects will be
created. The parts of the target that lie outside all cutter objects will be discarded. For more
information, see Objects Erase statement on page 434.
Example
Objects Intersect Into Target
Data
Field2=Proportion(Field2)
See Also
Create Object statement, Overlap( ) function, Objects Erase statement
Objects Move statement
Purpose
Moves the objects obtained from the current selection within the input table.
Syntax
Objects Move
Angle angle
Distance distance
[ Units unit ]
[ Type { Spherical | Cartesian }]
angle is a value representing the angle to move the selected object.
distance is a number representing the distance to move the selected object.
unit is the distance unit of distance.
Description
Objects Move moves the objects within the input table. The source objects are obtained from the
current selection. The resulting objects replace the input objects. No data aggregation is performed
or necessary, since the data associated with the original source objects is unchanged.
The object is moved in the direction represented by angle, measured from the positive X-axis (east)
with positive angles being counterclockwise, and offset at a distance given by the distance
parameter. The distance is in the units specified by unit parameter, if present. If the Units clause is
not present, then the current distance unit is the default. By default, MapBasic uses miles as the
distance unit; to change this unit, use the Set Distance Units statement.
The optional Type sub-clause lets you specify the type of distance calculation used to create the
offset. If Spherical type is specified, then the calculation is done by mapping the data into a
Latitude/Longitude On Earth projection and using distance measured using Spherical distance
Reference Guide
437
Objects Offset statement
calculations. If Cartesian is specified, then the calculation is done by considering the data to be
projected to a flat surface and distances are measured using Cartesian distance calculations. If the
Type sub-clause is not present, then the Spherical distance calculation type is used. If the data is in
a Latitude/Longitude Projection, then Spherical calculations are used regardless of the Type setting.
If the data is in a NonEarth Projection, the Cartesian calculations are used regardless of the Type
setting.
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (for
example, the center of the bounding box), and then that value is converted from the input units into
the coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses
the fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
Objects Move Angle 45 Distance 100 Units "mi" Type Spherical
See Also
Objects Offset statement
Objects Offset statement
Purpose
Copies objects, obtained from the current selection, offset from the original objects.
Syntax
Objects Offset
[ Into Table intotable ]
Angle angle
Distance distance
[ Units unit ]
[ Type { Spherical | Cartesian }]
[ Data column = expression [, column = expression ... ]]
intotable is a string representing the table that the new values are copied to.
angle is a value representing the angle which to offset the selected objects.
distance is a number representing the distance to offset the selected objects.
unit is the distance unit of distance.
column is a string representing the column on which to perform the offset.
expression is an expression to calculate the offset for the column.
438
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
Objects Offset makes a new copy of objects offset from the original source objects. The source
objects are obtained from the current selection. The resulting objects are placed in the intotable, if
the Into clause is present. Otherwise, the objects are placed into the same table as the input objects
are obtained from (i.e., the base table of the selection).
The object is moved in the direction represented by angle, measured from the positive X-axis (east)
with positive angles being counterclockwise, and offset at a distance given by the distance
parameter. The distance is in the units specified by the unit parameter. If the Units clause is not
present, then the current distance unit is the default. By default, MapBasic uses miles as the
distance unit; to change this unit, use the Set Distance Units statement.
The optional Type sub-clause lets you specify the type of distance calculation used to create the
offset. If Spherical type is specified, then the calculation is done by mapping the data into a
Latitude/Longitude On Earth projection and using distance measured using Spherical distance
calculations. If Cartesian is specified, then the calculation is done by considering the data to be
projected to a flat surface and distances are measured using Cartesian distance calculations. If the
Type sub-clause is not present, then the Spherical distance calculation type is used. If the data is in
a Latitude/Longitude Projection, then Spherical calculations are used regardless of the Type setting.
If the data is in a NonEarth Projection, the Cartesian calculations are used regardless of the Type
setting.
If you specify a Data clause, the application performs data aggregation.
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (for
example, the center of the bounding box), and then that value is converted from the input units into
the coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses
the fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
Objects Offset Into Table c:\temp\table1.tbl Angle 45 Distance 100 Units
"mi" Type Spherical
See Also
Offset( ) function
Reference Guide
439
Objects Overlay statement
Objects Overlay statement
Purpose
Adds nodes to the target objects at any places where the target objects intersect the currently
selected objects; corresponds to choosing Objects > Overlay Nodes.
Syntax
Objects Overlay Into Target
Description
Before you call Objects Overlay, one or more objects must be selected, and an editing target must
exist. The editing target may have been set by the user choosing Objects > Set Target, or it may
have been set by the MapBasic Set Target statement. For more information, see the discussion of
Overlay Nodes in the MapInfo Professional Reference.
See Also
OverlayNodes( ) function, Set Target statement
Objects Pline statement
Purpose
Splits a single section polyline into two polylines.
Syntax
Objects Pline Split At Node index
[ Into Table name ]
[ Data column_name = expression [ , column_name = expression ... ]]
index is an integer of the index number of the node to split.
name is a string representing the name of the table to hold the new objects.
column_name is a string representing the name of the column where the new values are stored.
expression is an expression which is used to assign values to column_name.
Description
If an object is a single section polyline, then two new single section polyline objects are created in
the output table name. The Node index should be a valid MapBasic index for the polyline to be split.
If Node is a start or end node for the polyline, the operation is cancelled and an error message is
displayed.
The optional Data clause controls what values are stored in the columns of the output objects. The
Data clause can contain a comma-delimited list of column assignments. Each column assignment
can take one of the forms listed in the following table:
440
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Assignment
Effect
col_name = col_name
Does not alter the value stored in the column.
col_name = value
Stores a specific value in the column. If the column is a character
column the value can be a string; if the column is a numeric column,
the value can be a number.
The Data clause can contain an assignment for every column in the table. If the Data clause
specifies assignments for only some of the columns, blank values are assigned to those columns
that are not listed in the Data clause.
If you omit the Data clause entirely, all columns are blanked out of the target objects, storing zero
values in numeric columns and blank values in character columns.
Example
In the following partial example, the selected polyline is split at the specified node (node index of 12).
The unchanged values from each record of the selected polyline are inserted into the new records
for the split polyline.
Objects Pline Split At Node 12 Into Table WORLD Data
Country=Country,Capital=Capital,Continent=Continent,Numeric_code=Numeric_
code,FIPS=FIPS,ISO_2=ISO_2,ISO_3=ISO_3,Pop_1994=Pop_1994,Pop_Grw_Rt=Pop_G
rw_Rt,Pop_Male=Pop_Male,Pop_Fem=Pop_Fem...
See Also
ObjectLen( ) function, ObjectNodeX( ) function, ObjectNodeY( ) function, Objects
Disaggregate statement
Objects Snap statement
Purpose
Cleans the objects from the given table, and optionally performs various topology-related operations
on the objects, including snapping nodes from different objects that are close to each other into the
same location and generalization/thinning. The table may be the Selection table. All of the objects to
be cleaned must either be all linear (i.e., polylines and arcs) or all closed (i.e., regions, rectangles,
rounded rectangles, or ellipses). Mixed linear and closed objects cannot be cleaned in one
operation, and an error will result.
Syntax
Objects Snap From tablename
[ Tolerance [ Node node_distance ][ Vector vector_distance ]
[ Units unit_string] ]
[ Thin [ Bend bend_distance ][ Distance spacing_distance ]
[ Units unit_string ]]
[ Cull Area cull_area [ Units unit_string ]]]
Reference Guide
441
Objects Snap statement
tablename is a string representing the name of the table of the objects to be checked.
node_distance is a number representing a radius around the end points nodes of a polyline.
vector_distance is a number representing a radius used for internal nodes of polylines.
bend_distance is a number representing the co-linear tolerance of a series of nodes.
spacing_distance is a number representing the minimum distance a series of nodes in the same
object can be to each other without being removed.
unit_string is a string representing the distance units to be used.
cull_area is a number representing the threshold area within which polygons are culled.
unit_string is a string representing the area units to be used.
Description
The objects from the input tablename are checked for various data problems and inconsistencies,
such as self-intersections. Self-intersecting regions in the form of a figure 8 will be changed into a
region containing two polygons that touch each other at a single point. Regions containing spikes
have the spike portion removed. The resulting cleaned object replaces the original input object. If
any overlaps exist between the objects they are removed. Removal of overlaps generally consists of
cutting the overlapping portion out of one of the objects, while leaving it in the other object. The
region that contains the originally overlapping section consists of multiple polygons. One polygon
represents the non-overlapping portion, and a separate polygon represents each overlapping
section.
The Node and Vector Tolerances values snap nodes from different objects together, and can be
used to eliminate small overlaps and gaps between objects. The Units sub-clause of Tolerances
lets you specify a distance measurement name (such as “km” for kilometers) to apply to the Node
and Vector values. If the Units sub-clause is not present, then the Node and Vector values are
interpreted in MapBasic's current distance unit. By default, MapBasic uses miles as the distance
units; to change this unit, use the Set Distance Units statement.
The Node tolerance is a radius around the end point nodes of a polyline. If there are nodes from
other objects within this radius, then one or both of the nodes will be moved such that they will be in
the same location (i.e., they will be snapped together).
The Vector tolerance is a radius used for internal nodes of polylines. Its purpose is the same as the
Node tolerance, except it is used only for internal (non-end point) nodes of a polyline. Note that for
Region objects, there is no explicit concept of end point nodes, since the nodes form a closed loop.
For Region objects, only the Vector tolerance is used, and it is applied to all nodes in the object. The
Node tolerance is ignored for Region objects. For Polyline objects, the Node tolerance must be
greater than or equal to the Vector tolerance.
The Bend and Distance values can be used to help thin or generalize the input objects. This
reduces the number of nodes used in the object while maintaining the general shape of the object.
The Units sub-clause of Thin lets you specify a distance measurement name (such as “km” for
kilometers) to apply to the Bend and Distance values. If the Units sub-clause is not present, then
the Bend and Distance values are interpreted in MapBasic's current distance unit.
442
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The Bend tolerance is used to control how co-linear a series of nodes can be. Given three nodes,
connect all of the nodes in a triangle. Measure the perpendicular distance from the second node to
the line connecting the first and third nodes. If this distance is less than the Bend tolerance, then the
three nodes are considered co-linear, and the second node is removed from the object.
The Distance tolerance is used to eliminate nodes within the same object that are close to each
other. Measure the distance between two successive nodes in an object. If the distance between
them is less than the Distance tolerance, then one of the nodes can be removed.
The Cull Area value is used to eliminate polygons from regions that are smaller than the threshold
area. The Units sub-clause of Cull lets you specify an area measurement name (such as “sq km” for
square kilometers) to apply to the Area value. If the Units sub-clause is not present, then the Area
value is interpreted in MapBasic's current area unit. By default, MapBasic uses square miles as the
area unit; to change this unit, use the Set Area Units statement.
Note: For all of the distance and area values mentioned above, the type of measurement used is
always Cartesian. Please keep in mind the coordinate system that your data is in. A length
and area calculation in Longitude/Latitude calculated using the Cartesian method is not
mathematically precise. Ensure that you are working in a suitable coordinate system (a
Cartesian system) before applying the tolerance values.
Example
Open Table "STATES.TAB" Interactive
Map From STATES
Set Map Layer 1 Editable On
select * from STATES
Objects Snap From Selection Tolerance Node 3 Vector 3 Units "mi" Thin Bend
0.5 Distance 1 Units "mi" Cull Area 10 Units "sq mi"
See Also
Create Object statement, Overlap( ) function
Objects Split statement
Purpose
Splits target objects, using the currently-selected objects as a “cookie cutter”; corresponds to
choosing Objects > Split.
Syntax
Objects Split Into Target
[ Data column_name = expression [ , column_name = expression ... ]
column_name is a string representing the name of the column where the new values are stored.
expression is an expression which is used to assign values to column_name.
Reference Guide
443
Objects Split statement
Description
Use the Objects Split statement to split each of the target objects into multiple objects. Using
Objects Split is equivalent to choosing MapInfo Professional's Objects > Split menu item. For more
information on split operations, see the MapInfo Professional Reference.
Before you call Objects Split, one or more closed objects (regions, rectangles, rounded rectangles,
or ellipses) must be selected, and an editing target must exist. The editing target may have been set
by the user choosing Objects > Set Target, or it may have been set by the MapBasic Set Target
statement.
For each target object, a new object is created for each area that intersects a cutter object. For
example, if a target object is intersected by three cutter objects, then three new objects will be
created. In addition, a single object will be created for all parts of the target object that lie outside all
cutter objects. This is equivalent to performing both an Objects Erase statement and an Objects
Intersect statement (Objects > Erase Outside).
The optional Data clause controls what values are stored in the columns of the target objects. The
Data clause can contain a comma-separated list of column assignments. Each column assignment
can take one of the forms listed in the following table:
Assignment
Effect
col_name = col_name
MapBasic does not alter the value stored in the
column; each object resulting from the split
operation retains the original column value.
col_name = value
MapBasic stores a specific value in the column.
If the column is a character column, the value
can be a string; if the column is a numeric
column, the value can be a number. Each object
resulting from the split operation retains the
specified value.
col_name = Proportion( col_name )
Used only for numeric columns; MapInfo
Professional divides the original target object's
column value among the graphical objects
resulting from the split. Each object receives
“part of” the original column value, with larger
objects receiving larger portions of the numeric
values.
The Data clause can contain an assignment for every column in the table. If the Data clause only
specifies assignments for some of the columns, MapBasic assigns blank values to those columns
that are not listed in the Data clause.
If you omit the Data clause entirely, MapBasic blanks out all columns of the target objects, storing
zero values in numeric columns and blank values in character columns.
444
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
In the following example, the Objects Split statement does not include a Data clause. As a result,
MapBasic stores blank values in the columns of the target object(s).
Objects Split Into Target
In the next example, the statement includes a Data clause, which specifies expressions for three
columns (State_Name, Pop_1990, and Med_Inc_80). This first part of the Data clause assigns the
string “sub-division” to the State_Name column; as a result, “sub-division” will be stored in the
State_Name column of each object produced by the split. The next part of the Data clause specifies
that the target object's original Pop_1990 value should be divided among the objects produced by
the split. The third part of the Data clause specifies that each of the new objects should retain the
original value from the Med_Inc_80 column.
Objects Split Into Target
Data
State_Name = "sub-division",
Pop_1990 = Proportion( Pop_1990 ),
Med_Inc_80 = Med_Inc_80
See Also
Alter Object statement
Offset( ) function
Purpose
Returns a copy of the input object offset by the specified distance and angle.
Syntax
Offset( object, angle, distance, units )
object is the object being offset.
angle is the angle to offset the object.
distance is a number representing the distance to offset the object.
units is a string representing the unit in which to measure distance.
Return Value
Object
Description
Offset( ) produces a new object that is a copy of the input object offset by distance along angle (in
degrees with horizontal in the positive X-axis being 0 and positive being counterclockwise). The
units string, similar to that used for the ObjectLen( ) function or Perimeter( ) function, is the unit
Reference Guide
445
OffsetXY( ) function
for the distance value. The distance type used is Spherical unless the Coordinate System is
NonEarth. For NonEarth, Cartesian distance type is automatically used. The coordinate system
used is the coordinate system of the input object.
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (for
example, the center of the bounding box), and then that value is converted from the input units into
the coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses
the fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
Offset(Rect, 45, 100, "mi")
See Also
Objects Offset statement, OffsetXY( ) function
OffsetXY( ) function
Purpose
Returns a copy of the input object offset by the specified X and Y offset values.
Syntax
OffsetXY( object, xoffset, yoffset, units )
object is the object being offset.
xoffset and yoffset are numbers representing the distance along the x and y axes to offset the object.
units is a string representing the unit in which to measure distance.
Return Value
Object
Description
OffsetXY( ) produces a new object that is a copy of the input object offset by xoffset along the X-axis
and yoffset along the Y-axis. The units string, similar to that used for the ObjectLen( ) function or
Perimeter( ) function, is the unit for the distance values. The distance type used is Spherical unless
the coordinate system is NonEarth. For NonEarth, the Cartesian distance type is automatically used.
The coordinate system used is the coordinate system of the input object.
446
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
There are some considerations for Spherical measurements that do not hold for Cartesian
measurements. If you move an object that is in Lat/Long, the shape of the object remains the same,
but the area of the object will change. This is because you are picking one offset delta in degrees,
and the actual measured distance for a degree is different at different locations.
For the Offset functions, the actual offset delta is calculated at some fixed point on the object (for
example, the center of the bounding box), and then that value is converted from the input units into
the coordinate system's units. If the coordinate system is Lat/Long, the conversion to degrees uses
the fixed point. The actual converted distance measurement could vary at different locations on the
object. The distance from the input object and the new offset object is only guaranteed to be exact at
the single fixed point used.
Example
OffsetXY(Rect, 92, -22, "mi")
See Also
Offset( ) function
OnError statement
Purpose
Enables an error-handling routine.
Syntax
OnError Goto{ label | 0 }
label is a string representing a label within the same procedure or function.
Restrictions
You cannot issue an OnError statement through the MapBasic window.
Description
The OnError statement either enables an error-handling routine, or disables a previously enabled
error-handler. (An error-handler is a group of statements executed in the event of an error).
BASIC programmers should note that in the MapBasic syntax, OnError is a single word.
An OnError Goto label statement enables an error-handling routine. Following such an OnError
statement, if the application generates an error, MapBasic jumps to the label line specified. The
statements following the label presumably correct the error condition, warn the user about the error
condition, or both. Within the error-handling routine, use a Resume statement to resume program
execution.
Reference Guide
447
OnError statement
Once you have inserted error-handling statements in your program, you may need to place a flowcontrol statement (for example, Exit Sub statement or End Program statement) immediately
before the error handler's label. This prevents the program from unintentionally “falling through” to
the error handling statements, but it does not prevent MapBasic from calling the error handler in the
event of an error. See the example below.
An OnError Goto 0 statement disables the current error-handling routine. If an error occurs while
there is no error-handling routine, MapBasic displays an error dialog box, then halts the application.
Each error handler is local to a particular function or procedure. Thus, a sub procedure can define an
error handler by issuing a statement such as:
OnError Goto recover
(assuming that the same procedure contains a label called “recover” ). If, after executing the above
OnError statement, the procedure issues a Call statement to call another sub procedure, the
“recover” error handler is suspended until the program returns from the Call statement. This is
because each label (for example, “recover”) is local to a specific procedure or function. With this
arrangement, each function and each sub procedure can have its own error handling.
Note: If an error occurs within an error-handling routine, your MapBasic program halts.
Example
OnError GoTo no_states
Open Table "states"
OnError GoTo no_cities
Open Table "cities"
Map From cities, states
after_mapfrom:
OnError GoTo 0
'
' ...
'
End Program
no_states:
Note "Could not open table States... no Map used."
Resume after_mapfrom
no_cities:
Note "City data not available..."
Map From states
Resume after_mapfrom
See Also
Err( ) function, Error statement, Error$( ) function, Resume statement
448
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Open Connection statement
Purpose
Creates a connection to an external geocode or Isogram service provided by a MapMarker or
Envinsa server.
Syntax
Open Connection Service
Geocode [ MapMarker | Envinsa ] | Isogram URL URLstring
[ User name_string [ Password pwd_string ] ]
[ Interactive [ On | Off ] ]
into variable var_name
URLString is a string representing a valid URL. URLString must be a valid URL to a routing service if
you are specifying Isogram, or to a geocoding service if you are specifying Geocode.
name_string is a string representing the user name for an Envinsa or MapMarker installation.
pwd_string is a string representing the password corresponding to user_name.
var_name is a string representing the variable which will hold the returned connection number.
Description
The Open Connection statement creates a connection to a Geocode or Isogram service. Each
statement must specify a service and provider to which the connection is being established. Since
the Isogram service is only provided by Envinsa no provider can be specified. If the service is
Geocode and no service provider is specified, Envinsa is assumed.
The Into variable keywords are required as var_name is the variable that holds the returned
connection number that is then passed to other statements, such as the Set Connection Geocode
statement, the Geocode statement, the Set Connection Isogram statement, and the Create
Object Isogram statement.
Interactive determines whether a username/password dialog box is shown if and only if the
credentials passed in for authentication are not adequate. With Interactive specified to Off, no
dialog box is displayed and the command fails if the authentication fails. With Interactive specified
as On, the dialog box appears if the authentication fails.
The default for the command is Interactive Off. That is, if the Interactive keyword is not used at all,
it is the same as Interactive Off. However, if Interactive is specified, it is equivalent to Interactive
On.
Examples
Note: All examples without the keyword MapMarker assume Envinsa.
The following example opens a geocoding connection without Interactive specified. Interactive is
set to Off by default.
Open Connection Into Variable CnctNum Service Geocode URL
"http://EnvinsaServices/LocationUtility/services/LocationUtility"
Reference Guide
449
Open File statement
This example opens a geocode connection and specifies Interactive as On.
Open Connection Into Variable CnctNum Service Geocode URL
"http://EnvinsaServices/LocationUtility/services/LocationUtility"
Interactive On
This example opens a geocode connection with a server that requires authentication.
dim baseURLVariable as String
baseURLVariable = "http://EnvinsaServices/”
Open Connection Service Geocode URL baseURLVariable +
"LocationUtility/services/LocationUtility" User "geocodeuser" Password
"GeoMe" Into Variable CnctNum
This example opens an Isogram connection with a server that requires authentication.
dim baseURLVariable as String
baseURLVariable = "http://EnvinsaServices/”
Open Connection Service IsoGram URL baseURLVariable +
"Route/services/Route" User "isogramuser" Password "ISOMe" Into Variable
CnctNum
See Also
Close Connection statement, Set Connection Geocode statement, Set Connection Isogram
statement
Open File statement
Purpose
Opens a file for input/output.
Syntax
Open File filespec
[ For { Input | Output | Append | Random | Binary } ]
[ Access { Read | Write | Read Write } ]
As [ # ] filenum
[ Len = recordlength ]
[ ByteOrder { LOWHIGH | HIGHLOW } ]
[ CharSet char_set ]
filespec is a string representing the name of the file to be opened.
filenum is an integer number to associate with the open file; this number is used in subsequent
operations (for example, Get statement or Put statement).
recordlength identifies the number of characters per record, including any end-of-line markers used;
applies only to Random access.
char_set is the name of a character set; see CharSet clause on page 126.
Restrictions
You cannot issue an Open File statement through the MapBasic window.
450
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
The Open File statement opens a file, so that MapBasic can read information from and/or write
information to the file.
In MapBasic, there is an important distinction between files and tables. MapBasic provides one set
of statements for using tables (for example, Open Table statement, Fetch statement, and Select
statement) and another set of statements for using other files in general (for example, Open File,
Get statement, Put statement, Input # statement, Print # statement).
The For clause specifies what type of file i/o to perform: Sequential, Random, or Binary. Each type
of i/o is described below. If you omit the For clause, the file is opened in Random mode.
Sequential File I/O
If you are going to read a text file that is variable-length (for example, one line is 55 characters long,
and the next is 72 characters long, etc.), you should specify a Sequential mode: Input, Output, or
Append.
If you specify the For Input clause, you can read from the file by issuing an Input # statement and
a Line Input # statement.
If you specify the For Output clause or the For Append clause, you can write to the file by issuing a
Print # statement and a Write # statement.
If you specify For Input, the Access clause may only specify Read; conversely, if you specify For
Output, the Access clause may only specify Write.
Do not specify a Len clause for files opened in any of the Sequential modes.
Random File I/O
If the text file you are going to read is fixed-length (for example, every line is 80 characters long), you
can access the file in Random mode, by specifying the clause: For Random.
When you open a file in Random mode, you must provide a Len = recordlength clause to specify
the record length. The recordlength value should include any end-of-line designator, such as a
carriage-return line-feed sequence.
When using Random mode, you can use the Access clause to specify whether you intend to Read
from the file, Write to the file, or do both (Read Write). After opening a file in Random mode, use
the Get statement and the Put statement to read from, and write to, the file.
Binary File I/O
In Binary access, MapBasic converts MapBasic variables to binary values when writing, and
converts from binary values when reading. Storing numerical data in a Binary file is more compact
than storing Binary data in a text file; however, Binary files cannot be displayed or printed directly, as
can text files.
To open a file in Binary mode, specify the clause: For Binary.
Reference Guide
451
Open Report statement
When using Binary mode, you can use the Access clause to specify whether you intend to Read
from the file, Write to the file, or do both (Read Write). After opening a file in Binary mode, use the
Get statement and the Put statement to read from, and write to, the file.
Do not specify a Len clause or a CharSet clause for files opened in Binary mode.
Controlling How the File Is Interpreted
The CharSet clause specifies a character set. The char_set parameter should be a string constant,
such as “WindowsLatin1”. If you omit the CharSet clause, MapInfo Professional uses the default
character set for the hardware platform that is in use at run-time. Note that the CharSet clause only
applies to files opened in Input, Output, or Random modes. See CharSet clause on page 126 for
more information.
If you open a file for Random or Binary access, the ByteOrder clause specifies how numbers are
stored within the file.
If your application only runs on one hardware platform, you do not need to be concerned with byte
order; MapBasic simply uses the byte-order scheme that is “native” to that platform. However, if you
intend to read and write binary files, and you need to transport the files across multiple hardware
platforms, you may need to use the ByteOrder clause.
Examples
Open File "cxdata.txt" For INPUT As #1
Open File "cydata.txt" For RANDOM As #2 Len=42
Open File "czdata.bin" For BINARY As #3
See Also
Close File statement, EOF( ) function, Get statement, Input # statement, Open Table
statement, Print # statement, Put statement, Write # statement, CharSet clause
Open Report statement
Purpose
Loads a report into the Crystal Report Designer module.
Syntax
Open Report reportfilespec
reportfilespec is a string representing a full path and file name for an existing report file.
See Also
Create Report From Table statement
452
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Open Table statement
Purpose
Opens a MapInfo Professional table for input/output.
Syntax
Open
[
[
[
Table filename [ As tablename ]
Hide ] [ ReadOnly ] [ Interactive ] [ Password pwd ]
NoIndex ] [ View Automatic ] [ DenyWrite ]
VMGrid | VMRaster | VMDefault ]
filename is a string which specifies which MapInfo table to open.
tablename is a string representing an “alias” name by which the table should be identified.
pwd is a string representing the database-level password for the database, to be specified when
database security is turned on. Applies to Access tables only.
VMGrid treats all VM GRD files as Grid Layers when opened.
VMRaster treats all VM GRD files as Raster Layers when opened.
VMDefault treats GRD as Raster or Grid depending on existence of RasterStyle 6 1 tag in TAB file.
Description
The Open Table statement opens an existing table. The effect is comparable to the effect of an enduser choosing File > Open and selecting a table to open. A table must be opened before MapInfo
Professional can process that table in any way.
Note: The name of the file to be opened (specified by the filespec parameter) must correspond to a
table which already exists; to create a new table from scratch, use the Create Table
statement. The Open Table statement only applies to MapInfo tables; to use files that are in
other formats, use the Register Table statement and the Open File statement.
If the statement includes an As clause, MapInfo Professional opens the table under the “alias” table
name indicated by the tablename parameter, rather than by the actual table name. This affects the
way the table name appears in lists, such as the list that appears when a user chooses File > Close.
Furthermore, when an Open Table statement specifies an alias table name, subsequent MapBasic
table operations (for example, a Close Table statement) must refer to the alias table name, rather
than the permanent table name. An alias table name remains in effect until the table is closed.
Opening a table under an alias does not have the effect of permanently renaming the table.
If the statement includes the Hide clause, the table will not appear in any dialog boxes that display
lists of open tables (for example, the File > Close dialog box). Use the Hide clause if you need to
open a table that should remain hidden to the user. If the statement includes the ReadOnly clause,
the user is not allowed to edit the table.
The optional Interactive keyword tells MapBasic to prompt the user to locate the table if it is not
found at the specified path. The Interactive keyword is useful in situations where you do not know
the location of the user's files. If the statement includes the NoIndex keyword, the MapInfo index will
not be re-built for an MS Access table when opened.
Reference Guide
453
Open Table statement
View Automatic is an optional clause to the Open Table statement that allows the MapInfo table,
workspace or application file associated with a hotlink object to launch in the currently running
instance of MapInfo Professional or start a new instance if none is running. If View Automatic is
present, after opening the table, MapInfo Professional will either add it to an existing mapper, open a
new mapper, or open a browser. This is especially useful with the HotLinks feature.
DenyWrite is an optional clause for MS Access tables only, If it is specified, other users will not be
able to edit the table. If another user already has read-write access to the table, the Open Table
command will fail.
Attempting to open two tables that have the same name
MapInfo Professional can open two separate tables that have the same name. In such cases,
MapInfo Professional needs to open the second table under a special name, to avoid conflicts.
Depending on whether the Open Table statement includes the Interactive keyword, MapBasic
either assigns the special table name automatically, or displays a dialog box to let the user select a
special table name.
For example, a user might keep two copies of a table called “Sites”, one copy in a directory called
2006 (for example, “C:\2006\SITES.TAB”) and another, perhaps newer copy of the table in a
different directory (for example, “C:\2005\SITES.TAB”). When the user (or an application) opens the
first Sites table, MapInfo Professional opens the table under its default name (“Sites”). If an
application issues an Open Table statement to open the second Sites table, MapInfo Professional
automatically opens the second table under a modified name (for example, “Sites_2”) to distinguish
it from the first table. Alternately, if the Open Table statement includes the Interactive clause,
MapInfo Professional displays a dialog box to let the user select the alternate name.
Regardless of whether the Open Table statement specifies the Interactive keyword, the result is
that a table may be opened under a non-default name. Following an Open Table statement, issue
the function call TableInfo(0, TAB_INFO_NAME) to determine the name with which MapInfo
Professional opened the table.
Attempting to open a table that is already open
If a table is already open, and an Open Table As statement tries to re-open the same table under a
new name, MapBasic generates an error code. A single table may not be open under two different
names simultaneously.
However, if a table is already open, and then an Open Table statement tries to re-open that table
without specifying a new name, MapBasic does not generate an error code. The table simply
remains open under its current name.
Example
The following example opens the table STATES.TAB, then displays the table in a Map window.
Because the Open Table statement uses an As clause to open the table under an alias (USA), the
Map window's title bar will say “USA Map” rather than “States Map.”
Open Table "States" As USA
Map From USA
454
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The next example follows an Open Table statement with a TableInfo( ) function call. In the unlikely
event that a separate table by the same name (States) is already open when you run the program
below, MapBasic will open “C:STATES.TAB” under a special alias (for example, “STATES_2”). The
TableInfo( ) function call returns the alias under which the “C:STATES.TAB” table was opened.
Include "MAPBASIC.DEF"
Dim s_tab As String
Open Table "C:states"
s_tab = TableInfo(0, TAB_INFO_NAME)
Browse * From s_tab
Map From tab
See Also
Close Table statement, Create Table statement, Delete statement, Fetch statement, Insert
statement, TableInfo( ) function, Update statement
Open Window statement
Purpose
Opens or displays a window.
Syntax
Open Window window_name
window_name is a string representing a window name (for example, Ruler) or window code (for
example, WIN_RULER).
Description
The Open Window statement displays an MapInfo Professional window. For example, the following
statement displays the statistics window, as if the user had chosen Options > Show Statistics
Window.
Open Window Statistics
The window_name parameter should be one of the window names from the table below.
Window Name
Window Description
MapBasic
The MapBasic window. You also can refer to this window by its define code
from MAPBASIC.DEF (WIN_MAPBASIC).
Statistics
The Statistics window (WIN_STATISTICS).
Legend
The Theme Legend window (WIN_LEGEND).
Info
The Info tool window (WIN_INFO).
Ruler
The Ruler tool window (WIN_RULER).
Reference Guide
455
Overlap( ) function
Window Name
Window Description
Help
The Help window (WIN_HELP).
Message
The Message window used by the Print statement (WIN_MESSAGE).
TableList
A dialog box that displays a list of currently opened tables.
Note: This dialog box is not strictly a window so does not have an entry in
MAPBASIC.DEF
You cannot open a document window (Map, Graph, Browse, Layout) through the Open Window
statement. There is a separate statement for opening each type of document window (see the Map
statement, Graph statement, Browse statement, Layout statement, and Create Redistricter
statement).
See Also
Close Window statement, Print statement, Set Window statement
Overlap( ) function
Purpose
Returns an object representing the geographic intersection of two objects; produces results similar
to MapInfo Professional's Objects > Erase Outside command.
Syntax
Overlap( object1, object2 )
object1 is an object; it cannot be a point or text object.
object2 is an object; it cannot be a point or text object.
Return Value
An object that is the geographic intersection of object1 and object2.
Description
The Overlap( ) function calculates the geographic intersection of two objects (the area covered by
both objects), and returns an object representing that intersection.
MapBasic retains all styles (color, etc.) of the original object1 parameter; then, if necessary,
MapBasic applies the current drawing styles.
If one of the objects is linear (for example, a polyline) and the other object is closed (for example, a
region), Overlap( ) returns the portion of the linear object that is covered by the closed object.
See Also
AreaOverlap( ) function, Erase( ) function, Objects Intersect statement
456
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
OverlayNodes( ) function
Purpose
Returns an object based on an existing object, with new nodes added at points where the object
intersects a second object.
Syntax
OverlayNodes( input_object, overlay_object )
input_object is an object whose nodes will be included in the output object; it may not be a point or
text object.
overlay_object is an object that will be intersected with input_object; it may not be a point or text
object.
Return Value
A region object or a polyline object.
Description
The OverlayNodes( ) function returns an object that contains all the nodes in input_object plus
nodes at all locations where the input_object intersects with the overlay_object.
If the input_object is a closed object (region, rectangle, rounded rectangle, or ellipse),
OverlayNodes( ) returns a region object. If input_object is a linear object (line, polyline, or arc),
OverlayNodes( ) returns a polyline.
The object returned retains all styles (color, etc.) of the original input_object.
To determine whether the OverlayNodes( ) function added any nodes to the input_object, use the
ObjectInfo( ) function to count the number of nodes (OBJ_INFO_NPNTS). Even if two objects do
intersect, the OverlayNodes( ) function does not add any nodes if input_object already has nodes at
the points of intersection.
See Also
Objects Overlay statement
Pack Table statement
Purpose
Provides the functionality of MapInfo Professional's Table > Maintenance > Pack Table command.
Syntax
Pack Table table { Graphic | Data | Graphic Data } [ Interactive ]
table is a string representing the name of an open table that does not have unsaved changes.
Reference Guide
457
Pack Table statement
Description
To pack a table's data, include the optional Data keyword. When you pack a table's data, MapInfo
Professional physically deletes any rows that had been flagged as “deleted.”
To pack a table's graphical objects, include the optional Graphic keyword. Packing the graphical
objects removes empty space from the map file, resulting in a smaller table. However, packing a
table's graphical objects may cause editing operations to be slower.
The Pack Table statement can include both the Graphic keyword and the Data keyword, and it
must include at least one of the keywords.
A Pack Table statement may cause map layers to be removed from a Map window, possibly causing
the loss of themes or cosmetic objects.
If you include the Interactive keyword, MapInfo Professional prompts the user to save themes
and/or cosmetic objects (if themes or cosmetic objects are about to be lost). This statement cannot
pack linked tables. Also, this statement cannot pack a table that has unsaved edits. To save edits,
use the Commit Table statement.
Note: Packing a table can invalidate custom labels that are stored in workspaces. Suppose you
create custom labels and save them in a workspace. If you delete rows from your table and
pack the table, you may get incorrect labels the next time you load the workspace. (Within a
workspace, custom labels are stored with respect to row ID numbers; when you pack a table,
you change the table's row ID numbers, possibly invalidating custom labels stored in
workspaces.) If you only delete rows from the end of the table (i.e., from the bottom of the
Browser window), packing will not invalidate the custom labels.
Packing Access Tables
The Pack Table statement saves a copy of the original Microsoft Access table without the column
types that MapInfo Professional does not support. If a Microsoft Access table has MEMO, OLE, or
LONG BINARY type columns, those columns are lost during a pack.
Example
Pack Table parcels Data
See Also
Open Table statement
458
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
PathToDirectory$( ) function
Purpose
Returns only the specified file's directory.
Syntax
PathToDirectory$( filespec )
filespec is a string expression representing a full file specification.
Return Value
String
Description
The PathToDirectory$( ) function returns just the “directory” component from a full file specification.
A full file specification can include a directory and a filename. The file specification
C:\MAPINFO\DATA\WORLD.TAB includes the directory “C:\MAPINFO\DATA\”.
Example
Dim s_filespec, s_filedir As String
s_filespec = "C:\MAPINFO\DATA\STATES.TAB"
s_filedir = PathToDirectory$(s_filespec)
' s_filedir now contains the string "C:\MAPINFO\DATA\"
See Also
PathToFileName$( ) function, PathToTableName$( ) function
PathToFileName$( ) function
Purpose
Returns just the file name from a specified file.
Syntax
PathToFileName$( filespec )
filespec is a string expression representing a full file specification.
Return Value
String
Reference Guide
459
PathToTableName$( ) function
Description
The PathToFileName$( ) function returns just the “filename” component from a full file specification.
A full file specification can include a directory and a filename. The PathToFileName$( ) function
returns the file's name, including the file extension if there is one.
The file specification C:\MAPINFO\DATA\WORLD.TAB includes a directory (“C:\MAPINFO\DATA\”)
and a filename (“WORLD.TAB”).
Example
Dim s_filespec, s_filename As String
s_filespec = "C:\MAPINFO\DATA\STATES.TAB"
s_filename = PathToFileName$(s_filespec)
' filename now contains the string "STATES.TAB"
See Also
PathToDirectory$( ) function, PathToTableName$( ) function
PathToTableName$( ) function
Purpose
Returns a string representing a table alias (such as “_1995_Data”) from a complete file specification
(such as “C:\MapInfo\Data\1995 Data.tab”).
Syntax
PathToTableName$( filespec )
filespec is a string expression representing a full file specification.
Return Value
String, up to 31 characters long.
Description
Given a full file name that identifies a table's .TAB file, this function returns a string that represents
the table's alias. The alias is the name by which a table appears in the MapInfo Professional user
interface (for example, on the title bar of a Browser window).
To convert a file name to a table alias, MapInfo Professional removes the directory path from the
beginning of the string and removes “.TAB” from the end of the string. Any special characters (for
example, spaces or punctuation marks) are replaced with the underscore character (_). If the table
name starts with a number, MapInfo Professional inserts an underscore at the beginning of the alias.
If the resulting string is longer than 31 characters, MapInfo Professional trims characters from the
end; aliases cannot be longer than 31 characters.
460
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Note that a table may sometimes be open under an alias that differs from its default alias. For
example, the following Open Table statement uses the optional As clause to force the World table
to use the alias “Earth”:
Open Table "C:\MapInfo\Data\World.tab" As Earth
Furthermore, if the user opens two tables that have identical names but different directory locations,
MapInfo Professional assigns the second table a different alias, so that both tables can be open at
once. In either of these situations, the “default alias” returned by PathToTableName$( ) might not
match the alias under which the table is currently open. To determine the alias under which a table
was actually opened, call the TableInfo( ) function with the TAB_INFO_NAME code.
Example
Dim s_filespec, s_tablename As String
s_filespec = "C:\MAPINFO\DATA\STATES.TAB"
s_tablename = PathToTableName$(s_filespec)
' s_tablename now contains the string "STATES"
See Also
PathToDirectory$( ) function, PathToFileName$( ) function, TableInfo( ) function
Pen clause
Purpose
Specifies a line style for graphic objects.
Syntax
Pen pen_expr
pen_expr is a Pen expression, for example, MakePen( width, pattern, color )
Description
The Pen clause specifies a line style—in other words, a set of thickness, pattern, and color settings
that dictate the appearance of a line or polyline object.
The Pen clause is not a complete MapBasic statement. Various object-related statements, such as
the Create Line statement, let you include a Pen clause to specify an object's line style. The
keyword Pen may be followed by an expression which evaluates to a Pen value. This expression
can be a Pen variable:
Pen pen_var
or a call to a function (for example, the CurrentPen( ) function or the MakePen( ) function) which
returns a Pen value:
Pen MakePen(1, 2, BLUE)
Reference Guide
461
Pen clause
With some MapBasic statements (for example, the Set Map statement), the keyword Pen can be
followed immediately by the three parameters that define a Pen style (width, pattern, and color)
within parentheses:
Pen(1, 2, BLUE)
Some MapBasic statements take a Pen expression as a parameter (for example, the name of a Pen
variable), rather than a full Pen clause (the keyword Pen followed by the name of a Pen variable).
The Alter Object statement is one example.
The following table summarizes the components that define a Pen:
Component
462
Description
width
Integer value, usually from 1 to 7, representing the thickness of the line (in
pixels). To create an invisible line style, specify a width of zero, and use a pattern
value of 1 (one).
pattern
Integer value from 1 to 118; see table below. Pattern 1 is invisible.
color
Integer RGB color value; see RGB( ) function on page 501.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The available pen patterns appear in the figure below.
Example
Include "MAPBASIC.DEF"
Dim cable As Object
Create Line
Into Variable cable
(73.5, 42.6) (73.67, 42.9)
Pen MakePen(1, 2, BLACK)
See Also
Alter Object statement, CreateLine( ) function, Create Pline statement, CurrentPen( ) function,
MakePen( ) function, RGB( ) function, Set Style statement
Reference Guide
463
PenWidthToPoints( ) function
PenWidthToPoints( ) function
Purpose
Returns the point size for a given pen width.
Syntax
PenWidthToPoints( penwidth )
penwidth is an integer greater than 10 representing the pen width.
Return Value
Float
Description
The PenWidthToPoints( ) function takes a pen width and returns the point size for that pen. The
pen width for a line style may be returned by the StyleAttr( ) function. The pen width returned by
the StyleAttr( ) function may be in points or pixels. Pen widths of less than ten are in pixels. Any
pen width of ten or greater is in points. PenWidthToPoints( ) only returns values for pen widths that
are in points. To determine if pen widths are in pixels or points, use the IsPenWidthPixels( )
function.
Example
Include "MAPBASIC.DEF"
Dim CurPen As Pen
Dim Width As Integer
Dim PointSize As Float
CurPen = CurrentPen( )
Width = StyleAttr(CurPen, PEN_WIDTH)
If Not IsPenWidthPixels(Width) Then
PointSize = PenWidthToPoints(Width)
End If
See Also
CurrentPen( ) function, IsPenWidthPixels( ) function, MakePen( ) function, Pen clause,
PointsToPenWidth( ) function, StyleAttr( ) function
464
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Perimeter( ) function
Purpose
Returns the perimeter of a graphical object.
Syntax
Perimeter( obj_expr, unit_name )
obj_expr is an object expression.
unit_name is a string representing the name of a distance unit (for example, “km”).
Return Value
Float
Description
The Perimeter( ) function calculates the perimeter of the obj_expr object. The Perimeter( ) function
is defined for the following object types: ellipses, rectangles, rounded rectangles, and polygons.
Other types of objects have perimeter measurements of zero.
The Perimeter( ) function returns a length measurement in the units specified by the unit_name
parameter; for example, to obtain a length in miles, specify “mi” as the unit_name parameter. See
Set Distance Units statement on page 592 for the list of valid unit names.
The Perimeter( ) function returns approximate results when used on rounded rectangles. MapBasic
calculates the perimeter of a rounded rectangle as if the object were a conventional rectangle. For
the most part, MapInfo Professional performs a Cartesian or Spherical operation. Generally, a
spherical operation is performed unless the coordinate system is nonEarth, in which case, a
Cartesian operation is performed.
Example
The following example shows how you can use the Perimeter( ) function to determine the perimeter
of a particular geographic object.
Dim perim As Float
Open Table "world"
Fetch First From world
perim = Perimeter(world.obj, "km")
' The variable perim now contains
' the perimeter of the polygon that's attached to
' the first record in the World table.
You can also use the Perimeter( ) function within the Select statement. The following Select
statement extracts information from the States table, and stores the results in a temporary table
called Results.
Reference Guide
465
PointsToPenWidth( ) function
Because the Select statement includes the Perimeter( ) function, the Results table will include a
column showing each state's perimeter.
Open Table "states"
Select state, Perimeter(obj, "mi")
From states
Into results
See Also
Area( ) function, ObjectLen( ) function, Set Distance Units statement
PointsToPenWidth( ) function
Purpose
Returns a pen width for a given point size.
Syntax
PointsToPenWidth( pointsize )
pointsize is a float value in tenths of a point.
Return Value
SmallInt
Description
The PointsToPenWidth( ) function takes a value in tenths of a point and converts that into a pen
width.
Example
Include "MAPBASIC.DEF"
Dim Width As Integer
Dim p_bus_route As Pen
Width = PointsToPenWidth(1.7)
p_bus_route = MakePen(Width, 9, RED)
See Also
CurrentPen( ) function, IsPenWidthPixels( ) function, MakePen( ) function, Pen clause,
PenWidthToPoints( ) function, StyleAttr( ) function
466
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
PointToMGRS$( ) function
Purpose
Converts an object value representing a point into a string representing an MGRS (Military Grid
Reference System) coordinate. Only point objects are supported.
Syntax
PointToMGRS$( inputobject )
inputobject is an object expression representing a point.
Description
MapInfo Professional automatically converts the input point from the current MapBasic coordinate
system to a Long/Lat (WGS84) datum before performing the conversion to an MGRS string.
However, by default, the MapBasic coordinate system is Long/Lat (no datum); using this as an
intermediate coordinate system can cause a significant loss of precision in the final output, since
datumless conversions are much less accurate. As a rule, the MapBasic coordinate system should
be set to either Long/Lat (WGS84) or to the coordinate system of the source data table, so that no
unnecessary intermediate conversions are performed. See Example 2 below.
Return Value
String
Examples
The following examples illustrate the use of both the MGRSToPoint( ) and PointToMGRS$( )
functions.
Example 1:
dim obj1 as Object
dim s_mgrs As String
dim obj2 as Object
obj1 = CreatePoint(-74.669, 43.263)
s_mgrs = PointToMGRS$(obj1)
obj2 = MGRSToPoint(s_mgrs)
Reference Guide
467
Print statement
Example 2:
Open Table "C:\Temp\MyTable.TAB" as MGRSfile
'
'
'
'
When using the PointToMGRS$( ) or MGRSToPoint( ) functions,
it is very important to make sure that the current MapBasic
coordsys matches the coordsys of the table where the
point object is being stored.
'Set the MapBasic coordsys to that of the table used
Set CoordSys Table MGRSfile
'Update a Character column (e.g. COL2) with MGRS strings from
'a table of points
Update MGRSfile
Set Col2 = PointToMGRS$(obj)
'Update two float columns (Col3 & Col4) with
'CentroidX & CentroidY information
'from a character column (Col2) that contains MGRS strings.
Update MGRSfile
Set Col3 = CentroidX(MGRSToPoint(Col2))
Update mgrstestfile ' MGRSfile
Set Col4 = CentroidY(MGRSToPoint(Col2))
Table MGRSfile
Close Table MGRSfile
See Also
MGRSToPoint( ) function
Print statement
Purpose
Prints a prompt or a status message in the Message window.
Syntax
Print message
message is a string expression.
Description
The Print statement prints a message to the Message window. The Message window is a special
window which does not appear in MapInfo's standard user interface. The Message window lets you
display custom messages that relate to a MapBasic program. You could use the Message window to
468
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
display status messages (“Record deleted”) or prompts for the user (“Select the territory to
analyze.”). To set the font for the Message window, use the Set Window statement. A MapBasic
program can explicitly open the Message window through the Open Window statement.
If a Print statement occurs while the Message window is closed, MapBasic opens the Message
window automatically. The Print statement is similar to the Note statement, in that you can use
either statement to display status messages or debugging messages. However, the Note statement
displays a dialog box, pausing program execution until the user clicks OK. The Print statement
simply prints text to a window, without pausing the program. Each Print statement is printed to a
new line in the Message window. After you have printed enough messages to fill the Message
window, scroll buttons appear at the right edge of the window, to allow the user to scroll through the
messages.
To clear the Message window, print a string which includes the form-feed character (code 12):
Print Chr$(12) 'This statement clears the Message window
By embedding the line-feed character (code 10) in a message, you can force a single message to be
split onto two or more lines. The following Print statement produces a two-line message:
Print "Map Layers:" + Chr$(10) + " World, Capitals"
The Print statement converts each Tab character (code 09) to a space (code 32).
Example
The next example displays the Message window, sets the window's size (three inches wide by one
inch high), sets the window's font (Helvetica, bold, 10-point), and prints a message to the window.
Include "MAPBASIC.DEF" ' needed for color name 'BLUE'
Open Window Message ' open Message window
Set Window Message
Font ("Helv", 1, 10, BLUE) ' Helvetica bold...
Position (0.25, 0.25) ' place in upper left
Width 3.0 ' make window 3" wide
Height 1.0 ' make window 1" high
Print "MapBasic Dispatcher now on line"
Note: The buffer size for message window text has been doubled to 8191 characters.
See Also
Ask( ) function, Close Window statement, Note statement, Open Window statement, Set
Window statement
Print # statement
Purpose
Writes data to a file opened in a Sequential mode (Output or Append).
Syntax
Print # file_num [ , expr ]
Reference Guide
469
PrintWin statement
file_num is the number of a file opened through the Open File statement.
expr is an expression to write to the file.
Description
The Print # statement writes data to an open file. The file must be open and in a sequential mode
which allows output (Output or Append).
The file_num parameter corresponds to the number specified in the As clause of the Open File
statement.
MapInfo Professional writes the expression expr to a line of the file. To store a comma-separated list
of expressions in each line of the file, use the Write # statement instead of Print #.
See Also
Line Input statement, Open File statement, Write # statement
PrintWin statement
Purpose
Prints an existing window.
Syntax
PrintWin [ Window window_id ][ Interactive ][ File output_filename ]
[ Overwrite ]
window_id is a window identifier.
output_filename is a string representing the name of an output file. If the output file already exists, an
error will occur, unless the Overwrite keyword is specified.
Description
The PrintWin statement prints a window.
If the statement includes the optional Window clause, MapBasic prints the specified window;
otherwise, MapBasic prints the active window.
The window_id parameter represents a window identifier; see the FrontWindow( ) function on
page 310 and the WindowInfo( ) function on page 709 for more information about obtaining
window identifiers.
If you include the Interactive keyword, MapInfo Professional displays the Print dialog box. If you
omit the Interactive keyword, MapInfo Professional prints the window automatically, without
displaying the dialog box.
470
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Examples
Example 1
Dim win_id As Integer
Open Table "world"
Map From world
win_id = FrontWindow( )
'
' knowing the ID of the Map window,
' the program could now print the map by
' issuing the statement:
'
PrintWin Window win_id Interactive
Example 2
PrintWin Window FrontWindow( ) File "c:\output\file.plt"
See Also
FrontWindow( ) function, Run Menu Command statement, WindowInfo( ) function
PrismMapInfo( ) function
Purpose
Returns properties of a Prism Map window.
Syntax
PrismMapInfo( window_id, attribute )
window_id is an integer window identifier.
attribute is an integer code, indicating which type of information should be returned.
Return Value
Float, logical, or string, depending on the attribute parameter.
Description
The PrismMapInfo( ) function returns information about a Prism Map window.
The window_id parameter specifies which Prism Map window to query. To obtain a window identifier,
call the FrontWindow( ) function immediately after opening a window, or call the WindowID( )
function at any time after the window's creation.
There are several numeric attributes that PrismMapInfo( ) can return about any given Prism Map
window. The attribute parameter tells the PrismMapInfo( ) function which Map window statistic to
return. The attribute parameter should be one of the codes from the following table; codes are
defined in MAPBASIC.DEF.
Reference Guide
471
PrismMapInfo( ) function
Attribute
472
Return Value
PRISMMAP_INFO_SCALE
Float result representing the PrismMaps scale
factor.
PRISMMAP_INFO_BACKGROUND
Integer result representing the background color,
see RGB( ) function on page 501.
PRISMMAP_INFO_LIGHT_X
Float result representing the x-coordinate of the
light in the scene.
PRISMMAP_INFO_LIGHT_Y
Float result representing the y-coordinate of the
Light in the scene.
PRISMMAP_INFO_LIGHT_Z
Float result representing the z-coordinate of the
Light in the scene.
PRISMMAP_INFO_LIGHT_COLOR
Integer result representing the Light color, see
RGB( ) function on page 501.
PRISMMAP_INFO_CAMERA_X
Float result representing the x-coordinate of the
Camera in the scene.
PRISMMAP_INFO_CAMERA_Y
Float result representing the y-coordinate of the
Camera in the scene.
PRISMMAP_INFO_CAMERA_Z
Float result representing the z-coordinate of the
Camera in the scene.
PRISMMAP_INFO_CAMERA_FOCAL_X
Float result representing the x-coordinate of the
Cameras FocalPoint in the scene.
PRISMMAP_INFO_CAMERA_FOCAL_Y
Float result representing the y-coordinate of the
Cameras FocalPoint in the scene.
PRISMMAP_INFO_CAMERA_FOCAL_Z
Float result representing the z-coordinate of the
Camera's FocalPoint in the scene.
PRISMMAP_INFO_CAMERA_VU_1
Float result representing the first value of the
ViewUp Unit Normal Vector.
PRISMMAP_INFO_CAMERA_VU_2
Float result representing the second value of the
ViewUp Unit Normal Vector.
PRISMMAP_INFO_CAMERA_VU_3
Float result representing the third value of the
ViewUp Unit Normal Vector.
PRISMMAP_INFO_CAMERA_VPN_1
Float result representing the first value of the View
Plane Unit Normal Vector.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Attribute
Return Value
PRISMMAP_INFO_CAMERA_VPN_2
Float result representing the second value of the
ViewPlane Unit Normal Vector.
PRISMMAP_INFO_CAMERA_VPN_3
Float result representing the third value of the
ViewPlane Unit Normal Vector.
PRISMMAP_INFO_CAMERA_CLIP_NEAR
Float result representing the cameras near clipping
plane.
PRISMMAP_INFO_CAMERA_CLIP_FAR
Float result representing the cameras far clipping
plane.
PRISMMAP_INFO_INFOTIP_EXPR
String for Infotip. Not previously documented.
Reference Guide
473
PrismMapInfo( ) function
Example
This example prints out all the state variables specific to the PrismMap window:
include "Mapbasic.def"
Print "PRISMMAP_INFO_SCALE: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_SCALE)
Print "PRISMMAP_INFO_BACKGROUND: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_BACKGROUND)
Print "PRISMMAP_INFO_UNITS: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_UNITS)
Print "PRISMMAP_INFO_LIGHT_X : " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_LIGHT_X )
Print "PRISMMAP_INFO_LIGHT_Y : " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_LIGHT_Y )
Print "PRISMMAP_INFO_LIGHT_Z: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_LIGHT_Z)
Print "PRISMMAP_INFO_LIGHT_COLOR: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_LIGHT_COLOR)
Print "PRISMMAP_INFO_CAMERA_X: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_X)
Print "PRISMMAP_INFO_CAMERA_Y : " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_Y )
Print "PRISMMAP_INFO_CAMERA_Z : " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_Z )
Print "PRISMMAP_INFO_CAMERA_FOCAL_X: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_FOCAL_X)
Print "PRISMMAP_INFO_CAMERA_FOCAL_Y: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_FOCAL_Y)
Print "PRISMMAP_INFO_CAMERA_FOCAL_Z: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_FOCAL_Z)
Print "PRISMMAP_INFO_CAMERA_VU_1: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VU_1)
Print "PRISMMAP_INFO_CAMERA_VU_2: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VU_2)
Print "PRISMMAP_INFO_CAMERA_VU_3: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VU_3)
Print "PRISMMAP_INFO_CAMERA_VPN_1: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VPN_1)
Print "PRISMMAP_INFO_CAMERA_VPN_2: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VPN_2)
Print "PRISMMAP_INFO_CAMERA_VPN_3: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_VPN_3)
Print "PRISMMAP_INFO_CAMERA_CLIP_NEAR: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_CLIP_NEAR)
Print "PRISMMAP_INFO_CAMERA_CLIP_FAR: " + PrismMapInfo(FrontWindow( ),
PRISMMAP_INFO_CAMERA_CLIP_FAR)
See Also
Create PrismMap statement, Set PrismMap statement
474
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
ProgramDirectory$( ) function
Purpose
Returns the directory path to where the MapInfo Professional software is installed.
Syntax
ProgramDirectory$( )
Return Value
String
Description
The ProgramDirectory$( ) function returns a string representing the directory path where the
MapInfo Professional software is installed.
Example
Dim s_prog_dir As String
s_prog_dir = ProgramDirectory$( )
See Also
HomeDirectory$( ) function, SystemInfo( ) function
ProgressBar statement
Purpose
Displays a dialog box with a Cancel button and a horizontal progress bar.
Syntax
ProgressBar status_message
Calling handler
[ Range n ]
status_message is a string value displayed as a message in the dialog box.
handler is the name of a Sub procedure.
n is a number at which the job is finished.
Restrictions
You cannot issue the ProgressBar statement through the MapBasic window.
Reference Guide
475
ProgressBar statement
Description
The ProgressBar statement displays a dialog box with a horizontal progress bar and a Cancel
button. The bar indicates the percentage of completion of a lengthy operation. The user can halt the
operation by clicking the Cancel button. Following the ProgressBar statement, a MapBasic
program can call CommandInfo(CMD_INFO_DLG_OK) to determine whether the operation finished
or whether the user cancelled first (see below).
The status_message parameter is a string value, such as “Processing data…”, which is displayed in
the dialog box.
The handler parameter is the name of a sub procedure in the same MapBasic program. As
described below, the sub procedure must perform certain actions in order for it to interact with the
ProgressBar statement.
The n parameter is a number, representing the count value at which the operation will be finished.
For example, if an operation needs to process 7,000 rows of a table, the ProgressBar statement
might specify 7000 as the n parameter. If no Range n clause is specified, the n parameter has a
default value of 100.
When a program issues a ProgressBar statement, MapBasic calls the specified handler sub
procedure. The sub procedure should perform a small amount of processing, specifically a few
seconds' worth of processing at most, and then it should end. At that time, MapBasic checks to see
if the user clicked the Cancel button. If the user did click Cancel, MapBasic removes the dialog box,
and proceeds with the statements which follow the ProgressBar statement (and thus, the lengthy
operation is never completed). Alternately, if the user did not click Cancel, MapBasic automatically
calls the handler sub procedure again. If the user never clicks Cancel, the ProgressBar statement
repeatedly calls the procedure until the operation is finished.
The handler procedure must be written in such a way that each call to the procedure performs only a
small percent of the total job. Once a ProgressBar statement has been issued, MapBasic will
repeatedly call the handler procedure until the user clicks Cancel or until the handler procedure
indicates that the procedure is finished. The handler indicates the job status by assigning a value to
the special MapBasic variable, also named ProgressBar.
If the handler assigns a value of negative one to the ProgressBar variable (ProgressBar = -1)
then MapBasic detects that the operation is finished, and accordingly halts the ProgressBar loop and
removes the dialog box. Alternately, if the handler procedure assigns a value other than negative
one to the ProgressBar variable (ProgressBar = 50) then MapBasic re-displays the dialog box's
“percent complete” horizontal bar, to reflect the latest figure of percent completion. MapBasic
calculates the current percent of completion by dividing the current value of the ProgressBar
variable by the Range setting, n. For example, if the ProgressBar statement specified the Range
clause Range 400 and if the current value of the ProgressBar variable is 100, then the current
percent of completion is 25%, and MapBasic will display the horizontal bar as being 25% filled.
The statements following the ProgressBar statement often must determine whether the
ProgressBar loop halted because the operation was finished, or because the user clicked the
Cancel button. Immediately following the ProgressBar statement, the function call
CommandInfo(CMD_INFO_DLG_OK) returns TRUE if the operation was complete, or FALSE if the
operation halted because the user clicked cancel.
476
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example demonstrates how a procedure can be written to work in conjunction with the
ProgressBar statement. In this example, we have an operation involving 600 iterations; perhaps we
have a table with 600 rows, and each row must be processed in some fashion. The main procedure
issues the ProgressBar statement, which then automatically calls the sub procedure, write_out.
The write_out procedure processes records until two seconds have elapsed, and then returns (so
that MapBasic can check to see if the user pressed Cancel). If the user does not press Cancel,
MapBasic will repeatedly call the write_out procedure until the entire task is done.
Include "mapbasic.def"
Declare Sub Main
Declare Sub write_out
Global next_row As Integer
Sub Main
next_row = 1
ProgressBar "Writing data..." Calling write_out Range 600
If CommandInfo(CMD_INFO_STATUS) Then
Note "Operation complete! Thanks for waiting."
Else
Note "Operation interrupted!"
End If
End Sub
Sub write_out
Dim start_time As Float
start_time = Timer( )
' process records until either (a) the job is done,
' or (b) more than 2 seconds elapse within this call
Do While next_row <= 600 And Timer( ) - start_time < 2
''''''''''''''''''''''''''''''''''''''''''
''' Here, we would do the actual work '''
''' of processing the file.
'''
''''''''''''''''''''''''''''''''''''''''''
next_row = next_row + 1
Loop
' Now figure out why the Do loop terminated: was it
' because the job is done, or because more than 2
' seconds have elapsed within this iteration?
If next_row > 600 Then
ProgressBar = -1 'tell caller "All Done!"
Else
ProgressBar = next_row 'tell caller "Partly done"
End If
End Sub
See Also
CommandInfo( ) function, Note statement, Print statement
Reference Guide
477
Proper$( ) function
Proper$( ) function
Purpose
Returns a mixed-case string, where only the first letter of each word is capitalized.
Syntax
Proper$( string_expr )
string_expr is a string expression.
Return Value
String
Description
The Proper$( ) function first converts the entire string_expr string to lower case, and then capitalizes
only the first letter of each word in the string, thus producing a result string with “proper”
capitalization. This style of capitalization is appropriate for proper names.
Example
Dim name, propername As String
name = "ed bergen"
propername = Proper$(name)
' propername now contains the string "Ed Bergen"
name = "ABC 123"
propername = Proper$(name)
' propername now contains the string "Abc 123"
name = "a b c d"
propername = Proper$(name)
' propername now contains the string "A B C D"
See Also
LCase$( ) function, UCase$( ) function
478
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
ProportionOverlap( ) function
Purpose
Returns a number that indicates what percentage of one object is covered by another object.
Syntax
ProportionOverlap( object1, object2 )
object1 is the bottom object (not text or points).
object2 is the top object (not text or points).
Return Value
A float value equal to AreaOverlap( object1, object2 ) / Area( object1 ).
See Also
AreaOverlap( ) function
Put statement
Purpose
Writes the contents of a MapBasic variable to an open file.
Syntax
Put [ # ] filenum, [ position,] var_name
filenum is the number of a file opened through an Open File statement.
position is the file position to write to (does not apply to sequential file access).
var_name is the name of a variable which contains the data to be written.
Description
The Put statement writes to an open file.
Note: If the Open File statement specified a sequential access mode (Output or Append), use
the Print # statement or the Write # statement instead of Put.
If the Open File statement specified Random file access, the Put statement's Position clause can
be used to indicate which record in the file to overwrite. When the file is opened, the file position
points to the first record of the file (record 1). If the Open File statement specified Binary file access,
one variable can be written at a time. The byte sequence written to the file depends on whether the
hardware platform's byte ordering; see the ByteOrder clause of the Open File statement on
page 450. The number of bytes written depends on the variable type, as summarized below:
Reference Guide
479
Randomize statement
Variable Type
Storage In File
Logical
One byte, either 0 or non-zero.
SmallInt
Two byte integer
Integer
Four byte integer
Float
Eight byte IEEE format
String
Length of string plus a byte for a 0 string terminator
Date
Four bytes: Small integer year, byte month, byte day
Other Variable types
Cannot be written.
The Position parameter sets the file pointer to a specific offset in the file. When the file is opened,
the position is initialized to 1 (the start of the file). As a Put is done, the position is incremented by
the number of bytes written. If the Position clause is not used, the Put simply writes to the current
file position. If the file was opened in Binary mode, the Put statement cannot specify a variablelength string variable; any string variable used in a Put statement must be fixed-length. If the file was
opened in Random mode, the Put statement cannot specify a fixed-length string variable which is
longer than the record length of the file.
See Also
EOF( ) function, Get statement, Open File statement, Print # statement, Write # statement
Randomize statement
Purpose
Initializes MapBasic's random number function.
Syntax
Randomize [ With seed ]
seed is an integer expression.
Description
The Randomize statement “seeds” the random number generator so that later calls to the Rnd( )
function produce random results. Without this statement before the first call to the Rnd( ) function,
the actual series of random numbers will follow a standard list. In other words, unless the program
includes a Randomize statement, the sequence of values returned by the Rnd( ) function will
follow the same pattern each time the application is run.
The Randomize statement is only needed once in a program and should occur prior to the first call
to the Rnd( ) function.
480
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
If you include the With clause, the seed parameter is used as the seed value for the pseudo-random
number generator. If you omit the With clause, MapBasic automatically seeds the pseudo-random
number generator using the current system clock. Use the With clause if you need to create
repeatable test scenarios, where your program generates repeatable sequences of “random”
numbers.
Example
Randomize
See Also
Rnd( ) function
RegionInfo( ) function
Purpose:
This function was created to determine the orientation of points in polygons -- whether they are
ordered clockwise, or counter-clockwise. The only attribute the function reports on is the
'direction' of the points in a specified polygon.
Syntax:
RegionInfo(object, REGION_INFO_IS_CLOCKWISE, polygon_num)
Only one parameter exists for this function:
REGION_INFO_IS_CLOCKWISE
1
Example:
If you were to select the state of Utah from States mapper and issued the following command in the
MapBasic window, you would get a result of F or False, since the nodes in the single region of Utah
are drawn in counter-clockwise order. Colorado's nodes are drawn in clockwise order and return T or
True.
print RegionInfo(selection.obj,1,1)
ReadControlValue( ) function
Purpose
Reads the current status of a control in the active dialog box.
Syntax
ReadControlValue( id_num )
id_num is an integer value indicating which control to read.
Reference Guide
481
ReadControlValue( ) function
Return Value
Integer, logical, string, Pen, Brush, Symbol, or Font, depending on the type of control
Description
The ReadControlValue( ) function returns the current value of one of the controls in an active dialog
box. A ReadControlValue( ) function call is only valid while there is an active dialog box; thus, you
may only call the ReadControlValue( ) function from within a dialog box control's handler
procedure.
The integer id_num parameter specifies which control MapBasic should read. If the id_num
parameter has a value of -1 (negative one), the ReadControlValue( ) function returns the value of
the last control which was operated by the user. To explicitly specify which control you want to read,
pass ReadControlValue( ) an integer ID that identifies the appropriate control.
Note: A dialog box control does not have a unique ID unless you include an ID clause in the Dialog
statement’s Control clause. Some types of dialog box controls have no readable values (for
example, static text labels).
The table below summarizes what types of values will be returned by various controls. Note that
special processing is required for handling MultiListBox controls: since the user can select more
than one item from a MultiListBox control, a program may need to call ReadControlValue( ) multiple
times to obtain a complete list of the selected items.
Control Type
482
ReadControlValue( ) Return Value
EditText
String, up to 32,767 bytes long, representing the current contents of the text
box; if the EditText is tall enough to accommodate multiple lines of text, the
string may include Chr$(10) values, indicating that the user entered linefeeds (for example, in Windows, by pressing Ctrl-Enter).
CheckBox
TRUE if the check box is currently selected, FALSE otherwise.
DocumentWindow
Integer that represents the HWND for the window control. This HWND
should be passed as the parent window handle in the Set Next Document
statement.
RadioGroup
SmallInt value identifying which button is selected (1 for the first button).
PopupMenu
SmallInt value identifying which item is selected (1 for the first item).
ListBox
SmallInt value identifying the selected list item (1 for the first, 0 if none).
BrushPicker
Brush value.
FontPicker
Font value.
PenPicker
Pen value.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Control Type
ReadControlValue( ) Return Value
SymbolPicker
Symbol value.
MultiListBox
Integer identifying one of the selected items. The user can select one or
more of the items in a MultiListBox control. Since ReadControlValue( ) can
only return one piece of information at a time, your program may need to call
ReadControlValue( ) multiple times in order to determine how many items
are selected.
The first call to ReadControlValue( ) returns the number of the first selected
list item (1 if the first list item is selected); the second call will return the
number of the second selected list item, etc. When ReadControlValue( )
returns zero, the list of selected items has been exhausted. Subsequent calls
to ReadControlValue( ) then begin back at the top of the list of selected
items. If ReadControlValue( ) returns zero on the first call, none of the list
items are selected.
Error Conditions
The ERR_FCN_ARG_RANGE error is generated if an argument is outside of the valid range.
The ERR_INVALID_READ_CONTROL error is generated if the ReadControlValue( ) function is
called when no dialog box is active.
Example
The following example creates a dialog box that asks the user to type a name in a text edit box. If the
user clicks OK, the application calls ReadControlValue( ) to read in the name that was typed.
Declare Sub Main
Declare Sub okhandler
Sub Main
Dialog
Title "Sign in, Please"
Control OKButton
Position 135, 120 Width 50
Title "OK"
Calling okhandler
Control CancelButton
Position 135, 100 Width 50
Title "Cancel"
Control StaticText
Position 5, 10
Title "Please enter your name:"
Control EditText
Position 55, 10 Width 160
Value "(your name here)"
Id 23 'arbitrary ID number
End Sub
Reference Guide
483
ReDim statement
Sub okhandler
' this sub is called when/if the user
' clicks the OK control
Note "Welcome aboard, " + ReadControlValue(23) + "!"
End Sub
See Also
Alter Control statement, Dialog statement, Dialog Preserve statement, Dialog Remove
statement
ReDim statement
Purpose
Re-sizes an array variable.
Syntax
ReDim var_name ( newsize ) [ , ... ]
var_name is a string representing the name of an existing local or global array variable.
newsize is an integer value dictating the new array size. The maximum value is 32,767.
Description
The ReDim statement re-sizes (or “re-dimensions”) one or more existing array variables. The
variable identified by var_name must have already been defined as an array variable through a Dim
statement or a Global statement.
The ReDim statement can increase or decrease the size of an existing array. If your program no
longer needs a given array variable, the ReDim statement can re-size that array to have zero
elements (this minimizes the amount of memory required to store variables).
Unlike some BASIC languages, MapBasic does not allow custom subscript settings for arrays; a
MapBasic array's first element always has a subscript of one.
If you store values in an array, and then enlarge the array through the ReDim statement, the values
you stored in the array remain intact.
484
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
Dim names_list(10) As String, cur_size As Integer
' The following statements determine the current
' size of the array, and then ReDim the array to
' a size 10 elements larger
cur_size = UBound(names_list)
ReDim names_list(cur_size + 10)
'
'
'
'
The following statement ReDims the array to a
size of zero elements. Presumably, this array
is no longer needed, and it is resized to zero
for the sake of saving memory.
ReDim names_list(0)
As shown below, the ReDim statement can operate on arrays of custom Type variables, and also on
arrays that are Type elements.
Type customer
name As String
serial_nums(0) As Integer
End Type
Dim new_customers(1) As customer
' First, redimension the "new_customers" array,
' making it five items deep:
ReDim new_customers(5)
' Now, redimension the "serial_nums" array element
' of the first item in the "new_customers" array:
ReDim new_customers(1).serial_nums(10)
See Also
Dim statement, Global statement, UBound( ) function
Reference Guide
485
Register Table statement
Register Table statement
Purpose
Builds a MapInfo Professional table from a spreadsheet, database, text file, raster, or grid image.
Syntax
Register Table source_file
{ Type "NATIVE" |
Type "DBF" [ Charset char_set ] |
Type "ASCII" [ Delimiter delim_char ][ Titles ][ CharSet char_set ] |
Type "WKS" [ Titles ] [ Range range_name ] |
Type "WMS" Coordsys...
Type "WFS" [ Charset char_set ] Coordsys... [ Symbol... ]
[ Linestyle Pen(...) ] [ Regionstyle Pen(...) Brush(...) ]
Type "XLS" [ Titles ] [ Range range_name ] [ Interactive ] |
Type "Access" Table table_name [ Password pwd ] [ CharSet char_set ]}
Type ODBC
Connection { Handle ConnectionNumber | ConnectionString }
Toolkit toolkitname
Cache { ON | OFF }
[ Autokey { ON | OFF }]
Table SQLQuery
[ Versioned { ON | OFF }]
[ Workspace WorkspaceName ]
[ ParentWorkspace ParentWorkspaceName ]
Type "GRID" | Type "RASTER"
[ ControlPoints ( MapX1, MapY1 ) ( RasterX1, RasterY1 ),
( MapX2, MapY2 ) ( RasterX2, RasterY2 ),
( MapX3, MapY3 ) ( RasterX3, RasterY3 )
[, ... ]
]
[ CoordSys ... ]
Type "FME" [ Charset char_set ]
CoordSys...
Format format type
Schema featuretype
[ Use Color ]
[ Database ]
[ SingleFile ]
[ Symbol...]
[ Linestyle Pen(...) ]
[ Regionstyle Pen(...) Brush(...) ]
[ Font ... ]
Settings string1 [, string2 .. ]
Type "SHAPEFILE" [ Charset char_set ] CoordSys...
[ PersistentCache { ON | OFF } ]
[ Symbol...] [ Linestyle Pen(...) ]
[ Regionstyle Pen(...) Brush(...) ]
[ Into destination_file ]
486
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
source_file is a string that represents the name of an existing database, spreadsheet, text file, raster,
or grid image. If you are registering an Access table, this argument must identify a valid Access
database.
char_set is the name of a character set; see CharSet clause on page 126.
delim_char specifies the character used as a column delimiter. If the file uses Tab as the delimiter,
specify 9. If the file uses commas, specify 44.
range_name is a string indicating a named range (for example, “MyTable”) or a cell range (for
example, an Excel range can be specified as “Sheet1!R1C1:R9C6” or as “Sheet1!A1:F9”).
table_name is a string that identifies an Access table.
pwd is the database-level password for the database, to be specified when database security is
turned on.
ConnectionNumber is an integer value that identifies an existing connection to an ODBC database.
ConnectionString is a string used to connect to a database server. See Server_Connect( ) function
on page 543.
toolkitname is “ODBC” or “ORAINET.”
SQLQuery is the SQL query used to define the MapInfo table.
CoordSys... - CoordSys clause is required.
Format formattype - formattype is a string that is used by FME to identify format that is opened.
Schema featuretype - specifies a featuretype (essentially schema name).
Settings string1 [, string2 .. ] - These are Safe Software FME-specific settings that vary depending
upon the format and settings options the user selects.
Use Color - specifies if color information from dataset is used
Database - specifies if referenced datasource is from a database
SingleFile - specifies if referenced datasource consist of a single file
ControlPoints are optional, but can be specified if the type is Grid or Raster. If the ControlPoints
keyword is specified, it must be followed by at least 3 pairs of Map and Raster coordinates which are
used to georegister an image. If the ControlPoints are specified, they will override and replace any
control points associated with the image or an associated World file.
For WMS and Shapefiles, the CoordSys clause is mandatory. The compiler will indicate an error if it
is missing. For other Types, the CoordSys clause is optional, but it can be specified for the Grid or
Raster Types. If CoordSys is specified, it overrides and replaces any coordinate system associated
with the image. This is useful when registering a raster image that has an associated World file.
PersistentCache On specifies if .MAP and .ID files generated during the opening of Shapefiles are
saved on hard disk after closing a table. If PersistentCache is set to Off, then these .MAP and .ID
files are deleted after closing a table and are be generated each time the table is opened.
The Symbol clause specifies the symbol style to be used for a point object type created from a
shapefile.
Reference Guide
487
Register Table statement
The Linestyle Pen clause specifies the line style to be used for a line object type created from a
shapefile.
Regionstyle Pen Brush clause specifies the line style and fill style to be used for a region object
type created from a shapefile.
The Interactive keyword is optional, but can be specified if the type XLS, Grid, or Raster. If the
Interactive keyword is specified for type Grid or Raster, the user is prompted for any missing control
point or projection information. If the Interactive keyword is not specified, a .TAB file is generated
without user input and is created as though the user had selected “Display” when opening a raster
image from the File > Open dialog box. Interactive is not a valid parameter for registering SHP files.
Note: If the Interactive keyword is specified for type XLS, it instructs the interface to display the Set
Field Properties window when importing Excel files.
destination_file specifies the name to give to the MapInfo table (.TAB file). This string may include a
path; if it does not include a path, the file is built in the same directory as the source file.
If Autokey is set ON, the table is registered with key auto-increment option. If Autokey is set OFF or
this option is ignored, the table is registered without key auto-increment.
Versioned indicates if the table to be opened is an version-enabled (ON) table or not (OFF).
WorkspaceName is the name of the current workspace in which the table will be operated. The
name is case sensitive.
ParentWorkspaceName is the name of parent workspace of the current workspace.
Charset char_set - this is optional parameter. If character set is not specified in MapBasic, then
system character set is used. This is similar to all other formats.
CoordSys... - CoordSys clause is required.
Format formattype - formattype is a string that is used by FME to identify format that is opened.
Schema featuretype - specifies a featuretpe (essentially schema name).
Settings string1 [, string1 .. ] - These are Safe Software FME-specific settings that vary depending
upon the format and settings options the user selects.
Use Color - specifies if color information from dataset is used
Database - specifies if referenced datasource is from a database
SingleFile - specifies if referenced datasource consist of a single file
Description
Before you can use a non-native file (for example, a dBASE file) in MapInfo, you must register the
file. The Register Table statement tells MapInfo Professional to examine a non-native file (for
example, filename.DBF) and build a corresponding table file (filename.TAB). Once the Register
Table operation has built a table file, you can access the file as an MapInfo table.
488
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The Register Table statement does not copy or alter the original data file. Instead, it scans the data,
determines the datatypes of the columns, and creates a separate table file. The table is not opened
automatically. To open the table, use an Open Table statement.
Note: Each data file need only be registered once. Once the Register Table operation has built the
appropriate table file, subsequent MapInfo Professional sessions simply Open the table,
rather than repeat the Register Table operation.
The Type clause specifies where the file came from originally. This consists of the keyword Type,
followed by one of the following character constants: NATIVE, DBF, ASCII, WKS, XLS, Raster,
Access, or Grid. The other information is necessary for preparing certain types of tables. If the type
of file being registered is a grid, the coordsys string is read from the grid file and a MapInfo .TAB file
is created. If a raster file is being registered, the .TAB file that is generated is the same as if the user
selected “Display” when opening a raster image from the File > Open dialog box.
If the type of file being registered is a grid, the coordsys string is read from the grid file and a MapInfo
.TAB file is created. If a raster file is being registered, the .TAB file that is generated depends upon if
georegistration information can be found in the image file or associated World file.
The CharSet clause specifies a character set. The char_set parameter should be a string such as
“WindowsLatin1”. If you omit the CharSet clause, MapInfo Professional uses the default character
set for the hardware platform that is in use at run-time. See CharSet clause on page 126 for more
information.
The Delimiter clause is followed by a string containing the delimiter character. The default delimiter
is a TAB. The Titles clause indicates that the row before the range of data in the worksheet should
be used as column titles. The Range clause allows the specification of a named range to use. The
Into clause is used to override the table name or location of the .TAB file. By default, it will be named
the same as the data file, and stored in the same directory. However, when reading a read-only
device such as a CD-ROM, you need to store the .TAB file on a volume that is not read-only.
Registering Access Tables
When you register an Access table, MapInfo Professional checks for a counter column with a unique
index. If there is already a counter column, MapInfo Professional registers that column in the .TAB
file. The column is read-only.
If the Access table does not have a counter column, MapInfo Professional modifies the Access table
by adding a column called MAPINFO_ID with the counter datatype. In this case, the counter column
does not display in MapInfo.
Note: Do not alter the counter column in any way. It must be exclusively maintained automatically
by MapInfo Professional.
Access datatypes are translated into the closest MapInfo datatypes. Special Access datatypes, such
as OLE objects and binary fields, are not editable in MapInfo Professional.
Reference Guide
489
Register Table statement
Registering ODBC Tables
Before accessing a table live from a remote database, it is highly recommended that you first open a
map table (for example, canada.tab) for the database table. If you don't open a map table, the entire
database table will be downloaded all at once, which could take a long time.
Open a map table and zoom in to an area that corresponds to a subset of rows you wish to see from
the database table. For example, if you want to download rows pertaining to Ontario, zoom in to
Ontario on the map. As a result, when you open the database table, only rows within the map
window's MBR (minimum bounding rectangle), in this case Ontario, will be downloaded.
The following is a list of known problems/issues with live access:
•
•
•
•
•
•
•
•
•
Every table must have a single unique key column.
FastEdit is not supported.
With MS ACCESS if the key is character, it does not display rows where the key value is less
than the full column width for example, if the key is char(5) the value 'aaaa' will look like a
deleted row.
For Live Access, the ReadOnly checkbox on the save table dialog box is grayed out.
Changes made by another user are not visible until a browser is scrolled or somehow refreshed.
Inserts by another user are not seen until either: 1). An MBR search returns the row or 2). PACK
command is issued In addition if cache is on another users updates may not appear until the
cache is invalidated by a pan or zooming out.
There will be a problem if a client-side join (through the SQL Select menu item or MapBasic) is
done against two or more SPATIALWARE tables that are stored in different coordinate systems.
This is not an efficient thing to do (it is better to do the join in the SQL statement that defines the
table) but it is a problem in the current build.
Oracle 7 tables that are indexed on a decimal field larger than 8 bytes will cause MapInfo
Professional to crash when editing.
If the server is Oracle, Autokey is the indicator to tell if the new feature, key auto-increment, will
be used or not.
If the Cache OFF statement is before the connection string an error will be generated at compile
time.
Example
The following example creates a tab file and then opens the tab file.
Register Table "SMALLINTEGER" TYPE ODBC
TABLE "Select * From ""MIPRO"".""SMALLINTEGER"""
CONNECTION "SRVR=scout;UID=mipro;PWD=mipro "
toolkit "ORAINET"
Autokey ON
Into
"C:\projects\data\testscripts\english\remote\SmallIntEGER.TAB"
Open Table "C:\Projects\Data\TestScripts\English\remote\SmallIntEGER.TAB"
Interactive
Map From SMALLINTEGER
490
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example for FME (Universal Data)
Register Table "D:\MUT\DWG\Data\africa_miller.DWG" Type "FME" CoordSys
Earth Projection 11, 104, "m", 0 Format "ACAD" Schema "africa_miller" Use
Color SingleFile Symbol (35,0,16) Linestyle Pen (1,2,0) RegionStyle Pen
(1,2,0) Brush (2,16777215,16777215)
Font ("Arial",0,9,0) Settings
"RUNTIME_MACROS","METAFILE,acad,_EXPAND_BLOCKS,yes,ACAD_IN_USE_BLOCK_HEAD
ER_LAYER,yes,ACAD_IN_RESOLVE_ENTITY_COLOR,yes,_EXPAND_VISIBLE,yes,_BULGES
_AS_ARCS,no,_STORE_BULGE_INFO,no,_READ_PAPER_SPACE,no,ACAD_IN_READ_GROUPS
,no,_IGNORE_UCS,no,_ACADPreserveComplexHatches,no,_MERGE_SCHEMAS,YES",
"META_MACROS","Source_EXPAND_BLOCKS,yes,SourceACAD_IN_USE_BLOCK_HEADER_LA
YER,yes,SourceACAD_IN_RESOLVE_ENTITY_COLOR,yes,Source_EXPAND_VISIBLE,yes,
Source_BULGES_AS_ARCS,no,Source_STORE_BULGE_INFO,no,Source_READ_PAPER_SPA
CE,no,SourceACAD_IN_READ_GROUPS,no,Source_IGNORE_UCS,no,Source_ACADPreser
veComplexHatches,no", "METAFILE","acad", "COORDSYS","", "IDLIST","" Into
"C:\Temp\africa_miller.tab"
Open table "C:\Temp\africa_miller.tab"
Map From "africa_miller"
Registering Shapefiles
When you register shapefiles, they can be opened in MapInfo Professional with read-only access.
Since a shapefile itself does not contain projection information, you must specify a CoordSys
clause. It is also possible to set styles that will be used when shapefile objects are displayed in
MapInfo Professional. Projection and style information is stored as metadata in the TAB file.
Note: Interactive is not a valid parameter to use when registering SHP files.
Examples
Example 1
Register Table "c:\mapinfo\data\rpt23.dbf"
Type "DBF"
Into "Report23"
Open Table "c:\mapinfo\data\Report23"
Example 2
Open Table "C:\Data\CANADA\Canada.tab" Interactive
Map From Canada
set map redraw off
Set Map Zoom 1000 Units "mi"
set map redraw on
Register Table "odbc_cancaps"
TYPE ODBC
TABLE "Select * From informix.can_caps"
CONNECTION
DSN=ius_adak;UID=informix;PWD=informix;DATABASE=sw;HOST=adak;
SERVER=adak_tli;SERVICE=sqlexec;PROTOCOL=onsoctcp;"
Into
"D:\MI\odbc_cancaps.TAB"
Open Table "D:\MI\odbc_cancaps.TAB" Interactive
Map From odbc_cancaps
Reference Guide
491
Register Table statement
Example 3
Registering a completely georeferenced raster image (the raster handler can return at least three
control points and a projection).
Register Table "GeoRef.tif" type "raster" into "GeoRef.TAB"
Example 4
Registering a raster image that has an associated World file containing control point information, but
no projection.
Register Table "RasterWithWorld.tif" type "raster" coordsys earth
projection 9, 62, "m", -96, 23, 29.5, 45.5, 0, 0 into
"RasterWithWorld.TAB"
Example 5
Registering a raster image that has no control point or projection information.
Register Table "NoRegistration.BMP" type "raster" controlpoints
(1000,2000) (1,2), (2000,3000) (2, 3), (5000,6000) (5,6) coordsys earth
projection 9, 62, "m", -96, 23, 29.5, 45.5, 0, 0 into "NoRegistration.tab"
Example 6
The following example registers a shapefile.
Register Table "C:\Shapefiles\CNTYLN.SHP" TYPE SHAPEFILE Charset
"WindowsLatin1" CoordSys Earth Projection 1, 33 PersistentCache Off
linestyle Pen (2,26,16711935) Into "C:\Temp\CNTYLN.TAB"
Open Table "C:\Temp\CNTYLN.TAB" Interactive
Map From CNTYLN
Example 7
The following example creates a tab file and then opens the tab file.
Register Table "Gwmusa" TYPE ODBC
TABLE "Select * From ""MIUSER"".""GWMUSA"""
CONNECTION "SRVR=troyny;UID=miuser;PWD=miuser"
toolkit "ORAINET"
Versioned On
Workspace "MIUSER"
ParentWorkspace "LIVE"
Into "C:\projects\data\testscripts\english\remote\Gwmusa.tab"
Open Table "C:\Projects\Data\TestScripts\English\remote\Gwmusa.TAB"
Interactive Map From Gwmusa
See Also
Open Table statement, Create Table statement, Server Create Workspace statement, Server
Link Table statement
492
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Relief Shade statement
Purpose
Adds relief shade information to an open grid table.
Syntax
Relief Shade
Grid tablename
Horizontal xy_plane_angle
Vertical incident_angle
Scale z_scale_factor
tablename is the alias name of the grid to which relief shade information is being calculated.
xy_plane_angle is the direction angle, in degrees, of the light source in the horizontal or xy plane. An
xy_plane_angle of zero represents a light source shining from due East. A positive angle places the
light source counterclockwise, so to place the light source in the NorthWest, set xy_plane_angle to
135.
incident_angle is the angle of the light source above the horizon or xy plane. An incident_angle of
zero represents a light source right at the horizon. An incident_angle of 90 places the light source
directly overhead.
z_scale_factor is the scale factor applied to the z-component of each grid cell. Increasing the
z_scale_factor enhances the shading effect by exaggerating the vertical component. This can be
used to bring out more detail in relatively flat grids.
Example
Relief Shade
Grid Lumens
Horizontal 135
Vertical 45
Scale 30
Reload Symbols statement
Purpose
Opens and reloads the MapInfo symbol file; this can change the set of symbols displayed in the
Options > Symbol Style dialog box.
Syntax 1 (MapInfo 3.0 Symbols)
Reload Symbols
Syntax 2 (Bitmap File Symbols)
Reload Custom Symbols From directory
directory is a string representing a directory path.
Reference Guide
493
RemoteMapGenHandler procedure
Description
This statement is used by the SYMBOL.MBX utility, which allows users to create custom symbols.
Note: MapInfo 3.0 Symbols refers to the symbol set that came with MapInfo Professional for
Windows 3.0 and has been maintained in subsequent versions of MapInfo Professional.
See Also
Alter Object statement
RemoteMapGenHandler procedure
Purpose
A reserved procedure name, called when an OLE Automation client calls the MapGenHandler
Automation method.
Syntax
Declare Sub RemoteMapGenHandler
Sub RemoteMapGenHandler
statement_list
End Sub
statement_list is a list of MapBasic statements to execute when the OLE Automation client calls the
MapGenHandler method.
Description
RemoteMapGenHandler is a special-purpose MapBasic procedure name, which is invoked through
OLE Automation. If you are using OLE Automation to control MapInfo Professional, and you call the
MapGenHandler method, MapInfo Professional calls the RemoteMapGenHandler procedures of
any MapBasic applications that are running. The MapGenHandler method is part of the MapGen
Automation model introduced in MapInfo Professional 4.1.
The MapGenHandler Automation method takes one argument: a string. Within the
RemoteMapGenHandler procedure, you can retrieve the string argument by issuing the function call
CommandInfo(CMD_INFO_MSG) and assigning the results to a string variable.
Example
For an example of using RemoteMapGenHandler, see the sample program MAPSRVR.MB.
494
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
RemoteMsgHandler procedure
Purpose
A reserved procedure name, called when a remote application sends an execute message.
Syntax
Declare Sub RemoteMsgHandler
Sub RemoteMsgHandler
statement_list
End Sub
statement_list is a list of statements to execute upon receiving an execute message.
Description
RemoteMsgHandler is a special-purpose MapBasic procedure name that handles inter-application
communication. If you run a MapBasic application that includes a procedure named
RemoteMsgHandler, MapInfo Professional automatically calls the RemoteMsgHandler procedure
every time another application (for example, a spreadsheet or database package) issues an
“execute” command. The MapBasic procedure then can call the CommandInfo( ) function to
retrieve the string corresponding to the execute command.
You can use the End Program statement to terminate a RemoteMsgHandler procedure once it is
no longer wanted. Conversely, you should be careful not to issue an End Program statement while
the RemoteMsgHandler procedure is still needed.
Inter-Application Communication Using Windows DDE
If a Windows application is capable of conducting a DDE (Dynamic Data Exchange) conversation,
that application can initiate a conversation with MapInfo Professional. In the conversation, the
external application is the client (active party), and a specific MapBasic application is the server
(passive party).
Each time the DDE client sends an execute command, MapInfo Professional calls the server's
RemoteMsgHandler procedure. Within the RemoteMsgHandler procedure, you can use the
function call:
CommandInfo(CMD_INFO_MSG)
to retrieve the string sent by the remote application. The DDE conversation must use the name of
the sleeping application (for example, “C:\MAPBASIC\DISPATCH.MBX”) as the topic in order to
facilitate RemoteMsgHandler functionality.
See Also
DDEExecute statement, DDEInitiate( ) function, SelChangedHandler procedure, ToolHandler
procedure, WinChangedHandler procedure, WinClosedHandler procedure
Reference Guide
495
RemoteQueryHandler( ) function
RemoteQueryHandler( ) function
Purpose
A special function, called when a MapBasic program acts as a DDE server, and the DDE client
performs a “peek” request.
Syntax
Declare Function RemoteQueryHandler( ) As String
Function RemoteQueryHandler( ) As String
statement_list
End Function
statement_list is a list of statements to execute upon receiving a peek request.
Description
The RemoteQueryHandler( ) function works in conjunction with DDE (Dynamic Data Exchange).
For an introduction to DDE, see the MapBasic User Guide. An external application can initiate a
DDE conversation with your MapBasic program. To initiate the conversation, the external application
uses “MapInfo” as the DDE application name, and it uses the name of your MapBasic application as
the DDE topic. Once the conversation is initiated, the external application (the client) can issue peek
requests to request data from your MapBasic application (the server).
To handle peek requests, include a function called RemoteQueryHandler( ) in your MapBasic
application. When the client application issues a peek request, MapInfo Professional automatically
calls the RemoteQueryHandler( ) function. The client's peek request is handled synchronously; the
client waits until RemoteQueryHandler( ) returns a value.
Note: The DDE client can peek at the global variables in your MapBasic program, even if you do
not define a RemoteQueryHandler( ) function. If the client issues a peek request using the
name of a MapBasic global variable, MapInfo Professional automatically returns the global's
value to the client instead of calling RemoteQueryHandler( ). In other words, if the data you
want to expose is already stored in global variables, you do not need
RemoteQueryHandler( ).
496
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following example calls the CommandInfo( ) function to determine the item name specified by
the DDE client. The item name is used as a flag; in other words, this program decides which value to
return based on whether the client specified “code1” as the item name.
Function RemoteQueryHandler( ) As String
Dim s_item_name As String
s_item_name = CommandInfo(CMD_INFO_MSG)
If s_item_name = "code1" Then
RemoteQueryHandler = custom_function_1( )
Else
RemoteQueryHandler = custom_function_2( )
End If
End Function
See Also
DDEInitiate( ) function, RemoteMsgHandler procedure
Remove Cartographic Frame statement
Purpose
Allows you to remove cartographic frames from an existing cartographic legend created with the
Create Cartographic Legend statement.
Syntax
Cartographic Frame
[ Window legend_window_id ]
Id frame_id, frame_id, frame_id, ...
legend_window_id is an integer window identifier which you can obtain by calling the
FrontWindow( ) function and the WindowID( ) function.
frame_id is the ID of the frame on the legend. You cannot use a layer name. For example, three
frames on a legend would have the successive IDs, 1, 2, and 3.
See Also
Add Cartographic Frame statement, Alter Cartographic Frame statement, Create
Cartographic Legend statement, Set Cartographic Legend statement
Reference Guide
497
Remove Map statement
Remove Map statement
Purpose
Removes one or more layers from a Map window.
Syntax
Remove Map [ Window window_id ]
Layer map_layer [ , map_layer ... ] [ Interactive ]
window_id is the integer window identifier of a Map window; to obtain a window identifier, call the
FrontWindow( ) function or the WindowID( ) function.
map_layer specifies which map layer(s) to remove; see examples below.
Description
The Remove Map statement removes one or more layers from a Map window. If no window_id is
provided, the statement affects the topmost Map window.
The map_layer parameter can be an integer greater than zero, a string containing the name of a
table, or the keyword Animate, as summarized in the following table.
Examples
Descriptions of Examples
Remove Map Layer 1
If you specify “1” (one) as the map_layer parameter, the
top map layer (other than the Cosmetic layer) is removed.
Specify “1, 2" to remove the top two layers.
Remove Map Layer "Zones"
The Zones layer is removed (assuming that one of the
layers in the map is named “Zones”).
Remove Map Layer "Zones(1)"
The first thematic layer based on the Zones layer is
removed.
Remove Map Layer Animate
The animation layer is removed. To learn how to add an
animation layer, see Add Map statement on page 72.
If you include the Interactive keyword, and if the layer removal will cause the loss of labels or
themes, MapInfo Professional displays a dialog box that allows the user to save (a workspace),
discard the labels and themes, or cancel the layer removal. If you omit the Interactive keyword, the
user is not prompted.
A Remove Map statement does not close any tables; it only affects the number of layers displayed
in the Map window. If a Remove Map statement removes the last non-cosmetic layer in a Map
window, MapInfo Professional automatically closes the window.
See Also
Create Map statement, Map statement, Set Map statement
498
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Rename File statement
Purpose
Changes the name of a file.
Syntax
Rename File old_filespec As new_filespec
old_filespec is a string representing an existing file's name (and, optionally, path); the file must not
be open.
new_filespec is a string representing the new name (and, optionally, path) for the file.
Description
The Rename File statement renames a file.
The new_filespec parameter specifies the file's new name. If new_filespec contains a directory path
that differs from the file's original location, MapInfo Professional moves the file to the specified
directory.
Example
Rename File "startup.wor" As "startup.bak"
See Also
Rename File statement, Save File statement
Rename Table statement
Purpose
Changes the names (and, optionally, the location) of the files that make up a table.
Syntax
Rename Table table As newtablespec
table is the name of an open table.
newtablespec is the new name (and, optionally, path) for the table.
Description
The Rename Table statement assigns a new name to an open table.
Reference Guide
499
Reproject statement
The newtablespec parameter specifies the table's new name. If newtablespec contains a directory
name, MapBasic attempts to move the table to the specified directory in addition to renaming the
table. The Rename Table statement renames the physical files which comprise a table. This effect is
permanent (unless/until another Rename Table statement is issued).
Note: This action can invalidate existing workspaces. Any workspaces created before the renaming
operation will refer to the table by its previous, no-longer-applicable name.
Do not use the Rename Table statement to assign a temporary, working table name. If you need to
assign a temporary name, use the Open Table statement’s optional As clause.
The Rename Table statement cannot rename a table that is actually a “view.” For example, a
StreetInfo table (such as SF_STRTS) is actually a view, combining two other tables (SF_STRT1 and
SF_STRT2). You could not rename the SF_STRTS table by calling Rename Table. You cannot
rename temporary query tables (for example, QUERY1). You cannot rename tables that have
unsaved edits; if a table has unsaved edits, you must either save or discard the edits ( or Rollback)
before renaming.
Example
The following example renames the table casanfra as sf_hiway.
Open Table "C:\DATA\CASANFRA.TAB"
Rename Table CASANFRA As "SF_HIWAY.TAB"
The following example renames a table and moves it to a different directory path.
Open Table "C:\DATA\CASANFRA.TAB"
Rename Table CASANFRA As "c:\MAPINFO\SF_HIWAY"
See Also
Close Table statement, Drop Table statement
Reproject statement
Purpose
Allows you to specify which columns should appear the next time a table is browsed. This statement
has been deprecated.
Resume statement
Purpose
Returns from an OnError error handler.
Syntax
Resume { 0 | Next | label }
label is a label within the same procedure or function.
500
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Restrictions
You cannot issue a Resume statement through the MapBasic window.
Description
The Resume statement tells MapBasic to return from an error-handling routine.
The OnError statement enables an error-handling routine, which is a group of statements
MapBasic carries out in the event of a run-time error. Typically, each error-handling routine includes
one or more Resume statements. The Resume statement causes MapBasic to exit the errorhandling routine.
The various forms of the Resume statement let the application dictate which statement MapBasic is
to execute after exiting the error-handling routine:
A Resume 0 statement tells MapBasic to retry the statement which generated the error.
A Resume Next statement tells MapBasic to go to the first statement following the statement which
generated the error.
A Resume label statement tells MapBasic to go to the line identified by the label. Note that the label
must be in the same procedure.
Example
...
OnError GoTo no_states
Open Table "states"
Map From states
after_mapfrom:
...
End Program
no_states:
Note "Could not open States; no Map used."
Resume after_mapfrom
See Also
Err( ) function, Error statement, Error$( ) function, OnError statement
RGB( ) function
Purpose
Returns an RGB color value calculated from Red, Green, Blue components.
Syntax
RGB( red, green, blue )
red is a numeric expression from 0 to 255, representing a concentration of red.
green is a numeric expression from 0 to 255, representing a concentration of green.
Reference Guide
501
Right$( ) function
blue is a numeric expression from 0 to 255, representing a concentration of blue.
Return Value
Integer
Description
Some MapBasic statements allow you to specify a color as part of a pen or brush definition (for
example, the Create Point statement). MapBasic pen and brush definitions require that each color
be specified as a single integer value, known as an RGB value. The RGB( ) function lets you
calculate such an RGB value.
Colors are often defined in terms of the relative concentrations of three components—the red, green
and blue components. Accordingly, the RGB( ) function takes three parameters—red, green, and
blue—each of which specifies the concentration of one of the three primary colors. Each color
component should be an integer value from 0 to 255, inclusive.
The RGB value of a given color is calculated by the formula:
( red * 65536) + ( green * 256) + blue
The standard definitions file, MAPBASIC.DEF, includes Define statements for several common
colors (BLACK, WHITE, RED, GREEN, BLUE, CYAN, MAGENTA, and YELLOW). If you want to
specify red, you can simply use the identifier RED instead of calling RGB( ).
Example
Dim red,green,blue,color As Integer
red = 255
green = 0
blue = 0
color = RGB(red, green, blue)
' the RGB value stored in the variable: color
' will represent pure, saturated red.
See Also
Brush clause, Font clause, Pen clause, Symbol clause
Right$( ) function
Purpose
Returns part or all of a string, beginning at the right end of the string.
Syntax
Right$( string_expr, num_expr )
string_expr is a string expression.
num_expr is a numeric expression.
502
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Return Value
String
Description
The Right$( ) function returns a string which consists of the rightmost num_expr characters of the
string expression string_expr.
The num_expr parameter should be an integer value, zero or larger. If num_expr has a fractional
value, MapBasic rounds to the nearest integer. If num_expr is zero, Right$( ) returns a null string. If
num_expr is larger than the number of characters in the string_expr string, Right$( ) returns a copy
of the entire string_expr string.
Example
Dim whole, partial As String
whole = "Afghanistan"
partial = Right$(whole, 4)
' at this point, partial contains the string: "stan"
See Also
Left$( ) function, Mid$( ) function
Rnd( ) function
Purpose
Returns a random number.
Syntax
Rnd( list_type )
list_type selects the kind of random number list.
Return Value
A number of type float between 0 and 1 (exclusive).
Description
The Rnd( ) function returns a random floating-point number, greater than zero and less than one.
The conventional use is of the form Rnd(1), in which the function returns a random number. The
sequence of random numbers is always the same unless you insert a Randomize statement in the
program. Any positive list_type parameter value produces this type of result.
A less common use is the form Rnd(0), which returns the previous random number generated by
the Rnd( ) function. This functionality is provided primarily for debugging purposes.
Reference Guide
503
Rollback statement
A very uncommon use is a call with a negative list_type value, such as Rnd(-1). For a given
negative value, the Rnd( ) function always returns the same number, regardless of whether you
have issued a Randomize statement. This functionality is provided primarily for debugging
purposes.
Example
Chknum = 10 * Rnd(1)
See Also
Randomize statement
Rollback statement
Purpose
Discards a table's unsaved edits.
Syntax
Rollback Table tablename
tablename is the name of an open table.
Description
If the specified table has been edited, but the edits have not been saved, the Rollback statement
discards the unsaved edits. The user can obtain the same results by choosing File > Revert, except
that command displays a dialog box.
Note: When you Rollback a query table, MapInfo Professional discards any unsaved edits in the
permanent table used for the query (except in cases where the query produces a join, or the
query produces aggregated results, for example, using the Select statement’s Group By
clause).
For example, if you edit a permanent table (such as WORLD), make a selection from WORLD, and
browse the selection, MapInfo Professional will “snapshot” the Selection table, and call the snapshot
(something like) QUERY1. If you then Rollback the QUERY1 table, MapInfo Professional discards
any unsaved edits in the WORLD table, since the WORLD table is the table on which QUERY1 is
based.
Using a Rollback statement on a linked table discards the unsaved edits and returns the table to the
state it was in prior to the unsaved edits.
Example
If keep_changes Then
Table towns
Else
Rollback Table towns
End If
504
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
See Also
Commit Table statement
Rotate( ) function
Purpose
Allows an object (not a text object) to be rotated about the rotation anchor point.
Syntax
Rotate( object, angle )
object represents an object that can be rotated. It cannot be a text object.
angle is a float value that represents the angle (in degrees) to rotate the object.
Return Value
A rotated object.
Description
The Rotate( ) function Rotates all object types except for text objects without altering the source
object in any way.
To rotate text objects, use the Alter Object OBJ_GEO_TEXTANGLE statement.
If an arc, ellipse, rectangle, or rounded rectangle is rotated, the resultant object is converted to a
polyline/polygon so that the nodes can be rotated.
Example
dim RotateObject as object
Open Table "C:\MapInfo_data\TUT_USA\USA\STATES.TAB"
map from states
select * from States where state = "IN"
RotateObject = rotate(selection.obj, 45)
insert into states (obj) values (RotateObject)
See Also
RotateAtPoint( ) function
Reference Guide
505
RotateAtPoint( ) function
RotateAtPoint( ) function
Purpose
Allows an object (not a text object) to be rotated about a specified anchor point.
Syntax
RotateAtPoint( object, angle, anchor_point_object )
object represents an object that can be rotated. It cannot be a text object.
angle is a float value that represents the angle (in degrees) to rotate the object.
anchor_point_object is an object representing the anchor point which the object nodes are rotated
about.
Return Value
A rotated object.
Description
The RotateAtPoint( ) function rotates all object types except for text objects without altering the
source object in any way.
To rotate text objects, use the Alter Object OBJ_GEO_TEXTANGLE statement.
If an arc, ellipse, rectangle, or rounded rectangle is rotated, the resultant object is converted to a
polyline/polygon so that the nodes can be rotated.
Example
dim RotateAtPointObject as object
dim obj1 as object
dim obj2 as object
Open Table "C:\MapInfo_data\TUT_USA\USA\STATES.TAB" ]
map from states
select * from States where state = "CA"
obj1 = selection.obj
select * from States where state = "NV"
obj2 = selection.obj
oRotateAtPointObject = RotateAtPoint(obj1 , 65, centroid(obj2))
insert into states (obj) values (RotateAtPointObject )
See Also
Rotate( ) function
506
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Round( ) function
Purpose
Returns a number obtained by rounding off another number.
Syntax
Round( num_expr, round_to )
num_expr is a numeric expression.
round_to is the number to which num_expr should be rounded off.
Return Value
Float
Description
The Round( ) function returns a rounded-off version of the numeric num_expr expression.
The precision of the result depends on the round_to parameter. The Round( ) function rounds the
num_expr value to the nearest multiple of the round_to parameter. If round_to is 0.01, MapInfo
Professional rounds to the nearest hundredth; if round_to is 5, MapInfo Professional rounds to the
nearest multiple of 5; etc.
Example
Dim x, y As Float
x = 12345.6789
y = Round(x, 100)
' y now has the value 12300
y = Round(x, 1)
' y now has the value 12346
y = Round(x, 0.01)
' y now has the value 12345.68
See Also
Fix( ) function, Format$( ) function, Int( ) function
Reference Guide
507
RTrim$( ) function
RTrim$( ) function
Purpose
Trims space characters from the end of a string, and returns the results.
Syntax
RTrim$( string_expr )
string_expr is a string expression.
Return Value
String
Description
The RTrim$( ) function removes any spaces from the end of the string_expr string, and returns the
resultant string.
Example
Dim s_name As String
s_name = RTrim$("Mary Smith ")
' s_name now contains the string "Mary Smith"
' (no spaces at the end)
See Also
LTrim$( ) function
Run Application statement
Purpose
Runs a MapBasic application or adds a MapInfo workspace.
Syntax
Run Application file
file is the name of an application file or a workspace file.
Description
The Run Application statement runs a MapBasic application or loads an MapInfo workspace. By
issuing a Run Application statement, one MapBasic application can run another application. To do
so, the file parameter must represent the name of a compiled application file. The Run Application
statement cannot run an uncompiled application. To halt an application launched by the Run
Application statement, use the Terminate Application statement.
508
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following statement runs the MapBasic application, REPORT.MBX:
Run Application "C:\MAPBASIC\APP\REPORT.MBX"
The following statement loads the workspace, Parcels.wor:
Run Application "Parcels.wor"
See Also
Run Command statement, Run Menu Command statement, Run Program statement,
Terminate Application statement
Run Command statement
Purpose
Executes a MapBasic command represented by a string.
Syntax
Run Command command
command is a character string representing a MapBasic statement.
Description
The Run Command statement interprets a character string as a MapBasic statement, then
executes the statement.
The Run Command statement has some restrictions, due to the fact that the command parameter
is interpreted at run-time, rather than being compiled. You cannot use a Run Command statement
to issue a Dialog statement. Also, variable names may not appear within the command string; that
is, variable names may not appear enclosed in quotes. For example, the following group of
statements would not work, because the variable names x and y appear inside the quotes that
delimit the command string:
' this example WON'T work
Dim cmd_string As String
Dim x, y As Float
cmd_string = " x = Abs(y) "
Run Command cmd_string
However, variable names can be used in the construction of the command string.
Reference Guide
509
Run Command statement
In the following example, the command string is constructed from an expression that includes a
character variable.
'this example WILL work
Dim cmd_string As String
Dim map_it, browse_it As Logical
Open Table "world"
If map_it Then
cmd_string = "Map From
Run Command cmd_string
End If
If browse_it Then
cmd_string = "Browse *
Run Command cmd_string
End If
"
+ "world"
From "
+ "world"
Example
The Run Command statement provides a flexible way of issuing commands that have variablelength argument lists. For example, the Map From statement can include a single table name, or a
comma-separated list of two or more table names. An application may need to decide at run time
(based on feedback from the user) how many table names should be included in the Map From
statement. One way to do this is to construct a text string at run time, and execute the command
through the Run Command statement.
Dim cmd_text As String
Dim cities_wanted, counties_wanted As Logical
Open Table "states"
Open Table "cities"
Open Table "counties"
cmd_text = "states" ' always include STATES layer
If counties_wanted Then
cmd_text = "counties, " + cmd_text
End If
If cities_wanted Then
cmd_text = "cities, " + cmd_text
End If
Run Command "Map From " + cmd_text
510
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
The following example shows how to duplicate a Map window, given the window ID of an existing
map. The WindowInfo( ) function returns a string containing MapBasic statements; the Run
Command statement executes the string.
Dim i_map_id As Integer
' First, get the ID of an existing Map window
' (assuming the Map window is the active window):
i_map_id = FrontWindow( )
' Now clone the active map window:
Run Command WindowInfo(i_map_id, WIN_INFO_CLONEWINDOW)
See Also
Run Application statement, Run Menu Command statement, Run Program statement
Run Menu Command statement
Purpose
Runs a MapInfo Professional menu command, as if the user had selected the menu item. Can also
be used to select a button on a ButtonPad.
Syntax
Run Menu Command { command_code | ID command_ID }
command_code is an integer code from MENU.DEF (such as M_FILE_NEW), representing a
standard menu item or button.
command_ID is a number representing a custom menu item or button.
Description
To execute a standard MapInfo Professional menu command, include the command_code
parameter. The value of this parameter must match one of the menu codes listed in MENU.DEF. For
example, the following MapBasic statement executes MapInfo Professional's File > New command:
Run Menu Command M_FILE_NEW
To select a standard button from MapInfo's ButtonPads, specify that button's code (from
MENU.DEF). For example, the following statement selects the Radius Search button:
Run Menu Command M_TOOLS_SEARCH_RADIUS
To select a custom button or menu command (i.e., a button or a menu command created through a
MapBasic program), use the ID clause.
Reference Guide
511
Run Program statement
For example, if your program creates a custom tool button by issuing a statement such as…
Alter ButtonPad ID 1 Add
ToolButton
Calling sub_procedure_name
ID 23
Icon MI_ICON_CROSSHAIR
…then the custom button has an ID of 23. The following statement selects the button.
Run Menu Command ID 23
Using MapBasic, the Run Menu Command statement can execute the MapInfo Professional Help
> MapInfo Professional Tutorial on the Web… command.
Run Menu Command M_HELP_MAPINFO_WWW_TUTORIAL
MapInfo Professional's Preferences dialog box is a special case. The Preferences dialog box
contains several buttons, each of which displays another dialog box. You can use Run Menu
Command statement to invoke individual sub-dialog boxes. For example, the following statement
displays the Map Window Preferences sub-dialog box:
Run Menu Command M_EDIT_PREFERENCES_MAP.
You can access Query > Invert Selection using the following MapBasic command:
Run Menu Command M_QUERY_INVERTSELECT.
In version 6.0 and later, access Page settings in Options > Preferences > Printer by using the
following syntax:
RUN MENU COMMAND M_EDIT_PREFERENCES_PRINTER
Or
RUN MENU COMMAND 217
' if running from MapBasic window
See Also
Run Application statement, Run Program statement
Run Program statement
Purpose
Runs an executable program.
Syntax
Run Program program_spec
program_spec is a command string that specifies the name of the program to run, and may also
specify command-line arguments.
512
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Description
If the specified program_spec does not represent a Windows application, MapBasic invokes a DOS
shell, and runs the specified DOS program from there. If the program_spec is the character string
“COMMAND.COM”, MapBasic invokes the DOS shell without any other program. In this case, the
user is able to issue DOS commands, and then type Exit to return to MapInfo. When you spawn a
program through a Run Program statement, Windows continues to control the computer. While the
spawned program is running, Windows may continue to run other background tasks—including your
MapBasic program. This multitasking environment could potentially create conflicts. Thus, the
MapBasic statements which follow the Run Program statement must not make any assumptions
about the status of the spawned program.
When issuing the Run Program statement, you should take precautions to avoid multitasking
conflicts. One way to avoid such conflicts is to place the Run Program statement at the end of a
sequence of events. For example, you could create a custom menu item which calls a handler sub
procedure, and you could make the Run Program statement the final statement in the handler
procedure.
Example
The following Run Program statement runs the Windows text editor, “Notepad,” and instructs
Notepad to open the text file THINGS.2DO.
Run Program "notepad.exe things.2do"
The following statement issues a DOS command.
Run Program "command.com /c dir c:\mapinfo\ > C:\temp\dirlist.txt"
See Also
Run Application statement, Run Command statement, Run Menu Command statement
Reference Guide
513
Run Program statement
514
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Save File statement
Purpose
Copies a file.
Syntax
Save File old_filespec As new_filespec [ Append ]
old_filespec is a string representing the name (and, optionally, the path) of an existing file; the file
must not be open.
new_filespec is a string representing the name (and, optionally, the path) to which the file will be
copied; the file must not be open.
Description
The Save File statement copies a file. The file must not already be open for input/output.
If you include the optional Append keyword, and if the file new_filespec already exists, the contents
of the file old_filespec are appended to the end of the file new_filespec.
Do not use Save File to copy a file that is a component of an open table (for example, filename.tab,
filename.map, etc.). To copy a table, use the Commit Table…As statement.
The Save File statement cannot copy a file to itself.
Example
Save File "settings.txt" As "settings.bak"
See Also
Kill statement, Rename File statement
Save MWS statement
Purpose
This statement allows you to save the current workspace as an XML-based MWS file for use with
MapXtreme applications. These MWS files can be shared across platforms in ways that workspaces
cannot.
Syntax
Save MWS Window ( window_id [ , window_id ... ] )
Default default_window_id As filespec
window_id is an integer window identifier for a Map window.
default_window_id is an integer window identifier for the Map window to be recorded in the MWS as
the default map.
Reference Guide
515
Save MWS statement
Description
MapInfo Professional enables you to save the maps in your workspace to an XML format for use
with MapXtreme applications. When saving a workspace to MWS format, only the map windows and
legends are saved. All other windows are discarded as MapXtreme applications cannot read that
information. Once your workspace is saved in this format, it can be opened with the Workspace
Manager utility that is included in the MapXtreme installation or with an application developed using
MapXtreme. The file is valid XML so can also be viewed using any XML viewer or editor. MWS files
created with MapInfo Professional 7.8 or later can be validated using schemas supplied with
MapXtreme.
Note: You will not be able to read files saved in MWS format in MapInfo Professional 7.8 or later.
In MapInfo Professional, you can set the visibility of a modifier theme without regard to its reference
feature layer, so you can turn the visibility of the main reference layer off but still display the theme.
In MapXtreme, the modifier themes (Dot Density, Ranges, Individual Value) are only drawn if the
reference feature layer is visible. To ensure that modifiers marked as visible in MapInfo Professional
display in tools like Workspace Manager, we force the visibility of the reference feature layer so that
its modifier themes display.
It is important to note that many MapBasic statements and functions do not translate to MWS format.
The sections below show what aspects of our maps can and cannot be saved into an MWS file. For
detailed listing of the compatibilities between MapBasic and MISQL see the MapInfo Professional
User Guide.
What is Saved in the MWS
The following information is included in the MWS workspace file:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
516
Tab files' name and alias;
Coordinate system information;
Map center and zoom settings;
Layer list with implied order;
Map size as pixel width and height;
Map resize method;
Style overrides;
Raster layer overrides;
Label and label edit information;
Labels based upon expressions;
Themes based upon expressions;
Edited labels
Queries referenced by map windows;
Individual value themes;
Dot density themes;
Graduated symbol themes;
Bar themes;
Range themes;
Pie themes;
Grid themes as MapXtreme grid layers with a style override;
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
•
Themes and label expressions based upon a single attribute column.
What is Not Saved to the MWS
The following information is not saved in the MWS workspace file:
•
•
•
•
•
Any non-map windows (browsers, charts, redistricters, 3D map windows, Prism maps);
Distance, area, or XY and military grid units;
Snap mode, autoscroll, and smart pan settings;
Printer setup information;
Any table that is based on a query without a window referencing them;
Note: A complex expression includes any operator or multiple referenced tables.
•
•
•
Any theme that is based upon computed columns;
Queries with “sub-select” statements;
Layers based on queries that includes “sub-select” statements;
Note: A “sub-select” statement is any Select statement nested inside another Select
statement.
•
•
•
•
•
Queries without a map window referencing them;
Export options;
Line direction arrows;
Whether object nodes are drawn or not;
Hot links for labels and objects.
See Also
Save Workspace statement
Save Window statement
Purpose
Saves an image of a window to a file; corresponds to choosing File > Save Window As.
Syntax
Save Window window_id
As filespec
Type filetype
[ Width image_width [ Units paper_units ] ]
[ Height image_height [ Units paper_units ] ]
[ Resolution output_dpi ]
[ Copyright notice [ Font... ] ]
window_id is an integer Window ID representing a Map, Layout, Graph, Legend, Statistics, Info, or
Ruler window; to obtain a window ID, call a function such as the FrontWindow( ) function or the
WindowID( ) function.
filespec is a string representing the name of the file to create.
Reference Guide
517
Save Window statement
filetype is a string representing a file format:
•
•
•
•
•
•
•
•
•
•
•
•
“BMP” specifies Bitmap format;
“WMF” specifies Windows Metafile format;
“JPEG” specifies JPEG format;
“JP2” specifies JPEG 2000 format;
“PNG” specifies Portable Network Graphics format;
“TIFF” specifies TIFF format;
“TIFFCMYK” specifies TIFF CMYK format;
“TIFFG4” specifies TIFFG4 format;
“TIFFLZW” specifies TIFFLZW format;
“GIF” specifies GIF format;
“PSD” specifies Photoshop 3.0 format;
“EMF” specifies Windows Enhanced Metafile format.
image_width is a number that specifies the desired image width.
image_height is a number that specifies the desired image height.
paper_units is a string representing a paper unit name (for example, “cm” for centimeters).
output_dpi is a number that specifies the output resolution in DPI (dots per inch).
notice is a string that represents a copyright notice; it will appear at the bottom of the image.
The Font clause specifies a text style.
Description
The Save Window statement saves an image of a window to a file. The effect is comparable to the
user choosing File > Save Window As, except that the Save Window statement does not display a
dialog box. For Map, Layout, or Graph windows, the default image size is the size of the original
window. For Legend, Statistics, Info, or Ruler windows, the default size is the size needed to
represent all of the data in the window. Use the optional Width and Height clauses to specify a nondefault image size. Resolution allows you to specify the dpi when exporting images to raster formats.
The Font clause specifies a text style in the copyright notice.
To include a copyright notice on the bottom of the image, use the optional Copyright clause. See
the example below. To eliminate the default notice, specify a Copyright clause with an empty string
("").
Error number 408 is generated if the export fails due to lack of memory or disk space. Note that
specifying very large image sizes increases the likelihood of this error.
Examples
This example produces a Windows metafile:
Save Window i_mapper_ID As "riskmap.wmf" Type "WMF"
518
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
This example shows how to specify a copyright notice. The Chr$( ) function is used to insert the
copyright symbol.
Save Window i_mapper_ID As "riskmap.bmp"
Type "BMP"
Copyright "Copyright " + Chr$(169) + " 1996, MapInfo Corp."
See Also
Export statement
Save Workspace statement
Purpose
Creates a workspace file representing the current MapInfo Professional session.
Syntax
Save Workspace As filespec
filespec is a string representing the name of the workspace file to create.
Description
The Save Workspace statement creates a workspace file that represents the current MapInfo
Professional session. The effect is comparable to the user choosing File > Save Workspace,
except that the Save Workspace statement does not display a dialog box.
To load an existing workspace file, use the Run Application statement.
Example
Save Workspace As "market.wor"
See Also
Run Application statement
SearchInfo( ) function
Purpose
Returns information about the search results produced by SearchPoint( ) or SearchRect( ).
Syntax
SearchInfo( sequence_number, attribute )
sequence_number is an integer number, from 1 to the number of objects located.
attribute is a small integer code from the table below.
Reference Guide
519
SearchInfo( ) function
Return Value
String or integer, depending on attribute.
Description
After you call SearchRect( ) or SearchPoint( ) to search for map objects, call SearchInfo( ) to
process the search results.
The sequence_number argument is an integer number, 1 or larger. The number returned by
SearchPoint( ) or SearchRect( ) is the maximum value for the sequence_number.
The attribute argument must be one of the codes (from MAPBASIC.DEF) in the following table:
attribute code
SearchInfo( ) returns:
SEARCH_INFO_TABLE
String value: the name of the table containing this object. If an object is
from a Cosmetic layer, this string has the form “CosmeticN” (where N
is a number, 1 or larger).
SEARCH_INFO_ROW
Integer value: this row's rowID number. You can use this rowID
number in a Fetch statement or in a Select statement’s Where
clause.
Search results remain in memory until the application halts or until you perform another search. Note
that search results remain in memory even after the user closes the window or the tables associated
with the search; therefore, you should process search results immediately. To manually free the
memory used by search results, perform a search which you know will fail (for example, search at
location 0, 0).
MapInfo Professional maintains a separate set of search results for each MapBasic application that
is running, plus another set of search results for MapInfo Professional itself (for commands entered
through the MapBasic window).
Error Conditions
ERR_FCN_ARG_RANGE error is generated if sequence_number is larger than the number of
objects located.
520
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Example
The following program creates two custom tool buttons. If the user uses the point tool, this program
calls the SearchPoint( ) function; if the user uses the rectangle tool, the program calls the
SearchRect( ) function. In either case, this program calls SearchInfo( ) to determine which
object(s) the user chose.
Include
Include
Declare
Declare
"mapbasic.def"
"icons.def"
Sub Main
Sub tool_sub
Sub Main
Create ButtonPad "Searcher" As
ToolButton Calling tool_sub ID 1
Icon MI_ICON_ARROW
Cursor MI_CURSOR_ARROW
DrawMode DM_CUSTOM_POINT
HelpMsg "Click on a map location\nClick a location"
Separator
ToolButton Calling tool_sub ID 2
Icon MI_ICON_SEARCH_RECT
Cursor MI_CURSOR_FINGER_LEFT
DrawMode DM_CUSTOM_RECT
HelpMsg "Drag a rectangle in a map\nDrag a rectangle"
Width 3
Print "Searcher program now running."
Print "Choose a tool from the Searcher toolbar"
Print "and click on a map."
End Sub
Sub tool_sub
' This procedure is called whenever the user uses
' one of the custom buttons on the Searcher toolbar.
Dim x, y, x2, y2 As Float,
i, i_found, i_row_id, i_win_id As Integer,
s_table As Alias
i_win_id = FrontWindow( )
If WindowInfo(i_win_id, WIN_INFO_TYPE) <> WIN_MAPPER Then
Note "This tool only works on Map windows."
Exit Sub
End If
' Determine the starting point where the user clicked.
x = CommandInfo(CMD_INFO_X)
y = CommandInfo(CMD_INFO_Y)
If CommandInfo(CMD_INFO_TOOLBTN) = 1 Then
' Then the user is using the point-mode tool.
' determine how many objects are at the chosen point.
i_found = SearchPoint(i_win_id, x, y)
Else
' The user is using the rectangle-mode tool.
' Determine what objects are within the rectangle.
x2 = CommandInfo(CMD_INFO_X2)
Reference Guide
521
SearchPoint( ) function
y2 = CommandInfo(CMD_INFO_y2)
i_found = SearchRect(i_win_id, x, y, x2, y2)
End If
If i_found = 0 Then
Beep ' No objects found where the user clicked.
Else
Print Chr$(12)
If CommandInfo(CMD_INFO_TOOLBTN) = 2 Then
Print "Rectangle: x1= " + x + ", y1= " + y
Print "x2= " + x2 + ", y2= " + y2
Else
Print "Point: x=" + x + ", y= " + y
End If
' Process the search results.
For i = 1 to i_found
' Get the name of the table containing a "hit".
s_table = SearchInfo(i, SEARCH_INFO_TABLE)
' Get the row ID number of the object that was a hit.
i_row_id = SearchInfo(i, SEARCH_INFO_ROW)
If Left$(s_table, 8) = "Cosmetic" Then
Print "Object in Cosmetic layer"
Else
' Fetch the row of the object the user clicked on.
Fetch rec i_row_id From s_table
s_table = s_table + ".col1"
Print s_table
End If
Next
End If
End Sub
See Also
SearchPoint( ) function, SearchRect( ) function
SearchPoint( ) function
Purpose
Searches for map objects at a specific x/y location.
Syntax
SearchPoint( map_window_id, x, y )
map_window_id is a Map window's integer ID number
x is an x-coordinate (for example, longitude)
522
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
y is a y-coordinate (for example, latitude)
Return Value
Integer, representing the number of objects found.
Description
The SearchPoint( ) function searches for map objects at a specific x/y location. The search applies
to all selectable layers in the Map window, even the Cosmetic layer (if it is currently selectable). The
return value indicates the number of objects found.
This function does not select any objects, nor does it affect the current selection. Instead, this
function builds a list of objects in memory. After calling SearchPoint( ), call the SearchInfo( )
function to process the search results.
The search allows for a small tolerance, identical to the tolerance allowed by MapInfo Professional's
Info tool. Points or linear objects that are very close to the location are included in the search results,
even if the user did not click on the exact location of the object.
To allow the user to select an x/y location with the mouse, use the Create ButtonPad statement or
the Alter ButtonPad statement to create a custom ToolButton. Use DM_CUSTOM_POINT as the
button's draw mode. Within the button's handler procedure, call the CommandInfo( ) function to
determine the x/y coordinates.
Example
For a code example, see the SearchInfo( ) function on page 519.
See Also
SearchInfo( ) function, SearchRect( ) function
SearchRect( ) function
Purpose
Searches for map objects within a rectangular area.
Syntax
SearchRect( map_window_id, x1, y1, x2, y2 )
map_window_id is a Map window's integer ID number.
x1, y1 are coordinates that specify one corner of a rectangle.
x2, y2 are coordinates that specify the opposite corner of a rectangle.
Return Value
Integer, representing the number of objects found.
Reference Guide
523
Second function
Description
The SearchRect( ) function searches for map objects within a rectangular area. The search applies
to all selectable layers in the Map window, even the Cosmetic layer (if it is currently selectable). The
return value indicates the number of objects found.
Note: This function does not select any objects, nor does it affect the current selection. Instead, this
function builds a list of objects in memory. After calling SearchRect( ) you call SearchInfo( )
function to process the search results.
The search behavior matches the behavior of MapInfo Professional's Marquee Select button: If an
object's centroid falls within the rectangle, the object is included in the search results.
To allow the user to select a rectangular area with the mouse, use the Create ButtonPad statement
or the Alter ButtonPad statement to create a custom ToolButton. Use DM_CUSTOM_RECT as the
button's draw mode. Within the button's handler procedure, call CommandInfo( ) function to
determine the x/y coordinates.
Example
For a code example, see the SearchInfo( ) function on page 519.
See Also
SearchInfo( ) function, SearchPoint( ) function
Second function
Purpose
Returns the second and millisecond component of a Time as a floating-point number.
Syntax
Second (Time)
Return Value
Number
Example
Copy this example into the MapBasic window for a demonstration of this function.
dim X as time
dim iSec as integer
X = CurDateTime()
Sec = Second(X)
Print iSec
524
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Seek( ) function
Purpose
Returns the current file position.
Syntax
Seek( filenum )
filenum is the number of an open file.
Return Value
Integer
Description
The Seek( ) function returns MapBasic's current position in an open file.
The filenum parameter represents the number of an open file; this is the same number specified in
the As clause of the Open File statement.
The integer value returned by the Seek( ) function represents a file position. If the file was opened in
random-access mode, Seek( ) returns a record number (the next record to be read or written). If the
file was opened in binary mode, Seek( ) returns the byte position of the next byte to be read from or
written to the file.
Error Conditions
ERR_FILEMGR_NOTOPEN error is generated if the specified file is not open.
See Also
Get statement, Open File statement, Put statement, Seek statement
Seek statement
Purpose
Sets the current file position, to prepare for the next file input/output operation.
Syntax
Seek [ # ]filenum, position
filenum is an integer value, indicating the number of an open file.
position is an integer value, indicating the desired file position.
Reference Guide
525
SelChangedHandler procedure
Description
The Seek statement resets the current file position of an open file. File input/output operations which
follow a Seek statement will read from (or write to) the location specified by the Seek.
If the file was opened in Random access mode, the position parameter specifies a record number.
If the file was opened in a sequential access mode, the position parameter specifies a specific byte
position; a position value of one represents the very beginning of the file.
See Also
Get statement, Input # statement, Open File statement, Print # statement, Put statement,
Seek( ) function, Write # statement
SelChangedHandler procedure
Purpose
A reserved procedure, called automatically when the set of selected rows changes.
Syntax
Declare Sub SelChangedHandler
Sub SelChangedHandler
statement_list
End Sub
statement_list is a list of statements to execute when the set of selected rows changes.
Description
SelChangedHandler is a special MapBasic procedure name. If the user runs an application with a
procedure named SelChangedHandler, the application “goes to sleep” when the Main procedure
runs out of statements to execute. The sleeping application remains in memory until the application
executes an End Program statement. As long as the application remains in memory, MapInfo
Professional automatically calls the SelChangedHandler procedure whenever the set of selected
rows changes.
Within the SelChangedHandler procedure, you can obtain information about recent changes made
to the selection by calling CommandInfo( ) function with one of the following codes:
attribute code
CMD_INFO_SELTYPE
526
CommandInfo( attribute ) returns:
1 if one row was added to the selection; 2 if one row was removed
from the selection;3 if multiple rows were added to the selection; 4 if
multiple rows were de-selected.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
attribute code
CommandInfo( attribute ) returns:
CMD_INFO_ROWID
Integer value: The number of the row which was selected or deselected (only applies if a single row was selected or de-selected).
CMD_INFO_INTERRUPT
Logical value: TRUE if the user interrupted a selection process by
pressing Esc; FALSE otherwise.
When any procedure in an application executes the End Program statement, the application is
completely removed from memory. Thus, you can use the End Program statement to terminate a
SelChangedHandler procedure once it is no longer wanted. Be careful not to issue an End
Program statement while the SelChangedHandler procedure is still needed.
Multiple MapBasic applications can be “sleeping” at the same time. When the Selection table
changes, MapBasic automatically calls all sleeping SelChangedHandler procedures, one after
another.
A SelChangedHandler procedure should not take actions that affect the GUI “focus” or reset the
current window. In other words, the SelChangedHandler procedure should not issue statements
such as a Note statement, Print statement, or Dialog statement.
See Also
CommandInfo( ) function, SelectionInfo( ) function
Select statement
Purpose
Selects particular rows and columns from one or more open tables, and treats the results as a
separate, temporary table. Also provides the ability to sort and sub-total data.
Syntax
Select expression_list
From table_name [ , ... ]
[ Into results_table [
[ Group By column_list
[ Order By column_list
[ Where expression_group ]
Noselect ] ]
]
]
expression_list is a comma-separated list of expressions which will comprise the columns of the
Selection results.
expression_group is a list of one or more expressions, separated by the keywords AND or OR.
table_name is the name of an open table.
results_table is the name of the table where query results should be stored.
column_list is a list of one or more names of columns, separated by commas.
Reference Guide
527
Select statement
Description
The Select statement provides MapBasic programmers with the capabilities of MapInfo
Professional's Query > SQL Select dialog box.
The MapBasic Select statement is modeled after the Select statement in the Structured Query
Language (SQL). Thus, if you have used SQL-oriented database software, you may already be
familiar with the Select statement. Note, however, that MapBasic's Select statement includes
geographic capabilities that you will not find in other packages.
Column expressions (for example, tablename.columnname) in a Select statement may only refer to
tables that are listed in the Select statement's From clause. For example, a Select statement may
only incorporate the column expression STATES.OBJ if the table STATES is included in the
statement's From clause.
The Select statement serves a variety of different purposes. One Select statement might apply a
test to a table, making it easy to browse only the records which met the criteria (this is sometimes
referred to as filtering). Alternately, Select might be used to calculate totals or subtotals for an entire
table. Select can also: sort the rows of a table; derive new column values from one or more existing
columns; or combine columns from two or more tables into a single results table.
Generally speaking, a Select statement queries one or more open tables, and selects some or all of
the rows from said table(s). The Select statement then treats the group of selected rows as a results
table; Selection is the default name of this table (although the results table can be assigned another
name through the Into clause). Following a Select statement, a MapBasic program—or, for that
matter, a MapInfo Professional user—can treat the results table as any other MapInfo table.
After issuing a Select statement, a MapBasic program can use the SelectionInfo( ) function to
examine the current selection.
The Select statement format includes several clauses, most of which are optional. The nature and
function of a Select statement depend upon which clauses are included. For example: if you wish to
use a Select statement to set up a filter, you should include a Where clause; if you wish to use a
Select statement to subtotal the values in the table, you should include a Group By clause; if you
want MapBasic to sort the results of the Select statement, you should include an Order By clause.
Note that these clauses are not mutually exclusive; one Select statement may include all of the
optional clauses.
Select clause
This clause dictates which columns MapBasic should include in the results table. The simplest type
of expression_list is an asterisk character (“*”). The asterisk signifies that all columns should be
included in the results. The statement:
Select * From world
tells MapBasic to include all of the columns from the “world” table in the results table. Alternately, the
expression_list clause can consist of a list of expressions, separated by commas, each of which
represents one column to include in the results table. Typically, each of these expressions involves
the names of one or more columns from the table in question. Very often, MapBasic function calls
and/or operators are used to derive some new value from one or more of the column names.
528
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
For example, the following Select statement specifies an expression_list clause with two
expressions:
Select country, Round(population,1000000)
From world
The expression_list above consists of two expressions, the first of which is a simple column name
(country), and the second of which is a function call (Round( )) which operates on another column
(population).
After MapBasic carries out the above Select statement, the first column in the results table will
contain values from the world table's name column. The second column in the results table will
contain values from the world table's population column, rounded off to the nearest million.
Each expression in the expression_list clause can be explicitly named by having an alias follow the
expression; this alias would appear, for example, at the top of a Browser window displaying the
appropriate table. The following statement would assign the field alias “Millions” to the second
column of the results table:
Select country,Round(population,1000000) "Millions"
From world
Any mappable table also has a special column, called object (or obj for short). If you include the
column expression obj in the expression_list, the resultant table will include a column which
indicates what type of object (if any) is attached to that row.
The expression_list may include either an asterisk or a list of column expressions, but not both. If an
asterisk appears following the keyword Select, then that asterisk must be the only thing in the
expression_list. In other words, the following statement would not be legitimate:
Select *, object From world ' this won't work!
From clause
The From clause specifies which table(s) to select data from. If you are doing a multiple-table join,
the tables you are selecting from must be base tables, rather than the results of a previous query.
Where clause
One function of the Where clause is to specify which rows to select. Any expression can be used
(see Expressions section below). Note, however, that groups of two or more expressions must be
connected by the keywords And or Or, rather than being comma-separated. For example, a twoexpression Where clause might read like this:
Where Income > 15000 And Income < 25000
Note that the And operator makes the clause more restrictive (both conditions must evaluate as
TRUE for MapBasic to select a record), whereas the Or operator makes the clause less restrictive
(MapBasic will select a record if either of the expressions evaluates to TRUE).
By referring to the special column name object, a Where clause can test geographic aspects of each
row in a mappable table. Conversely, the expression “Not object” can be used to single out records
which do not have graphical objects attached.
Reference Guide
529
Select statement
For example, the following Where clause would tell MapBasic to select only those records which are
currently un-geocoded:
Where Not Object
If a Select statement is to use two or more tables, the statement must include a Where clause, and
the Where clause must include an expression which tells MapBasic how to join the two tables. Such
a join-related expression typically takes the form Where tablename1.field = tablename2.field, where
the two fields have corresponding values. The following example shows how you might join the
tables “States” and “City_1k.” The column City_1k.state contains two-letter state abbreviations which
match the abbreviations in the column States.state.
Where States.state = City_1k.state
Alternately, you can specify a geographic operator to tell MapInfo Professional how to join the two
tables.
Where states.obj Contains City_1k.obj
A Where clause can incorporate a subset of specific values by including the Any or All keyword.
The Any keyword defines a subset, for the sake of allowing the Where clause to test if a given
expression is TRUE for any of the values in the subset. Conversely, the All keyword defines a
subset, for the sake of allowing the Where clause to test if a given condition is true for all of the
values in the subset.
The following query selects any customer record whose state column contains “NY,” “MA,” or “PA.”
The Any( ) function functions the same way as the SQL “IN” operator.
Select * From customers
Where state = Any ("NY", "MA", "PA")
A Where clause can also include its own Select statement, to produce what is known as a subquery.
In the next example, we use two tables: “products” is a table of the various products which our
company sells, and “orders” is a table of the orders we have for our products. At any given time,
some of the products may be sold out. The task here is to figure out which orders we can fill, based
on which products are currently in stock. This query uses the logic, “select all orders which are not
among the list of items that are currently sold out.”
Select * From orders
Where partnum <>
All(Select partnum from products
where not instock)
On the second line of the query, the keyword Select appears a second time; this produces our subselect. The sub-select builds a list of the parts that are currently not in stock. The Where clause of
the main query then uses All( ) function to access the list of unavailable parts.
In the example above, the sub-select produces a set of values, and the main Select statement's
Where clause tests for inclusion in that set of values. Alternately, a sub-select might use an
aggregate operator to produce a single result.
The example below uses the Avg( ) aggregate operator to calculate the average value of the pop
field within the table states.
530
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Accordingly, the net result of the following Select statement is that all records having higher-thanaverage population are selected.
Select * From states
Where population >
(Select Avg(population) From states)
MapInfo Professional also supports the SQL keyword In. A Select statement can use the keyword In
in place of the operator sequence = Any. In other words, the following Where clause, which uses the
Any keyword:
Where state = Any ("NY", "MA", "PA")
is equivalent to the following Where clause, which uses the In keyword:
Where state In ("NY", "MA", "PA")
In a similar fashion, the keywords Not In may be used in place of the operator sequence: <> All.
Note: A single Select statement may not include multiple, non-nested subqueries. Additionally,
MapBasic's Select statement does not support “correlated subqueries.” A correlated
subquery involves the inner query referencing a variable from the outer query. Thus, the
inner query is reprocessed for each row in the outer table. Thus, the queries are correlated.
An example:
' Note: the following statement, which illustrates
' correlated subqueries, will NOT work in MapBasic
Select * from leads
Where lead.name =
(Select var.name From vars
Where lead.name = customer.name)
This limitation is primarily of interest to users who are already proficient in SQL queries, through the
use of other SQL-compatible database packages.
Into clause
This optional clause lets you name the results table. If no Into clause is specified, the resulting table
is named Selection. Note that when a subsequent operation references the Selection table, MapInfo
Professional will take a “snapshot” of the Selection table, and call the snapshot QUERYn (for
example, QUERY1).
If you include the Noselect keyword, the statement performs a query without changing the preexisting Selection table. Use the NoSelect keyword if you need to perform a query, but you do not
want to de-select whatever rows are already selected.
If you include the Noselect keyword, the query does not trigger the SelChangedHandler
procedure.
Reference Guide
531
Select statement
Group By clause
This optional clause specifies how to group the rows when performing aggregate functions (subtotalling). In a Group By clause, you typically specify a column name (or a list of column names);
MapBasic then builds a results table containing subtotals. For example, if you want to subtotal your
table on a state-by-state basis, your Group By clause should specify the name of a column which
contains state names. The Group By clause may not reference a function with a variable return
type, such as the ObjectInfo( ) function.
The aggregate functions Sum( ), Min( ), Max( ), Count(*), Avg( ), and WtAvg( ) allow you to
calculate aggregated results.
Note: These aggregate functions do not appear in the Group By clause. Typically, the Select
expression_list clause includes one or more of the aggregate functions listed above, while
the Group By clause indicates which column(s) to use in grouping the rows.
Suppose the Q4Sales table describes sales information for the fourth fiscal quarter. Each record in
this table contains information about the dollar amount of a particular sale. Each record's Territory
column indicates the name of the territory where the sale occurred. The following query counts how
many sales occurred within each territory, and calculates the sum total of all of the sales within each
territory.
Select territory, Count(*), Sum(amount)
From q4sales
Group By territory
The Group By clause tells MapBasic to group the table results according to the contents of the
Territory column, and then create a subtotal for each unique territory name. The expression list
following the keyword Select specifies that the results table should have three columns: the first
column will state the name of a territory; the second column will state the number of records in the
q4sales table “belonging to” that territory; and the third column of the results table will contain the
sum of the Amount columns of all records belonging to that territory.
Note: The Sum( ) function requires a parameter, to tell it which column to summarize. The Count( )
function, however, simply takes an asterisk as its parameter; this tells MapBasic to simply
count the number of records within that sub-totalled group. The Count( ) function is the only
aggregate function that does not require a column identifier as its parameter.
The following table describes MapInfo Professional's aggregate functions.
Function name
532
Description
Avg( column )
Returns the average value of the specified column.
Count( * )
Returns the number of rows in the group. Specify * (asterisk)
instead of column name.
Max( column )
Returns the largest value of the specified column for all rows
in the group.
Min( column )
Returns the smallest value of the specified column for all
rows in the group.
MapBasic 9.0
Chapter 3: A-Z MapBasic Language Reference
Function name
Description
Sum( column )
Returns the sum of the column values for all rows in the
group.
WtAvg( column , weight_column )
Returns the average of the column values, weighted. See
below.
Calculating Weighted Averages
Use the Wtavg( ) aggregate function to calculate weighted averages. For example, the following
statement uses the Wtavg( ) function to calculate a weighted average of the literacy rate in each
continent:
Select continent, Sum(pop_1994), WtAvg(literacy, Pop_1994)
From World
Group By continent
Into Lit_query
Because of the Group By clause, MapInfo Professional groups rows of the table together, according
to the values in the Continent column. All rows having “North America” in the Continent column will
be treated as one group; all rows having “Asia” in the Continent column will be treated as another
group; etc. For each group of rows—in other words, for each continent—MapInfo Professional
calculates a weighted average of the literacy rates.
A simple average (using the Avg( ) function) calculates the sum divided by the count. A weighted
ave