Scribd
Upload
3K views

MQL 5

Programing Language

Uploaded by

Paldamo
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
3K views

MQL 5

Programing Language

Uploaded by

Paldamo
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1791

METAQUOTES LANGUAGE 5

REFERENCE
for the MetaTrader 5 client terminal

STUDY MQL5 and


SOLVE any tasks:

• Create your own technical analysis indicators


of any complexity

• Use autotrading - automate trading systems


to work on various financial markets

• Develop your own analytical tools based on


mathematical achievements and traditional
methods

• Write information trading systems for solving


a wide range of tasks (trading, monitoring,
alerting, etc.)
2 Содержание

Content
MQL5 Reference 27
1 Language Basics................................................................................................. 28
Sy ntax ............................................................................................................................29
Comments......................................................................................................................... 30
Identifiers......................................................................................................................... 31
Reserved .........................................................................................................................
Words 32
Data Ty pes ............................................................................................................................33
Integer Types
......................................................................................................................... 34
Char, Short, Int
................................................................................................................
and Long Types 35
Character Constants
................................................................................................................ 38
Datetime Type ................................................................................................................ 41
Color Type ................................................................................................................ 42
Bool Type ................................................................................................................ 43
Enumerations................................................................................................................ 44
Real Types......................................................................................................................... 46
String Type
......................................................................................................................... 51
Structures.........................................................................................................................
and Classes 53
Dynamic Array
.........................................................................................................................
Object 58
Typecasting
......................................................................................................................... 60
Void Type.........................................................................................................................
and NULL Constant 66
Object Pointers
......................................................................................................................... 67
Reference..........................................................................................................................
Modifier & and Keyword this 68
............................................................................................................................70
Operations and Expressions
Expressions
......................................................................................................................... 71
Arithmetical
.........................................................................................................................
Operations 72
Assignment.........................................................................................................................
Operations 73
Operations.........................................................................................................................
of Relation 74
Boolean Operations
......................................................................................................................... 75
Bitwise Operations
......................................................................................................................... 76
Other Operations
......................................................................................................................... 79
Precedence.........................................................................................................................
Rules 83
Operators ............................................................................................................................85
Compound.........................................................................................................................
Operator 87
Expression.........................................................................................................................
Operator 88
Return Operator
......................................................................................................................... 89
Conditional
.........................................................................................................................
Operator if-else 90
Conditional
.........................................................................................................................
Operator ?: 91
Switch Operator
......................................................................................................................... 92
Loop Operator
.........................................................................................................................
while 94
Loop Operator
.........................................................................................................................
for 95
Loop Operator
.........................................................................................................................
do while 96
Break Operator
......................................................................................................................... 97
Continue Operator
......................................................................................................................... 98
Object Create
.........................................................................................................................
Operator new 99
Object Delete
.........................................................................................................................
Operator delete 100
Functions ............................................................................................................................101
Function.........................................................................................................................
Call 103
Passing Parameters
......................................................................................................................... 104
Reloading.........................................................................................................................
Functions 107
Description
.........................................................................................................................
of External Functions 110
Exporting.........................................................................................................................
Functions 111
Event Handling
.........................................................................................................................
Functions 112
V ariables ............................................................................................................................118

© 2000-2010, MetaQuotes Software Corp.


3 Содержание

Local Variables
......................................................................................................................... 120
Formal Parameters
......................................................................................................................... 122
Static Variables
......................................................................................................................... 124
Global Variables
......................................................................................................................... 125
Input Variables
......................................................................................................................... 126
Extern Variables
......................................................................................................................... 129
Initialization
.........................................................................................................................
of Variables 130
Visibility .........................................................................................................................
Scope and Lifetime of Variables 132
Creating.........................................................................................................................
and Deleting Objects 134
Preprocessor............................................................................................................................137
Declaration
.........................................................................................................................
of Constants 138
Program.........................................................................................................................
Properties 139
Including.........................................................................................................................
Files 143
Importing.........................................................................................................................
Functions 144
............................................................................................................................146
Object-Oriented Programming
Encapsulation
.........................................................................................................................
and Extensibility of Types 148
Inheritance
......................................................................................................................... 150
Polymorphism
......................................................................................................................... 153
Overload......................................................................................................................... 155
Virtual Functions
......................................................................................................................... 156
2 Standard Constants,
.................................................................................................
Enumerations and Structures 159
............................................................................................................................160
Chart Constants
Types of .........................................................................................................................
Chart Events 161
Chart Timeframes
......................................................................................................................... 164
Chart Properties
......................................................................................................................... 166
Positioning
.........................................................................................................................
Constants 170
Chart Representation
......................................................................................................................... 171
............................................................................................................................173
Objects Constants
Object Types
......................................................................................................................... 174
Object Properties
......................................................................................................................... 176
Methods .........................................................................................................................
of Object Binding 180
Chart Corner
......................................................................................................................... 184
Visibility .........................................................................................................................
of Objects 186
Levels of.........................................................................................................................
Elliott Wave 189
Gann Objects
......................................................................................................................... 190
Web Colors ......................................................................................................................... 192
Wingdings ......................................................................................................................... 194
............................................................................................................................195
Indicator Constants
Price Constants
......................................................................................................................... 196
Smoothing.........................................................................................................................
Methods 199
Indicators
.........................................................................................................................
Lines 200
Drawing .........................................................................................................................
Styles 202
Custom Indicator
.........................................................................................................................
Properties 206
Indicator.........................................................................................................................
Types 209
Data Type.........................................................................................................................
Identifiers 211
Environment ............................................................................................................................212
State
Client Terminal
.........................................................................................................................
Properties 213
Running MQL5
.........................................................................................................................
Program Properties 215
Symbol Properties
......................................................................................................................... 217
Account .........................................................................................................................
Properties 221
............................................................................................................................223
Trade Constants
History Database
.........................................................................................................................
Properties 224
Order Properties
......................................................................................................................... 225
Position .........................................................................................................................
Properties 229
Deal Properties
......................................................................................................................... 231
Trade Operation
.........................................................................................................................
Types 233
Trade Orders
.........................................................................................................................
in DOM 234
............................................................................................................................235
Named Constants

© 2000-2010, MetaQuotes Software Corp.


4 Содержание

Predefined
.........................................................................................................................
Macrosubstitutions 236
Mathematical
.........................................................................................................................
Constants 238
Numerical.........................................................................................................................
Type Constants 240
Uninitalization
.........................................................................................................................
Reason Codes 243
Checking.........................................................................................................................
Object Pointer 245
Other Constants
......................................................................................................................... 246
............................................................................................................................249
Data Structures
Structure .........................................................................................................................
of the Date Type 250
Structure .........................................................................................................................
of Input Parameters 251
History Data
.........................................................................................................................
Structure 252
DOM Structure
......................................................................................................................... 253
Trade Request
.........................................................................................................................
Structure 254
Structure .........................................................................................................................
of a Trade Request Result 258
Structure .........................................................................................................................
for Current Prices 261
............................................................................................................................262
Codes of Errors and W arnings
Trade Server
.........................................................................................................................
Return Codes 263
Compiler.........................................................................................................................
Warnings 265
Compilation
.........................................................................................................................
Errors 267
Runtime .........................................................................................................................
Errors 275
Input/Output............................................................................................................................282
Constants
File Opening
.........................................................................................................................
Аlags 283
In-File Position
......................................................................................................................... 285
Use of a .........................................................................................................................
Codepage 286
MessageBox......................................................................................................................... 287
3 MQL5 programs
................................................................................................. 289
............................................................................................................................290
Program Running
............................................................................................................................295
Client Terminal Events
............................................................................................................................297
Call of Imported Functions
............................................................................................................................299
Runtime Errors
4 Predefined Variables
................................................................................................. 300
_Digits ............................................................................................................................301
_Point ............................................................................................................................302
_LastError ............................................................................................................................303
_Period ............................................................................................................................304
_StopFlag ............................................................................................................................305
_Sy mbol ............................................................................................................................306
............................................................................................................................307
_UninitReason
5 Common Functions
................................................................................................. 308
Alert ............................................................................................................................309
............................................................................................................................310
CheckPointer
Comment ............................................................................................................................312
DebugBreak ............................................................................................................................314
............................................................................................................................315
ExpertRemove
GetPointer ............................................................................................................................317
............................................................................................................................321
GetTickCount
MessageBox............................................................................................................................322
............................................................................................................................323
PeriodSeconds
Play Sound ............................................................................................................................324
Print ............................................................................................................................325
PrintFormat............................................................................................................................326
............................................................................................................................331
ResetLastError
............................................................................................................................332
SetUserError
SendFTP ............................................................................................................................333
SendMail ............................................................................................................................334
Sleep ............................................................................................................................335
............................................................................................................................336
TerminalClose
ZeroMemory ............................................................................................................................338

© 2000-2010, MetaQuotes Software Corp.


5 Содержание

6 Array Functions
................................................................................................. 339
Array Bsearch............................................................................................................................340
Array Copy ............................................................................................................................342
Array Free ............................................................................................................................343
............................................................................................................................344
Array GetAsSeries
............................................................................................................................345
Array Initialize
............................................................................................................................346
Array IsDy namic
............................................................................................................................347
Array IsSeries
Array Maximum............................................................................................................................349
Array Minimum............................................................................................................................350
Array Range............................................................................................................................351
Array Resize ............................................................................................................................352
............................................................................................................................353
Array SetAsSeries
Array Size ............................................................................................................................356
Array Sort ............................................................................................................................357
7 Conversion Functions
................................................................................................. 358
............................................................................................................................360
CharToString
............................................................................................................................361
CharArray ToString
............................................................................................................................362
ColorToString
............................................................................................................................363
DoubleToString
............................................................................................................................364
IntegerToString
............................................................................................................................365
ShortToString
ShortArray............................................................................................................................366
ToString
............................................................................................................................367
TimeToString
............................................................................................................................368
NormalizeDouble
............................................................................................................................369
StringToCharArray
............................................................................................................................370
StringToColor
............................................................................................................................371
StringToDouble
............................................................................................................................372
StringToInteger
............................................................................................................................373
StringToShortArray
............................................................................................................................374
StringToTime
............................................................................................................................375
StringFormat
8 Math Functions
................................................................................................. 376
MathAbs ............................................................................................................................377
MathArccos............................................................................................................................378
MathArcsin............................................................................................................................379
MathArctan............................................................................................................................380
MathCeil ............................................................................................................................381
MathCos ............................................................................................................................382
MathExp ............................................................................................................................383
MathFloor ............................................................................................................................384
MathLog ............................................................................................................................385
MathLog10 ............................................................................................................................386
MathMax ............................................................................................................................387
MathMin ............................................................................................................................388
MathMod ............................................................................................................................389
MathPow ............................................................................................................................390
MathRand ............................................................................................................................391
MathRound............................................................................................................................392
MathSin ............................................................................................................................393
MathSqrt ............................................................................................................................394
MathSrand ............................................................................................................................395
MathTan ............................................................................................................................396
............................................................................................................................397
MathIsV alidNumber
9 String Functions
................................................................................................. 398
StringAdd ............................................................................................................................399
............................................................................................................................401
StringBufferLen

© 2000-2010, MetaQuotes Software Corp.


6 Содержание

............................................................................................................................402
StringConcatenate
StringFill ............................................................................................................................403
StringFind ............................................................................................................................404
............................................................................................................................405
StringGetCharacter
StringInit ............................................................................................................................406
StringLen ............................................................................................................................407
............................................................................................................................408
StringSetCharacter
............................................................................................................................410
StringSubstr
StringToLow............................................................................................................................411
er
............................................................................................................................412
StringToUpper
............................................................................................................................413
StringTrimLeft
............................................................................................................................414
StringTrimRight
10 Date and Time................................................................................................. 415
TimeCurrent............................................................................................................................416
............................................................................................................................417
TimeTradeServer
TimeLocal ............................................................................................................................418
TimeGMT ............................................................................................................................419
............................................................................................................................420
TimeDay lightSavings
............................................................................................................................421
TimeGMTOffset
............................................................................................................................422
TimeToStruct
............................................................................................................................423
StructToTime
11 Account Information
................................................................................................. 424
............................................................................................................................425
AccountInfoDouble
............................................................................................................................426
AccountInfoInteger
............................................................................................................................428
AccountInfoString
12 Checkup ................................................................................................. 429
GetLastError............................................................................................................................430
IsStopped ............................................................................................................................431
............................................................................................................................432
UninitializeReason
............................................................................................................................433
TerminalInfoInteger
............................................................................................................................434
TerminalInfoString
............................................................................................................................435
MQL5InfoInteger
............................................................................................................................436
MQL5InfoString
Sy mbol ............................................................................................................................437
Period ............................................................................................................................438
Digits ............................................................................................................................439
Point ............................................................................................................................440
13 Market Info ................................................................................................. 441
............................................................................................................................442
Sy mbolsTotal
Sy mbolName............................................................................................................................443
............................................................................................................................444
Sy mbolSelect
Sy mbolIsSy............................................................................................................................445
nchronized
............................................................................................................................446
Sy mbolInfoDouble
............................................................................................................................448
Sy mbolInfoInteger
............................................................................................................................450
Sy mbolInfoString
............................................................................................................................451
Sy mbolInfoTick
............................................................................................................................452
MarketBookAdd
............................................................................................................................453
MarketBookRelease
............................................................................................................................454
MarketBookGet
14 Timeseries and
.................................................................................................
Indicators Access 455
Organizing ............................................................................................................................459
Data Access
............................................................................................................................468
SeriesInfoInteger
Bars ............................................................................................................................470
............................................................................................................................472
BarsCalculated
............................................................................................................................474
IndicatorCreate
............................................................................................................................476
IndicatorRelease

© 2000-2010, MetaQuotes Software Corp.


7 Содержание

Copy Buffer............................................................................................................................478
Copy Rates ............................................................................................................................482
Copy Time ............................................................................................................................484
Copy Open ............................................................................................................................486
Copy High ............................................................................................................................488
Copy Low ............................................................................................................................491
Copy Close ............................................................................................................................493
Copy TickV............................................................................................................................495
olume
............................................................................................................................498
Copy RealV olume
Copy Spread............................................................................................................................500
15 Chart Operations
................................................................................................. 503
ChartApply............................................................................................................................505
Template
............................................................................................................................507
ChartW indow Find
ChartOpen ............................................................................................................................509
ChartFirst ............................................................................................................................510
ChartNext ............................................................................................................................511
ChartClose ............................................................................................................................512
............................................................................................................................513
ChartSy mbol
ChartPeriod............................................................................................................................514
ChartRedraw............................................................................................................................515
............................................................................................................................516
ChartSetDouble
............................................................................................................................517
ChartSetInteger
............................................................................................................................518
ChartSetString
............................................................................................................................519
ChartGetDouble
............................................................................................................................521
ChartGetInteger
............................................................................................................................523
ChartGetString
............................................................................................................................525
ChartNavigate
ChartID ............................................................................................................................526
............................................................................................................................527
ChartW indow OnDropped
............................................................................................................................528
ChartPriceOnDropped
............................................................................................................................529
ChartTimeOnDropped
............................................................................................................................530
ChartX OnDropped
............................................................................................................................531
ChartY OnDropped
............................................................................................................................532
ChartSetSy mbolPeriod
............................................................................................................................533
ChartScreenShot
16 Trade Functions
................................................................................................. 534
OrderSend............................................................................................................................536
............................................................................................................................540
PositionsTotal
............................................................................................................................541
PositionGetSy mbol
............................................................................................................................542
PositionSelect
............................................................................................................................543
PositionGetDouble
............................................................................................................................544
PositionGetInteger
............................................................................................................................545
PositionGetString
OrdersTotal ............................................................................................................................546
............................................................................................................................547
OrderGetTicket
OrderSelect ............................................................................................................................549
............................................................................................................................550
OrderGetDouble
............................................................................................................................551
OrderGetInteger
............................................................................................................................552
OrderGetString
............................................................................................................................553
History Select
............................................................................................................................555
History OrderSelect
............................................................................................................................556
History OrdersTotal
............................................................................................................................557
History OrderGetTicket
............................................................................................................................559
History OrderGetDouble
............................................................................................................................560
History OrderGetInteger
............................................................................................................................561
History OrderGetString
............................................................................................................................562
History DealSelect
............................................................................................................................563
History DealsTotal

© 2000-2010, MetaQuotes Software Corp.


8 Содержание

............................................................................................................................564
History DealGetTicket
............................................................................................................................567
History DealGetDouble
............................................................................................................................568
History DealGetInteger
............................................................................................................................569
History DealGetString
17 Global Variables
.................................................................................................
of the Terminal 570
............................................................................................................................571
GlobalV ariableCheck
............................................................................................................................572
GlobalV ariableTime
............................................................................................................................573
GlobalV ariableDel
............................................................................................................................574
GlobalV ariableGet
............................................................................................................................575
GlobalV ariableName
............................................................................................................................576
GlobalV ariableSet
............................................................................................................................577
GlobalV ariablesFlush
............................................................................................................................578
GlobalV ariableTemp
............................................................................................................................579
GlobalV ariableSetOnCondition
............................................................................................................................580
GlobalV ariablesDeleteAll
............................................................................................................................581
GlobalV ariablesTotal
18 File Functions................................................................................................. 582
............................................................................................................................585
FileFindFirst
FileFindNext............................................................................................................................586
............................................................................................................................587
FileFindClose
FileIsExist ............................................................................................................................588
FileOpen ............................................................................................................................589
FileClose ............................................................................................................................591
FileCopy ............................................................................................................................592
FileDelete ............................................................................................................................593
FileMove ............................................................................................................................594
FileFlush ............................................................................................................................595
FileIsEnding............................................................................................................................596
............................................................................................................................597
FileIsLineEnding
............................................................................................................................598
FileReadArray
FileReadBool............................................................................................................................599
............................................................................................................................600
FileReadDatetime
............................................................................................................................601
FileReadDouble
............................................................................................................................602
FileReadFloat
............................................................................................................................603
FileReadInteger
FileReadLong............................................................................................................................604
............................................................................................................................605
FileReadNumber
............................................................................................................................606
FileReadString
............................................................................................................................607
FileReadStruct
FileSeek ............................................................................................................................608
FileSize ............................................................................................................................609
FileTell ............................................................................................................................610
FileW rite ............................................................................................................................611
............................................................................................................................612
FileW riteArray
............................................................................................................................613
FileW riteDouble
............................................................................................................................614
FileW riteFloat
............................................................................................................................615
FileW riteInteger
............................................................................................................................616
FileW riteLong
............................................................................................................................617
FileW riteString
............................................................................................................................618
FileW riteStruct
FolderCreate............................................................................................................................619
FolderDelete............................................................................................................................620
FolderClean ............................................................................................................................621
19 Custom Indicators
................................................................................................. 622
Connection............................................................................................................................626
betw een Indicator Properties and Functions
............................................................................................................................628
SetIndexBuffer
............................................................................................................................631
IndicatorSetDouble

© 2000-2010, MetaQuotes Software Corp.


9 Содержание

............................................................................................................................632
IndicatorSetInteger
............................................................................................................................633
IndicatorSetString
............................................................................................................................634
PlotIndexSetDouble
............................................................................................................................635
PlotIndexSetInteger
............................................................................................................................639
PlotIndexSetString
............................................................................................................................640
PlotIndexGetInteger
20 Object Functions
................................................................................................. 643
............................................................................................................................645
ObjectCreate
ObjectName............................................................................................................................647
............................................................................................................................648
ObjectDelete
............................................................................................................................649
ObjectsDeleteAll
ObjectFind............................................................................................................................650
............................................................................................................................651
ObjectGetTimeBy V alue
ObjectGetV............................................................................................................................652
alueBy Time
ObjectMove............................................................................................................................653
............................................................................................................................654
ObjectsTotal
............................................................................................................................655
ObjectSetDouble
............................................................................................................................658
ObjectSetInteger
............................................................................................................................659
ObjectSetString
............................................................................................................................660
ObjectGetDouble
............................................................................................................................661
ObjectGetInteger
............................................................................................................................662
ObjectGetString
21 Technical Indicators
................................................................................................. 664
iAC ............................................................................................................................666
iAD ............................................................................................................................667
iADX ............................................................................................................................668
iADX W ilder............................................................................................................................669
iAlligator ............................................................................................................................670
iAMA ............................................................................................................................672
iAO ............................................................................................................................673
iATR ............................................................................................................................674
iBearsPow er............................................................................................................................675
iBands ............................................................................................................................676
iBullsPow er............................................................................................................................677
iCCI ............................................................................................................................678
iChaikin ............................................................................................................................679
iCustom ............................................................................................................................680
iDEMA ............................................................................................................................683
iDeMarker ............................................................................................................................684
iEnvelopes ............................................................................................................................685
iForce ............................................................................................................................686
iFractals ............................................................................................................................687
iFrAMA ............................................................................................................................688
iGator ............................................................................................................................689
iIchimoku ............................................................................................................................691
iBW MFI ............................................................................................................................692
iMomentum............................................................................................................................693
iMFI ............................................................................................................................694
iMA ............................................................................................................................695
iOsMA ............................................................................................................................696
iMACD ............................................................................................................................697
iOBV ............................................................................................................................698
iSAR ............................................................................................................................699
iRSI ............................................................................................................................700
iRV I ............................................................................................................................701
iStdDev ............................................................................................................................702
iStochastic ............................................................................................................................703
iTEMA ............................................................................................................................704

© 2000-2010, MetaQuotes Software Corp.


10 Содержание

iTriX ............................................................................................................................705
iW PR ............................................................................................................................706
iV IDy A ............................................................................................................................707
iV olumes ............................................................................................................................708
22 Working with events
................................................................................................. 709
............................................................................................................................710
EventSetTimer
............................................................................................................................711
EventKillTimer
............................................................................................................................712
EventChartCustom
23 Standard Library
................................................................................................. 716
Basic Class ............................................................................................................................717
CObject
Prev ......................................................................................................................... 718
Prev ......................................................................................................................... 719
Next ......................................................................................................................... 720
Next ......................................................................................................................... 721
Compare......................................................................................................................... 722
Save ......................................................................................................................... 724
Load ......................................................................................................................... 726
Type ......................................................................................................................... 728
............................................................................................................................729
Classes of data
CArray ......................................................................................................................... 730
Step ................................................................................................................ 731
Step ................................................................................................................ 732
Total ................................................................................................................ 733
Available ................................................................................................................ 734
Max ................................................................................................................ 735
IsSorted ................................................................................................................ 736
SortMode ................................................................................................................ 737
Clear ................................................................................................................ 738
Sort ................................................................................................................ 739
Save ................................................................................................................ 740
Load ................................................................................................................ 741
CArrayChar
......................................................................................................................... 742
Reserve ................................................................................................................ 744
Resize ................................................................................................................ 745
Shutdown ................................................................................................................ 746
Add ................................................................................................................ 747
AddArray ................................................................................................................ 748
AddArray ................................................................................................................ 749
Insert ................................................................................................................ 751
InsertArray ................................................................................................................ 752
InsertArray ................................................................................................................ 753
AssignArray ................................................................................................................ 755
AssignArray ................................................................................................................ 756
Update ................................................................................................................ 758
Shift ................................................................................................................ 759
Delete ................................................................................................................ 760
DeleteRange................................................................................................................ 761
At ................................................................................................................ 762
CompareArray ................................................................................................................ 764
CompareArray ................................................................................................................ 765
InsertSort ................................................................................................................ 766
Search ................................................................................................................ 767
SearchGreat................................................................................................................ 768
SearchLess ................................................................................................................ 769
SearchGreatOrEqual
................................................................................................................ 770
SearchLessOrEqual
................................................................................................................ 771
SearchFirst ................................................................................................................ 772
SearchLast ................................................................................................................ 773

© 2000-2010, MetaQuotes Software Corp.


11 Содержание

Save ................................................................................................................ 774


Load ................................................................................................................ 775
Type ................................................................................................................ 777
CArrayShort
......................................................................................................................... 778
Reserve ................................................................................................................ 780
Resize ................................................................................................................ 781
Shutdown ................................................................................................................ 782
Add ................................................................................................................ 783
AddArray ................................................................................................................ 784
AddArray ................................................................................................................ 785
Insert ................................................................................................................ 787
InsertArray ................................................................................................................ 788
InsertArray ................................................................................................................ 789
AssignArray ................................................................................................................ 791
AssignArray ................................................................................................................ 792
Update ................................................................................................................ 794
Shift ................................................................................................................ 795
Delete ................................................................................................................ 796
DeleteRange................................................................................................................ 797
At ................................................................................................................ 798
CompareArray ................................................................................................................ 800
CompareArray ................................................................................................................ 801
InsertSort ................................................................................................................ 802
Search ................................................................................................................ 803
SearchGreat................................................................................................................ 804
SearchLess ................................................................................................................ 805
SearchGreatOrEqual
................................................................................................................ 806
SearchLessOrEqual
................................................................................................................ 807
SearchFirst ................................................................................................................ 808
SearchLast ................................................................................................................ 809
Save ................................................................................................................ 810
Load ................................................................................................................ 812
Type ................................................................................................................ 814
CArrayInt......................................................................................................................... 815
Reserve ................................................................................................................ 817
Resize ................................................................................................................ 818
Shutdown ................................................................................................................ 819
Add ................................................................................................................ 820
AddArray ................................................................................................................ 821
AddArray ................................................................................................................ 822
Insert ................................................................................................................ 824
InsertArray ................................................................................................................ 825
InsertArray ................................................................................................................ 826
AssignArray ................................................................................................................ 828
AssignArray ................................................................................................................ 829
Update ................................................................................................................ 831
Shift ................................................................................................................ 832
Delete ................................................................................................................ 833
DeleteRange................................................................................................................ 834
At ................................................................................................................ 835
CompareArray ................................................................................................................ 837
CompareArray ................................................................................................................ 838
InsertSort ................................................................................................................ 839
Search ................................................................................................................ 840
SearchGreat................................................................................................................ 841
SearchLess ................................................................................................................ 842
SearchGreatOrEqual
................................................................................................................ 843
SearchLessOrEqual
................................................................................................................ 844

© 2000-2010, MetaQuotes Software Corp.


12 Содержание

SearchFirst ................................................................................................................ 845


SearchLast ................................................................................................................ 846
Save ................................................................................................................ 847
Load ................................................................................................................ 849
Type ................................................................................................................ 851
CArrayLong
......................................................................................................................... 852
Reserve ................................................................................................................ 854
Resize ................................................................................................................ 855
Shutdown ................................................................................................................ 856
Add ................................................................................................................ 857
AddArray ................................................................................................................ 858
AddArray ................................................................................................................ 859
Insert ................................................................................................................ 861
InsertArray ................................................................................................................ 862
InsertArray ................................................................................................................ 863
AssignArray ................................................................................................................ 865
AssignArray ................................................................................................................ 866
Update ................................................................................................................ 868
Shift ................................................................................................................ 869
Delete ................................................................................................................ 870
DeleteRange................................................................................................................ 871
At ................................................................................................................ 872
CompareArray ................................................................................................................ 874
CompareArray ................................................................................................................ 875
InsertSort ................................................................................................................ 876
Search ................................................................................................................ 877
SearchGreat................................................................................................................ 878
SearchLess ................................................................................................................ 879
SearchGreatOrEqual
................................................................................................................ 880
SearchLessOrEqual
................................................................................................................ 881
SearchFirst ................................................................................................................ 882
SearchLast ................................................................................................................ 883
Save ................................................................................................................ 884
Load ................................................................................................................ 886
Type ................................................................................................................ 888
CArrayFloat
......................................................................................................................... 889
Delta ................................................................................................................ 891
Reserve ................................................................................................................ 892
Resize ................................................................................................................ 893
Shutdown ................................................................................................................ 894
Add ................................................................................................................ 895
AddArray ................................................................................................................ 896
AddArray ................................................................................................................ 897
Insert ................................................................................................................ 899
InsertArray ................................................................................................................ 900
InsertArray ................................................................................................................ 901
AssignArray ................................................................................................................ 903
AssignArray ................................................................................................................ 904
Update ................................................................................................................ 906
Shift ................................................................................................................ 907
Delete ................................................................................................................ 908
DeleteRange................................................................................................................ 909
At ................................................................................................................ 910
CompareArray ................................................................................................................ 912
CompareArray ................................................................................................................ 913
InsertSort ................................................................................................................ 914
Search ................................................................................................................ 915
SearchGreat................................................................................................................ 916

© 2000-2010, MetaQuotes Software Corp.


13 Содержание

SearchLess ................................................................................................................ 917


SearchGreatOrEqual
................................................................................................................ 918
SearchLessOrEqual
................................................................................................................ 919
SearchFirst ................................................................................................................ 920
SearchLast ................................................................................................................ 921
Save ................................................................................................................ 922
Load ................................................................................................................ 924
Type ................................................................................................................ 926
CArrayDouble
......................................................................................................................... 927
Delta ................................................................................................................ 929
Reserve ................................................................................................................ 930
Resize ................................................................................................................ 931
Shutdown ................................................................................................................ 932
Add ................................................................................................................ 933
AddArray ................................................................................................................ 934
AddArray ................................................................................................................ 935
Insert ................................................................................................................ 937
InsertArray ................................................................................................................ 938
InsertArray ................................................................................................................ 939
AssignArray ................................................................................................................ 941
AssignArray ................................................................................................................ 942
Update ................................................................................................................ 944
Shift ................................................................................................................ 945
Delete ................................................................................................................ 946
DeleteRange................................................................................................................ 947
At ................................................................................................................ 948
CompareArray ................................................................................................................ 950
CompareArray ................................................................................................................ 951
InsertSort ................................................................................................................ 952
Search ................................................................................................................ 953
SearchGreat................................................................................................................ 954
SearchLess ................................................................................................................ 955
SearchGreatOrEqual
................................................................................................................ 956
SearchLessOrEqual
................................................................................................................ 957
SearchFirst ................................................................................................................ 958
SearchLast ................................................................................................................ 959
Save ................................................................................................................ 960
Load ................................................................................................................ 962
Type ................................................................................................................ 964
CArrayString
......................................................................................................................... 965
Reserve ................................................................................................................ 967
Resize ................................................................................................................ 968
Shutdown ................................................................................................................ 969
Add ................................................................................................................ 970
AddArray ................................................................................................................ 971
AddArray ................................................................................................................ 972
Insert ................................................................................................................ 974
InsertArray ................................................................................................................ 975
InsertArray ................................................................................................................ 976
AssignArray ................................................................................................................ 978
AssignArray ................................................................................................................ 979
Update ................................................................................................................ 981
Shift ................................................................................................................ 982
Delete ................................................................................................................ 983
DeleteRange................................................................................................................ 984
At ................................................................................................................ 985
CompareArray ................................................................................................................ 987
CompareArray ................................................................................................................ 988

© 2000-2010, MetaQuotes Software Corp.


14 Содержание

InsertSort ................................................................................................................ 989


Search ................................................................................................................ 990
SearchGreat................................................................................................................ 991
SearchLess ................................................................................................................ 992
SearchGreatOrEqual
................................................................................................................ 993
SearchLessOrEqual
................................................................................................................ 994
SearchFirst ................................................................................................................ 995
SearchLast ................................................................................................................ 996
Save ................................................................................................................ 997
Load ................................................................................................................ 999
Type ................................................................................................................ 1001
CArrayObj
......................................................................................................................... 1002
FreeMode ................................................................................................................ 1007
FreeMode ................................................................................................................ 1008
Reserve ................................................................................................................ 1010
Resize ................................................................................................................ 1011
Clear ................................................................................................................ 1013
Shutdown ................................................................................................................ 1014
CreateElement................................................................................................................ 1015
Add ................................................................................................................ 1017
AddArray ................................................................................................................ 1018
Insert ................................................................................................................ 1021
InsertArray................................................................................................................ 1023
AssignArray................................................................................................................ 1025
Update ................................................................................................................ 1027
Shift ................................................................................................................ 1028
Detach ................................................................................................................ 1029
Delete ................................................................................................................ 1030
DeleteRange ................................................................................................................ 1031
At ................................................................................................................ 1032
CompareArray ................................................................................................................ 1033
InsertSort ................................................................................................................ 1034
Search ................................................................................................................ 1035
SearchGreat ................................................................................................................ 1036
SearchLess................................................................................................................ 1037
SearchGreatOrEqual
................................................................................................................ 1038
SearchLessOrEqual
................................................................................................................ 1039
SearchFirst................................................................................................................ 1040
SearchLast................................................................................................................ 1041
Save ................................................................................................................ 1042
Load ................................................................................................................ 1043
Type ................................................................................................................ 1045
CList ......................................................................................................................... 1046
FreeMode ................................................................................................................ 1048
FreeMode ................................................................................................................ 1049
Total ................................................................................................................ 1051
IsSorted ................................................................................................................ 1052
SortMode ................................................................................................................ 1053
CreateElement................................................................................................................ 1054
Add ................................................................................................................ 1055
Insert ................................................................................................................ 1056
DetachCurrent................................................................................................................ 1058
DeleteCurrent................................................................................................................ 1059
Delete ................................................................................................................ 1060
Clear ................................................................................................................ 1061
IndexOf ................................................................................................................ 1062
GetFirstNode ................................................................................................................ 1063
GetPrevNode ................................................................................................................ 1064

© 2000-2010, MetaQuotes Software Corp.


15 Содержание

GetCurrentNode................................................................................................................ 1065
GetNextNode ................................................................................................................ 1066
GetLastNode ................................................................................................................ 1067
Sort ................................................................................................................ 1068
MoveToIndex ................................................................................................................ 1069
Exchange ................................................................................................................ 1070
CompareList ................................................................................................................ 1071
Search ................................................................................................................ 1072
Save ................................................................................................................ 1073
Load ................................................................................................................ 1075
Type ................................................................................................................ 1077
Classes for............................................................................................................................1078
Graphic Objects
CChartObject
......................................................................................................................... 1079
ChartId ................................................................................................................ 1081
Window ................................................................................................................ 1082
Name ................................................................................................................ 1083
NumPoints ................................................................................................................ 1084
Attach ................................................................................................................ 1085
SetPoint ................................................................................................................ 1086
Delete ................................................................................................................ 1087
Detach ................................................................................................................ 1088
ShiftObject................................................................................................................ 1089
ShiftPoint ................................................................................................................ 1090
Time ................................................................................................................ 1091
Price ................................................................................................................ 1093
Color ................................................................................................................ 1095
Style ................................................................................................................ 1096
Width ................................................................................................................ 1097
BackGround ................................................................................................................ 1098
Selected ................................................................................................................ 1099
Selectable ................................................................................................................ 1100
Description................................................................................................................ 1101
Timeframes................................................................................................................ 1102
CreateTime................................................................................................................ 1103
LevelsCount ................................................................................................................ 1104
LevelColor ................................................................................................................ 1105
LevelStyle ................................................................................................................ 1107
LevelWidth................................................................................................................ 1109
LevelValue ................................................................................................................ 1111
LevelDescription
................................................................................................................ 1113
GetInteger................................................................................................................ 1115
SetInteger................................................................................................................ 1117
GetDouble ................................................................................................................ 1119
SetDouble ................................................................................................................ 1121
GetString ................................................................................................................ 1123
SetString ................................................................................................................ 1125
Save ................................................................................................................ 1127
Load ................................................................................................................ 1128
Type ................................................................................................................ 1129
Objects.........................................................................................................................
Lines 1130
CChartObjectVLine
................................................................................................................ 1131
Create ........................................................................................................... 1132
Type ........................................................................................................... 1133
CChartObjectHLine
................................................................................................................ 1134
Create ........................................................................................................... 1135
Type ........................................................................................................... 1136
CChartObjectTrend
................................................................................................................ 1137
Create ........................................................................................................... 1138

© 2000-2010, MetaQuotes Software Corp.


16 Содержание

RayLeft ........................................................................................................... 1139


RayRight ........................................................................................................... 1140
Save ........................................................................................................... 1141
Load ........................................................................................................... 1142
Type ........................................................................................................... 1143
CChartObjectTrendByAngle
................................................................................................................ 1144
Create ........................................................................................................... 1145
Angle ........................................................................................................... 1146
Type ........................................................................................................... 1147
CChartObjectCycles
................................................................................................................ 1148
Create ........................................................................................................... 1149
Type ........................................................................................................... 1150
Objects.........................................................................................................................
Channels 1151
CChartObjectChannel
................................................................................................................ 1152
Create ........................................................................................................... 1153
Type ........................................................................................................... 1154
CChartObjectRegression
................................................................................................................ 1155
Create ........................................................................................................... 1156
Type ........................................................................................................... 1157
CChartObjectStdDevChannel
................................................................................................................ 1158
Create ........................................................................................................... 1159
Deviations........................................................................................................... 1160
Save ........................................................................................................... 1161
Load ........................................................................................................... 1162
Type ........................................................................................................... 1163
CChartObjectPitchfork
................................................................................................................ 1164
Create ........................................................................................................... 1165
Type ........................................................................................................... 1166
Gann Tools
......................................................................................................................... 1167
CChartObjectGannLine
................................................................................................................ 1168
Create ........................................................................................................... 1169
PipsPerBar........................................................................................................... 1170
Save ........................................................................................................... 1171
Load ........................................................................................................... 1172
Type ........................................................................................................... 1173
CChartObjectGannFan
................................................................................................................ 1174
Create ........................................................................................................... 1175
PipsPerBar........................................................................................................... 1176
Downtrend........................................................................................................... 1177
Save ........................................................................................................... 1178
Load ........................................................................................................... 1179
Type ........................................................................................................... 1180
CChartObjectGannGrid
................................................................................................................ 1181
Create ........................................................................................................... 1182
PipsPerBar........................................................................................................... 1183
Downtrend........................................................................................................... 1184
Save ........................................................................................................... 1185
Load ........................................................................................................... 1186
Type ........................................................................................................... 1187
Fibonacci
.........................................................................................................................
Tools 1188
CChartObjectFibo
................................................................................................................ 1189
Create ........................................................................................................... 1190
Type ........................................................................................................... 1191
CChartObjectFiboTimes
................................................................................................................ 1192
Create ........................................................................................................... 1193
Type ........................................................................................................... 1194
CChartObjectFiboFan
................................................................................................................ 1195
Create ........................................................................................................... 1196

© 2000-2010, MetaQuotes Software Corp.


17 Содержание

Type ........................................................................................................... 1197


CChartObjectFiboArc
................................................................................................................ 1198
Create ........................................................................................................... 1199
Scale ........................................................................................................... 1200
Ellipse ........................................................................................................... 1201
Save ........................................................................................................... 1202
Load ........................................................................................................... 1203
Type ........................................................................................................... 1204
CChartObjectFiboChannel
................................................................................................................ 1205
Create ........................................................................................................... 1206
Type ........................................................................................................... 1207
CChartObjectFiboExpansion
................................................................................................................ 1208
Create ........................................................................................................... 1209
Type ........................................................................................................... 1210
Elliott Tools
......................................................................................................................... 1211
CChartObjectElliottWave3
................................................................................................................ 1212
Create ........................................................................................................... 1213
Degree ........................................................................................................... 1214
Lines ........................................................................................................... 1215
Save ........................................................................................................... 1216
Load ........................................................................................................... 1217
Type ........................................................................................................... 1218
CChartObjectElliottWave5
................................................................................................................ 1219
Create ........................................................................................................... 1220
Type ........................................................................................................... 1222
Objects.........................................................................................................................
Shapes 1223
CChartObjectRectangle
................................................................................................................ 1224
Create ........................................................................................................... 1225
Type ........................................................................................................... 1226
CChartObjectTriangle
................................................................................................................ 1227
Create ........................................................................................................... 1228
Type ........................................................................................................... 1229
CChartObjectEllipse
................................................................................................................ 1230
Create ........................................................................................................... 1231
Type ........................................................................................................... 1232
Objects.........................................................................................................................
Arrows 1233
CChartObjectArrow
................................................................................................................ 1234
Create ........................................................................................................... 1235
ArrowCode........................................................................................................... 1237
Anchor ........................................................................................................... 1239
Save ........................................................................................................... 1241
Load ........................................................................................................... 1242
Type ........................................................................................................... 1243
Arrows with ................................................................................................................
fixed code 1244
Create ........................................................................................................... 1246
ArrowCode........................................................................................................... 1248
Type ........................................................................................................... 1249
Objects.........................................................................................................................
Controls 1250
CChartObjectText
................................................................................................................ 1251
Create ........................................................................................................... 1252
Angle ........................................................................................................... 1253
Font ........................................................................................................... 1254
FontSize ........................................................................................................... 1255
Anchor ........................................................................................................... 1256
Save ........................................................................................................... 1257
Load ........................................................................................................... 1258
Type ........................................................................................................... 1259
CChartObjectLabel
................................................................................................................ 1260

© 2000-2010, MetaQuotes Software Corp.


18 Содержание

Create ........................................................................................................... 1261


X_Distance........................................................................................................... 1262
Y_Distance........................................................................................................... 1263
X_Size ........................................................................................................... 1264
Y_Size ........................................................................................................... 1265
Corner ........................................................................................................... 1266
Time ........................................................................................................... 1267
Price ........................................................................................................... 1268
Save ........................................................................................................... 1269
Load ........................................................................................................... 1270
Type ........................................................................................................... 1271
CChartObjectEdit
................................................................................................................ 1272
Create ........................................................................................................... 1273
X_Size ........................................................................................................... 1274
Y_Size ........................................................................................................... 1275
BackColor ........................................................................................................... 1276
Angle ........................................................................................................... 1277
Save ........................................................................................................... 1278
Load ........................................................................................................... 1279
Type ........................................................................................................... 1280
CChartObjectButton
................................................................................................................ 1281
State ........................................................................................................... 1282
Save ........................................................................................................... 1283
Load ........................................................................................................... 1284
Type ........................................................................................................... 1285
CChartObjectSubChart
................................................................................................................ 1286
Create ........................................................................................................... 1288
X_Distance........................................................................................................... 1289
Y_Distance........................................................................................................... 1290
Corner ........................................................................................................... 1291
X_Size ........................................................................................................... 1292
Y_Size ........................................................................................................... 1293
Symbol ........................................................................................................... 1294
Period ........................................................................................................... 1295
Scale ........................................................................................................... 1296
DateScale ........................................................................................................... 1297
PriceScale ........................................................................................................... 1298
Time ........................................................................................................... 1299
Price ........................................................................................................... 1300
Save ........................................................................................................... 1301
Load ........................................................................................................... 1302
Type ........................................................................................................... 1303
CChartObjectBitmap
................................................................................................................ 1304
Create ........................................................................................................... 1305
BmpFile ........................................................................................................... 1306
Save ........................................................................................................... 1307
Load ........................................................................................................... 1308
Type ........................................................................................................... 1309
CChartObjectBmpLabel
................................................................................................................ 1310
Create ........................................................................................................... 1312
X_Distance........................................................................................................... 1313
Y_Distance........................................................................................................... 1314
Corner ........................................................................................................... 1315
X_Size ........................................................................................................... 1316
Y_Size ........................................................................................................... 1317
BmpFileOn ........................................................................................................... 1318
BmpFileOff........................................................................................................... 1319
State ........................................................................................................... 1320

© 2000-2010, MetaQuotes Software Corp.


19 Содержание

Time ........................................................................................................... 1321


Price ........................................................................................................... 1322
Save ........................................................................................................... 1323
Load ........................................................................................................... 1324
Type ........................................................................................................... 1325
Class for w............................................................................................................................1326
orking w ith chart
ChartID......................................................................................................................... 1330
Mode ......................................................................................................................... 1331
Foreground
......................................................................................................................... 1332
Shift ......................................................................................................................... 1333
ShiftSize
......................................................................................................................... 1334
AutoScroll
......................................................................................................................... 1335
Scale ......................................................................................................................... 1336
ScaleFix......................................................................................................................... 1337
ScaleFix_11
......................................................................................................................... 1338
FixedMax......................................................................................................................... 1339
FixedMin......................................................................................................................... 1340
PointsPerBar
......................................................................................................................... 1341
ScalePPB......................................................................................................................... 1342
ShowOHLC......................................................................................................................... 1343
ShowLineBid
......................................................................................................................... 1344
ShowLineAsk
......................................................................................................................... 1345
ShowLastLine
......................................................................................................................... 1346
ShowPeriodSep
......................................................................................................................... 1347
ShowGrid......................................................................................................................... 1348
ShowVolumes
......................................................................................................................... 1349
ShowObjectDescr
......................................................................................................................... 1350
ColorBackground
......................................................................................................................... 1351
ColorForeground
......................................................................................................................... 1352
ColorGrid
......................................................................................................................... 1353
ColorBarUp
......................................................................................................................... 1354
ColorBarDown
......................................................................................................................... 1355
ColorCandleBull
......................................................................................................................... 1356
ColorCandleBear
......................................................................................................................... 1357
ColorChartLine
......................................................................................................................... 1358
ColorVolumes
......................................................................................................................... 1359
ColorLineBid
......................................................................................................................... 1360
ColorLineAsk
......................................................................................................................... 1361
ColorLineLast
......................................................................................................................... 1362
ColorStopLevels
......................................................................................................................... 1363
VisibleBars
......................................................................................................................... 1364
WindowsTotal
......................................................................................................................... 1365
WindowIsVisible
......................................................................................................................... 1366
WindowHandle
......................................................................................................................... 1367
FirstVisibleBar
......................................................................................................................... 1368
WidthInBars
......................................................................................................................... 1369
WidthInPixels
......................................................................................................................... 1370
HeightInPixels
......................................................................................................................... 1371
PriceMin......................................................................................................................... 1372
PriceMax......................................................................................................................... 1373
Attach ......................................................................................................................... 1374
FirstChart
......................................................................................................................... 1375
NextChart
......................................................................................................................... 1376
Open ......................................................................................................................... 1377
Detach......................................................................................................................... 1378
Close ......................................................................................................................... 1379
Navigate......................................................................................................................... 1380
Symbol ......................................................................................................................... 1381

© 2000-2010, MetaQuotes Software Corp.


20 Содержание

Period ......................................................................................................................... 1382


Redraw......................................................................................................................... 1383
GetInteger
......................................................................................................................... 1384
SetInteger
......................................................................................................................... 1385
GetDouble......................................................................................................................... 1386
SetDouble......................................................................................................................... 1387
GetString......................................................................................................................... 1388
SetString......................................................................................................................... 1389
SetSymbolPeriod
......................................................................................................................... 1390
ApplyTemplate
......................................................................................................................... 1391
ScreenShot
......................................................................................................................... 1392
WindowOnDropped
......................................................................................................................... 1393
PriceOnDropped
......................................................................................................................... 1394
TimeOnDropped
......................................................................................................................... 1395
XOnDropped
......................................................................................................................... 1396
YOnDropped
......................................................................................................................... 1397
Save ......................................................................................................................... 1398
Load ......................................................................................................................... 1399
Type ......................................................................................................................... 1400
Classes for............................................................................................................................1401
file operations
CFile ......................................................................................................................... 1402
Handle ................................................................................................................ 1404
Filename ................................................................................................................ 1405
Flags ................................................................................................................ 1406
SetUnicode................................................................................................................ 1407
SetCommon................................................................................................................ 1408
Open ................................................................................................................ 1409
Close ................................................................................................................ 1410
Delete ................................................................................................................ 1411
IsExist ................................................................................................................ 1412
Copy ................................................................................................................ 1413
Move ................................................................................................................ 1414
Size ................................................................................................................ 1415
Tell ................................................................................................................ 1416
Seek ................................................................................................................ 1417
Flush ................................................................................................................ 1418
IsEnding ................................................................................................................ 1419
IsLineEnding ................................................................................................................ 1420
FolderCreate ................................................................................................................ 1421
FolderDelete ................................................................................................................ 1422
FolderClean................................................................................................................ 1423
FileFindFirst ................................................................................................................ 1424
FileFindNext ................................................................................................................ 1425
FileFindClose ................................................................................................................ 1426
CFileBin......................................................................................................................... 1427
Open ................................................................................................................ 1429
WriteChar ................................................................................................................ 1430
WriteShort................................................................................................................ 1431
WriteInteger ................................................................................................................ 1432
WriteLong ................................................................................................................ 1433
WriteFloat................................................................................................................ 1434
WriteDouble ................................................................................................................ 1435
WriteString................................................................................................................ 1436
WriteCharArray................................................................................................................ 1437
WriteShortArray
................................................................................................................ 1438
WriteIntegerArray
................................................................................................................ 1439
WriteLongArray................................................................................................................ 1440
WriteFloatArray
................................................................................................................ 1441

© 2000-2010, MetaQuotes Software Corp.


21 Содержание

WriteDoubleArray
................................................................................................................ 1442
WriteObject ................................................................................................................ 1443
ReadChar ................................................................................................................ 1444
ReadShort ................................................................................................................ 1445
ReadInteger ................................................................................................................ 1446
ReadLong ................................................................................................................ 1447
ReadFloat ................................................................................................................ 1448
ReadDouble................................................................................................................ 1449
ReadString................................................................................................................ 1450
ReadCharArray ................................................................................................................ 1451
ReadShortArray................................................................................................................ 1452
ReadIntegerArray
................................................................................................................ 1453
ReadLongArray ................................................................................................................ 1454
ReadFloatArray................................................................................................................ 1455
ReadDoubleArray
................................................................................................................ 1456
ReadObject................................................................................................................ 1457
CFileTxt......................................................................................................................... 1458
Open ................................................................................................................ 1459
WriteString................................................................................................................ 1460
ReadString................................................................................................................ 1461
............................................................................................................................1462
Class for String operations
CString......................................................................................................................... 1463
Str ................................................................................................................ 1465
Len ................................................................................................................ 1466
Copy ................................................................................................................ 1467
Fill ................................................................................................................ 1468
Assign ................................................................................................................ 1469
Append ................................................................................................................ 1470
Insert ................................................................................................................ 1471
Compare ................................................................................................................ 1472
CompareNoCase ................................................................................................................ 1473
Left ................................................................................................................ 1474
Right ................................................................................................................ 1475
Mid ................................................................................................................ 1476
Trim ................................................................................................................ 1477
TrimLeft ................................................................................................................ 1478
TrimRight ................................................................................................................ 1479
Clear ................................................................................................................ 1480
ToUpper ................................................................................................................ 1481
ToLower ................................................................................................................ 1482
Reverse ................................................................................................................ 1483
Find ................................................................................................................ 1484
FindRev ................................................................................................................ 1485
Remove ................................................................................................................ 1486
Replace ................................................................................................................ 1487
Classes for............................................................................................................................1488
w orking w ith Indicators
CIndicator
.........................................................................................................................
Base Class 1489
Handle ................................................................................................................ 1491
Name ................................................................................................................ 1492
Status ................................................................................................................ 1493
NumBuffers................................................................................................................ 1494
Timeframe ................................................................................................................ 1495
Symbol ................................................................................................................ 1496
Period ................................................................................................................ 1497
Create ................................................................................................................ 1498
BuffSize ................................................................................................................ 1499
GetData ................................................................................................................ 1500
Refresh ................................................................................................................ 1502

© 2000-2010, MetaQuotes Software Corp.


22 Содержание

PeriodStr ................................................................................................................ 1503


MethodStr ................................................................................................................ 1504
PriceStr ................................................................................................................ 1505
VolumeStr ................................................................................................................ 1506
CIndicatorBuffer
.........................................................................................................................
Auxiliary Class 1507
Size ................................................................................................................ 1508
Offset ................................................................................................................ 1509
Name ................................................................................................................ 1510
At ................................................................................................................ 1511
Refresh ................................................................................................................ 1512
Refresh_0_only
................................................................................................................ 1513
Trend Indicators
......................................................................................................................... 1514
CiADX ................................................................................................................ 1515
MaPeriod ........................................................................................................... 1516
Create ........................................................................................................... 1517
Main ........................................................................................................... 1518
Plus ........................................................................................................... 1519
Minus ........................................................................................................... 1520
Type ........................................................................................................... 1521
CiADXWilder ................................................................................................................ 1522
MaPeriod ........................................................................................................... 1523
Create ........................................................................................................... 1524
Main ........................................................................................................... 1525
Plus ........................................................................................................... 1526
Minus ........................................................................................................... 1527
Type ........................................................................................................... 1528
CiBands ................................................................................................................ 1529
MaPeriod ........................................................................................................... 1530
MaShift ........................................................................................................... 1531
Deviation ........................................................................................................... 1532
Applied ........................................................................................................... 1533
Create ........................................................................................................... 1534
Base ........................................................................................................... 1535
Upper ........................................................................................................... 1536
Lower ........................................................................................................... 1537
Type ........................................................................................................... 1538
CiEnvelopes................................................................................................................ 1539
MaPeriod ........................................................................................................... 1540
MaShift ........................................................................................................... 1541
MaMethod ........................................................................................................... 1542
Deviation ........................................................................................................... 1543
Applied ........................................................................................................... 1544
Create ........................................................................................................... 1545
Upper ........................................................................................................... 1546
Lower ........................................................................................................... 1547
Type ........................................................................................................... 1548
CiIchimoku................................................................................................................ 1549
TenkanSenPeriod
........................................................................................................... 1550
KijunSenPeriod
........................................................................................................... 1551
SenkouSpanBPeriod
........................................................................................................... 1552
Create ........................................................................................................... 1553
TenkanSen........................................................................................................... 1554
KijunSen ........................................................................................................... 1555
SenkouSpanA ........................................................................................................... 1556
SenkouSpanB ........................................................................................................... 1557
ChinkouSpan ........................................................................................................... 1558
Type ........................................................................................................... 1559
CiMA ................................................................................................................ 1560

© 2000-2010, MetaQuotes Software Corp.


23 Содержание

MaPeriod ........................................................................................................... 1561


MaShift ........................................................................................................... 1562
MaMethod ........................................................................................................... 1563
Applied ........................................................................................................... 1564
Create ........................................................................................................... 1565
Main ........................................................................................................... 1566
Type ........................................................................................................... 1567
CiSAR ................................................................................................................ 1568
SarStep ........................................................................................................... 1569
Maximum ........................................................................................................... 1570
Create ........................................................................................................... 1571
Main ........................................................................................................... 1572
Type ........................................................................................................... 1573
CiStdDev ................................................................................................................ 1574
MaPeriod ........................................................................................................... 1575
MaShift ........................................................................................................... 1576
MaMethod ........................................................................................................... 1577
Applied ........................................................................................................... 1578
Create ........................................................................................................... 1579
Main ........................................................................................................... 1580
Type ........................................................................................................... 1581
CiDEMA ................................................................................................................ 1582
MaPeriod ........................................................................................................... 1583
IndShift ........................................................................................................... 1584
Applied ........................................................................................................... 1585
Create ........................................................................................................... 1586
Main ........................................................................................................... 1587
Type ........................................................................................................... 1588
CiTEMA ................................................................................................................ 1589
MaPeriod ........................................................................................................... 1590
IndShift ........................................................................................................... 1591
Applied ........................................................................................................... 1592
Create ........................................................................................................... 1593
Main ........................................................................................................... 1594
Type ........................................................................................................... 1595
CiFrAMA ................................................................................................................ 1596
MaPeriod ........................................................................................................... 1597
IndShift ........................................................................................................... 1598
Applied ........................................................................................................... 1599
Create ........................................................................................................... 1600
Main ........................................................................................................... 1601
Type ........................................................................................................... 1602
CiAMA ................................................................................................................ 1603
MaPeriod ........................................................................................................... 1604
FastEmaPeriod
........................................................................................................... 1605
SlowEmaPeriod
........................................................................................................... 1606
IndShift ........................................................................................................... 1607
Applied ........................................................................................................... 1608
Create ........................................................................................................... 1609
Main ........................................................................................................... 1610
Type ........................................................................................................... 1611
CiVIDyA ................................................................................................................ 1612
CmoPeriod........................................................................................................... 1613
EmaPeriod ........................................................................................................... 1614
IndShift ........................................................................................................... 1615
Applied ........................................................................................................... 1616
Create ........................................................................................................... 1617
Main ........................................................................................................... 1618

© 2000-2010, MetaQuotes Software Corp.


24 Содержание

Type ........................................................................................................... 1619


Oscillators
......................................................................................................................... 1620
CiATR ................................................................................................................ 1621
MaPeriod ........................................................................................................... 1622
Create ........................................................................................................... 1623
Main ........................................................................................................... 1624
Type ........................................................................................................... 1625
CiBearsPower ................................................................................................................ 1626
MaPeriod ........................................................................................................... 1627
Create ........................................................................................................... 1628
Main ........................................................................................................... 1629
Type ........................................................................................................... 1630
CiBullsPower ................................................................................................................ 1631
MaPeriod ........................................................................................................... 1632
Create ........................................................................................................... 1633
Main ........................................................................................................... 1634
Type ........................................................................................................... 1635
CiCCI ................................................................................................................ 1636
MaPeriod ........................................................................................................... 1637
Applied ........................................................................................................... 1638
Create ........................................................................................................... 1639
Main ........................................................................................................... 1640
Type ........................................................................................................... 1641
CiChaikin ................................................................................................................ 1642
FastMaPeriod ........................................................................................................... 1643
SlowMaPeriod ........................................................................................................... 1644
MaMethod ........................................................................................................... 1645
Applied ........................................................................................................... 1646
Create ........................................................................................................... 1647
Main ........................................................................................................... 1648
Type ........................................................................................................... 1649
CiDeMarker................................................................................................................ 1650
MaPeriod ........................................................................................................... 1651
Create ........................................................................................................... 1652
Main ........................................................................................................... 1653
Type ........................................................................................................... 1654
CiForce ................................................................................................................ 1655
MaPeriod ........................................................................................................... 1656
MaMethod ........................................................................................................... 1657
Applied ........................................................................................................... 1658
Create ........................................................................................................... 1659
Main ........................................................................................................... 1660
Type ........................................................................................................... 1661
CiMACD ................................................................................................................ 1662
FastEmaPeriod........................................................................................................... 1663
SlowEmaPeriod........................................................................................................... 1664
SignalPeriod ........................................................................................................... 1665
Applied ........................................................................................................... 1666
Create ........................................................................................................... 1667
Main ........................................................................................................... 1668
Signal ........................................................................................................... 1669
Type ........................................................................................................... 1670
CiMomentum ................................................................................................................ 1671
MaPeriod ........................................................................................................... 1672
Applied ........................................................................................................... 1673
Create ........................................................................................................... 1674
Main ........................................................................................................... 1675
Type ........................................................................................................... 1676

© 2000-2010, MetaQuotes Software Corp.


25 Содержание

CiOsMA ................................................................................................................ 1677


FastEmaPeriod........................................................................................................... 1678
SlowEmaPeriod........................................................................................................... 1679
SignalPeriod ........................................................................................................... 1680
Applied ........................................................................................................... 1681
Create ........................................................................................................... 1682
Main ........................................................................................................... 1683
Type ........................................................................................................... 1684
CiRSI ................................................................................................................ 1685
MaPeriod ........................................................................................................... 1686
Applied ........................................................................................................... 1687
Create ........................................................................................................... 1688
Main ........................................................................................................... 1689
Type ........................................................................................................... 1690
CiRVI ................................................................................................................ 1691
MaPeriod ........................................................................................................... 1692
Create ........................................................................................................... 1693
Main ........................................................................................................... 1694
Signal ........................................................................................................... 1695
Type ........................................................................................................... 1696
CiStochastic ................................................................................................................ 1697
Kperiod ........................................................................................................... 1698
Dperiod ........................................................................................................... 1699
Slowing ........................................................................................................... 1700
MaMethod ........................................................................................................... 1701
PriceField ........................................................................................................... 1702
Create ........................................................................................................... 1703
Main ........................................................................................................... 1704
Signal ........................................................................................................... 1705
Type ........................................................................................................... 1706
CiWPR ................................................................................................................ 1707
CalcPeriod........................................................................................................... 1708
Create ........................................................................................................... 1709
Main ........................................................................................................... 1710
Type ........................................................................................................... 1711
CiTriX ................................................................................................................ 1712
MaPeriod ........................................................................................................... 1713
Applied ........................................................................................................... 1714
Create ........................................................................................................... 1715
Main ........................................................................................................... 1716
Type ........................................................................................................... 1717
Volume .........................................................................................................................
Indicators 1718
CiAD ................................................................................................................ 1719
Applied ........................................................................................................... 1720
Create ........................................................................................................... 1721
Main ........................................................................................................... 1722
Type ........................................................................................................... 1723
CiMFI ................................................................................................................ 1724
MaPeriod ........................................................................................................... 1725
Applied ........................................................................................................... 1726
Create ........................................................................................................... 1727
Main ........................................................................................................... 1728
Type ........................................................................................................... 1729
CiOBV ................................................................................................................ 1730
Applied ........................................................................................................... 1731
Create ........................................................................................................... 1732
Main ........................................................................................................... 1733
Type ........................................................................................................... 1734

© 2000-2010, MetaQuotes Software Corp.


26 Содержание

CiVolumes ................................................................................................................ 1735


Applied ........................................................................................................... 1736
Create ........................................................................................................... 1737
Main ........................................................................................................... 1738
Type ........................................................................................................... 1739
Bill Williams
.........................................................................................................................
Indicators 1740
CiAC ................................................................................................................ 1741
Create ........................................................................................................... 1742
Main ........................................................................................................... 1743
Type ........................................................................................................... 1744
CiAlligator ................................................................................................................ 1745
JawPeriod ........................................................................................................... 1746
JawShift ........................................................................................................... 1747
TeethPeriod ........................................................................................................... 1748
TeethShift ........................................................................................................... 1749
LipsPeriod ........................................................................................................... 1750
LipsShift ........................................................................................................... 1751
MaMethod ........................................................................................................... 1752
Applied ........................................................................................................... 1753
Create ........................................................................................................... 1754
Jaw ........................................................................................................... 1755
Teeth ........................................................................................................... 1756
Lips ........................................................................................................... 1757
Type ........................................................................................................... 1758
CiAO ................................................................................................................ 1759
Create ........................................................................................................... 1760
Main ........................................................................................................... 1761
Type ........................................................................................................... 1762
CiFractals ................................................................................................................ 1763
Create ........................................................................................................... 1764
Upper ........................................................................................................... 1765
Lower ........................................................................................................... 1766
Type ........................................................................................................... 1767
CiGator ................................................................................................................ 1768
JawPeriod ........................................................................................................... 1769
JawShift ........................................................................................................... 1770
TeethPeriod ........................................................................................................... 1771
TeethShift ........................................................................................................... 1772
LipsPeriod ........................................................................................................... 1773
LipsShift ........................................................................................................... 1774
MaMethod ........................................................................................................... 1775
Applied ........................................................................................................... 1776
Create ........................................................................................................... 1777
Upper ........................................................................................................... 1778
Lower ........................................................................................................... 1779
Type ........................................................................................................... 1780
CiBWMFI ................................................................................................................ 1781
Applied ........................................................................................................... 1782
Create ........................................................................................................... 1783
Main ........................................................................................................... 1784
Type ........................................................................................................... 1785
CIndicators
.........................................................................................................................
Classes Collection 1786
Create ................................................................................................................ 1787
Refresh ................................................................................................................ 1788
24 Moving from .................................................................................................
MQL4 1789

© 2000-2010, MetaQuotes Software Corp.


27

MQL5 Reference
MetaQuotes Language 5 (MQL5) is a built-in language for programming trading strategies. This
language is developed by MetaQuotes Software Corp. based on their long experience in the creation of
online trading platforms. Using this language, you can create your own Expert Advisors that make
trading management automated and are perfectly suitable for implementing your own trading
strategies. Besides, using MQL5 you can create your own technical indicators (custom indicators),
scripts and libraries.

MQL5 contains a large number of functions necessary for analyzing current and previously received
quotes, and has built-in basic indicators and functions for managing trade positions and controlling
them.

The MetaEditor 5 (text editor) that highlights different constructions of MQL5 language is used for
writing the program code. It helps users to orientate themselves in the expert system text quite
easily. MetaQuotes Language Dictionary is used as a Help System for MQL5 language.

The brief guide contains functions, operations, reserved words, and other language constructions
divided into categories, and allows finding the description of every used element of the language.

Programs written in MetaQuotes Language 5 have different features and purposes:

Expert Advisor is a mechanical trading system linked up to a certain chart. An Expert Advisor starts
to run when an event happens that can be handled by it: events of initialization and deinitialization,
event of a new tick receipt, a timer event, depth of market changing event, chart event and custom
events.
An Expert Advisor can both inform you about a possibility to trade and automatically trade on an
account sending orders directly to a trade server. Expert Advisors are stored in
terminal_directory\MQL5\Experts.
Custom Indicator is a technical indicator written independently in addition to those already
integrated into the client terminal. Like built-in indicators, they cannot trade automatically and are
intended for implementing of analytical functions only.
Custom indicators can't use functions for working with charts or chart objects. Custom indicators
are stored in terminal_directory\MQL5\Indicators
Script is a program intended for a single execution of some actions. Unlike Expert Advisors, scripts
do not process any actions, except for the start event (this requires the OnStart handler function in
a script). Scripts are stored in terminal_directory\MQL5\Scripts
Library is a set of custom functions intended for storing and distributing frequently used blocks of
custom programs. Libraries cannot start executing by themselves.
Libraries are stored in terminal_directory\MQL5\Libraries
Include File is a source text of the most frequently used blocks of custom programs. Such files can
be included into the source texts of Expert Advisors, scripts, custom indicators, and libraries at the
compiling stage. The use of included files is more preferable than the use of libraries because of
additional burden occurring at calling library functions.
Include files can be stored in the same directory as a source file - in this case the #include directive
with double quotes is used. Another place to store include files is terminal_directory\MQL5\Include,
in this case the #include directive is used with angle brackets.

© 2000-2010, MetaQuotes Software Corp.

© 2000-2010, MetaQuotes Software Corp.


28 Language Basics

Language Basics
The MetaQuotes Language 5 (MQL5) is an object-oriented high-level programming language
intended for writing automated trading strategies, custom technical indicators for the analysis of
various financial markets. It allows not only to write a variety of expert systems, designed to operate
in real time, but also create their own graphical tools to help you make trade decisions.

MQL5 is based on the concept of the popular programming language C++. As compared to MQL4, the
new language now has enumerations, structures, classes and event handling. By increasing the number
of embedded main types, the interaction of executable programs in MQL5 with other applications
through dll is now as easy as possible. MQL5 syntax is similar to the syntax of C++, and this makes it
easy to translate into it programs from modern programming languages.

To help you study the MQL% language, all topics are grouped into the following sections:

Syntax
Data Types
Operations and Expressions
Operators
Functions
Variables
Preprocessor
Object-Oriented Programming

© 2000-2010, MetaQuotes Software Corp.


29 Language Basics

Syntax
As to the syntax, THE MQL5 language for programming trading strategies is very much similar to
the C++ programming language, except for some features:

no address arithmetic;
no goto operator;
an anonymous enumeration can't be declared;
constructors of classes and structures can't have parameters;
no multiple inheritance.

© 2000-2010, MetaQuotes Software Corp.


30 Language Basics

Comments
Multi-line comments start with the /* pair of symbols and end with the */ one. Such kind of
comments cannot be nested. Single-line comments begin with the // pair of symbols and end with the
newline character, they can be nested in other multi-line comments. Comments are allowed
everywhere where the spaces are allowed, they can have any number of spaces in them.

Examples:

//--- Single-line comment


/* Multi-
line // Nested single-line comment
comment
*/

© 2000-2010, MetaQuotes Software Corp.


31 Language Basics

Identifiers
Identifiers are used as names of variables and functions. The length of the identifier can not exceed
31 characters.

Characters allowed ti be written in an identifier: figures 0-9, the Latin uppercase and lowercase
letters a-z and A-Z, recognized as different characters, the underscore character (_).The first
character can not be a digit.

The identifier must not coincide with reserved word.

Examples:

NAME1 namel Total_5 Paper

© 2000-2010, MetaQuotes Software Corp.


32 Language Basics

Reserved Words
The following identifiers are recorded as reserved words, each of them corresponds to a certain
action, and cannot be used in another meaning:

Data Types

bool enum struct

char float uchar

class int uint

color long ulong

datetime short ushort

double string void

Access Specificators

const private protected

public virtual

Memory Classes

extern input static

Operators

break do return

case else sizeof

continue for switch

default if while

delete new

Other

false #define #property

this #import

true #include

© 2000-2010, MetaQuotes Software Corp.


33 Language Basics

Data Types
Any program operates with data. Data can be of different types depending on their purposes. For
example, integer data are used to access to array components. Price data belong to those of double
precision with floating point. This is related to the fact that no special data type for price data is
provided in MQL5.

Data of different types are processed with different rates. Integer data are processed at the
fastest. To process the double precision data, a special co-processor is used. However, because of
complicity of internal presentation of data with floating point, they are processed slower than the
integer ones.

String data are processed at the longest because of dynamic computer memory allocation/
reallocation.

The basic data types are:

integers (char, short, int, long, uchar, ushort, uint, ulong);


logical (bool);
literals (char, uchar);
strings (string);
floating-point numbers (double, float);
color (color);
date and time (datetime);
enumerations (enum).

Complex data types are:

structures;
classes.

In terms of OOP complex data types called abstract data types.

The color and datetime types make sense only to facilitate visualization and input of parameters
defined from outside - from the table of Expert Advisor or custom indicator properties (the Inputs
tab). Data of color and datetime types are represented as integers. Integer types and floating-point
types are called arithmetic (numeric) types.

Only implicit type casting is used in expressions, unless the explicit casting is specified.

© 2000-2010, MetaQuotes Software Corp.


34 Language Basics

Integer Types
In MQL5 integers are represented by eleven types. Some types can be used together with other
ones, if required by the program logic, but in this case it's necessary to remember the rules of types
conversion.

The table below lists the characteristics of each type. Besides, the last column features a type in C+
+ corresponding to each type.

Type Size in Bytes Minimum Value Maximum Value C++ Analog

char 1 -128 127 char

uchar 1 0 255 unsigned char,


BYTE

bool 1 0(false) 1(true) bool

short 2 -32 768 32 767 short, wchar_t

ushort 2 0 65 535 unsigned short,


WORD

int 4 - 2 147 483 648 2 147 483 647 int

uint 4 0 4 294 967 295 unsigned int,


DWORD

color 4 -1 16 777 215 int, COLORREF

long 8 -9 223 372 036 9 223 372 036 __int64


854 775 808 854 775 807

ulong 8 0 18 446 744 073 unsigned __int64


709 551 615

datetime 8 0 (1970.01.01 32 535 244 799 __time64_t


0:00:00) (3000.12.31
23:59:59)

Integer type values can also be presented as numeric constants, color literals, date-time literals,
character constants and enumerations.

See also
Data Conversion, Constants of Numeric Types

© 2000-2010, MetaQuotes Software Corp.


35 Language Basics

Char, Short, Int and Long Types


char
The char type takes 1 byte of memory (8 bits) and allows expressing in the binary notation 2^8=256
values. The char type can contain both positive and negative values. The range of values is from -128
to 127.

uchar
The uchar integer type also occupies 1 byte of memory, as well as the char type, but unlike it uchar
is intended only for positive values. The minimum value is zero, the maximum value is 255. The first
letter u in the name of the uchar type is the abbreviation for unsigned.

short
The size of the short type is 2 bytes (16 bits) and, accordingly, it allows expressing the range of
values equal to 2 to the power 16: 2^16 = 65 536.Since the short type is a sign one, and contains both
positive and negative values, the range of values is between -32 768 and 32 767.

ushort
The unsigned short type is the type ushort, which also has a size of 2 bytes. The minimum value is
0, the maximum value is 65 535.

int
The size of the int type is 4 bytes (32 bits). The minimal value is -2 147 483 648, the maximal one
is 2 147 483 647.

uint
The unsigned integer type is uint. It takes 4 bytes of memory and allows expressing integers from 0
to 4 294 967 295.

long
The size of the long type is 8 bytes (64 bits). The minimum value is -9 223 372 036 854 775 808,
the maximum value is 9 223 372 036 854 775 807.

ulong
The ulong type also occupies 8 bytes and can store values from 0 to 18 446 744 073 709 551 615.

Examples:

char ch=12;
short sh=-5000;
int in=2445777;

© 2000-2010, MetaQuotes Software Corp.


36 Language Basics

Since the unsigned integer types are not designed for storing negative values, the attempt to set a
negative value can lead to unexpected consequences. Such a simple script will lead to an infinite loop:

//--- Infinite loop


void OnStart()
{
uchar u_ch;

for(char ch=-128;ch<128;ch++)
{
u_ch=ch;
Print("ch=",ch," u_ch=",u_ch);
}
}

The correct variant is:

//--- Correct variant


void OnStart()
{
uchar u_ch;

for(char ch=-128;ch<=127;ch++)
{
u_ch=ch;
Print("ch=",ch," u_ch=",u_ch);
if(ch==127) break;
}
}

Result:

ch= -128 u_ch= 128


ch= -127 u_ch= 129
ch= -126 u_ch= 130
ch= -125 u_ch= 131
ch= -124 u_ch= 132
ch= -123 u_ch= 133
ch= -122 u_ch= 134
ch= -121 u_ch= 135
ch= -120 u_ch= 136
ch= -119 u_ch= 137
ch= -118 u_ch= 138
ch= -117 u_ch= 139
ch= -116 u_ch= 140
ch= -115 u_ch= 141
ch= -114 u_ch= 142
ch= -113 u_ch= 143
ch= -112 u_ch= 144
ch= -111 u_ch= 145

© 2000-2010, MetaQuotes Software Corp.


37 Language Basics

...

Examples:

//--- Negative values can not be stored in unsigned types


uchar u_ch=-120;
ushort u_sh=-5000;
uint u_in=-401280;

Hexadecimal: numbers 0-9, the letters a-f or A-F for the values of 10-15; start with 0x or 0x.

Examples:

0x0A, 0x12, 0X12, 0x2f, 0xA3, 0Xa3, 0X7C7

© 2000-2010, MetaQuotes Software Corp.


38 Language Basics

Character Constants
Characters as elements of a string in MQL5 are indexes in the Unicode character set. They are
hexadecimal values that can be cast into integers, and that can be manipulated by integer operations
like addition and subtraction.

Any single character in quotation marks or a hexadecimal ASCII code of a character as '\x10' is a
character constant and is of ushort type. For example, a record of '0' type is a numerical value 30, that
corresponds to the index of zero in the table of characters.

Example:

void OnStart()
{
//--- define character constants
int symbol_0='0';
int symbol_9=symbol_0+9; // get symbol '9'
//--- output values of constants
printf("In a decimal form: symbol_0=%d, symbol_9=%d",symbol_0,symbol_9);
printf("In a hexadecimal form: symbol_0=0x%x, symbol_9=0x%x",symbol_0,symbol_9);
//--- enter constants into a string
string test="";
StringSetCharacter(test,0,symbol_0);
StringSetCharacter(test,1,symbol_9);
//--- this is what they look like in a string
Print(test);
}

A backslash is a control character for a compiler when dealing with constant strings and character
constants in a source text of a program. Some symbols, for example a single quote ('), double quotes
("), backslash (\) and control characters can be represented as a combination of symbols that start
with a backslash (\), according to the below table:

Character name Mnemonic code or Record in MQL5 Numeric value


image

new line (line feed) LF '\n' 13

horizontal tab HT '\t' 9

carriage return CR '\r' 10

backslash \ '\\' 92

single quote ' '\'' 39

double quote " '\"' 34

hexadecimal code hhhh '\xhhhh' 1 to 4 hexadecimal


characters

decimal code d '\d' decimal number from


0 to 65535

© 2000-2010, MetaQuotes Software Corp.


39 Language Basics

If a backslash is followed by a character other than those described above, result is undefined.

Example

void OnStart()
{
//--- declare character constants
int a='A';
int b='$';
int c='©'; // coed 0xA9
int d='\xAE'; // code of the symbol ®
//--- output print constants
Print(a,b,c,d);
//--- add a character to the string
string test="";
StringSetCharacter(test,0,a);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,b);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,c);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,d);
Print(test);
//--- represent characters as a number
int a1=65;
int b1=36;
int c1=169;
int d1=174;
//--- add a character to the string
StringSetCharacter(test,1,a1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,b1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,c1);
Print(test);
//--- add a character to the string
StringSetCharacter(test,1,d1);
Print(test);
}

As it was mentioned above, th value of a character constant (or variable) is an index in the table of
characters. Index being an integer, it can be written in different ways.

void OnStart()
{

© 2000-2010, MetaQuotes Software Corp.


40 Language Basics

//---
int a=0xAE; // the code of ® corresponds to the '\xAE' literal
int b=0x24; // the code of $ corresponds to the '\x24' literal
int c=0xA9; // the code of © corresponds to the '\xA9' literal
int d=0x263A; // the code of O corresponds to the '\x263A' literal
//--- show values
Print(a,b,c,d);
//--- add a character to the string
string test="";
StringSetCharacter(test,0,a);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,b);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,c);
Print(test);
//--- replace a character in a string
StringSetCharacter(test,0,d);
Print(test);
//--- codes of suits
int a1=0x2660;
int b1=0x2661;
int c1=0x2662;
int d1=0x2663;
//--- add a character of spades
StringSetCharacter(test,1,a1);
Print(test);
//--- add a character of hearts
StringSetCharacter(test,2,b1);
Print(test);
//--- add a character of diamonds
StringSetCharacter(test,3,c1);
Print(test);
//--- add a character of clubs
StringSetCharacter(test,4,d1);
Print(test);
//--- Example of character literals in a string
test="Queen\x2660Ace\x2662";
printf("%s",test);
}

The internal representation of a character literal is the ushort type. Character constants can accept
values from 0 to 65535.

See also
StringSetCharacter(), StringGetCharacter(), ShortToString(), ShortArrayToString(),
StringToShortArray()

© 2000-2010, MetaQuotes Software Corp.


41 Language Basics

Datetime Type
The datetime type is intended for storing the date and time as the number of seconds elapsed since
January 01, 1970. This type occupies 8 bytes of memory.

Constants of the date and time can be represented as a literal string, which consists of 6 parts
showing the numerical value of the year, month, day (or day, month, year), hours, minutes and
seconds. The constant is enclosed in single quotation marks and starts with the D character.

Either date (year , month, day) or time (hours, minutes, seconds), or all together can be omitted.
Values range from 1 January, 1970 to 31 December, 3000.

Examples:

D'2004.01.01 00:00' // New Year


D'1980.07.19 12:30:27'
D'19.07.1980 12:30:27'
D'19.07.1980 12' //equivalent to D'1980.07.19 12:00:00'
D'01.01.2004' //equivalent to D'01.01.2004 00:00:00'
D'12:30:27' //equivalent to D'[compilation date] 12:30:27'
D'' //equivalent to D'[compilation date] 00:00:00'

© 2000-2010, MetaQuotes Software Corp.


42 Language Basics

Color Type
The color type is intended for storing information about color and occupies 4 bytes in memory. The
first byte is ignored, the remaining 3 bytes contain the RGB-components.

Color constants can be represented in three ways: literally, by integers, or by name (for named
Web-colors only).

Literal representation consists of three parts representing numerical rate values of the three main
color components: red, green, blue. The constant starts with C and is enclosed in single quotes.
Numerical rate values of a color component lie in the range from 0 to 255.

Integer-valued representation is written in a form of hexadecimal or a decimal number. A


hexadecimal number looks like 0x00BBGGRR, where RR is the rate of the red color component, GG - of
the green one, and BB - of the blue one. Decimal constants are not directly reflected in the RGB. They
represent a decimal value of the hexadecimal integer representation.

Specific colors reflect the so-called Web-colors set.

Examples:

//--- Literals
C'128,128,128' // Gray
C'0x00,0x00,0xFF' // Blue
//color names
Red // Red
Yellow // Yellow
Black // Black
//--- Integral representations
0xFFFFFF // White
16777215 // White
0x008000 // Green
32768 // Green

© 2000-2010, MetaQuotes Software Corp.


43 Language Basics

Bool Type
The bool type is intended to store the logical values of true or false, numeric representation of them
is 1 or 0, respectively.

Examples:

bool a = true;
bool b = false;
bool c = 1;

The internal representation is a whole number 1 byte large. It should be noted that in logical
expressions you can use other integer or real types or expressions of these types - the compiler will
not generate any error. In this case, the zero value will be interpreted as false, and all other values -
as true.

Examples:

int i=5;
double d=-2.5;
if(i) Print("i=",i,"and is set to true");
else Print("i=",i,"and is set to false");

if(d) Print("d=",d,"and has the true value");


else Print("d=",d,"and has the false value");

i=0;
if(i) Print("i=",i,"and has the true value");
else Print("i=",i,"and has the false value");

d=0.0;
if(d) Print("d=",d,"and has the true value");
else Print("d=",d,"and has the false value");

//--- Execution results


// i= 5 and has the true value
// d= -2.50000000 and has the true value
// i= 0 and has the false value
// d= 0.00000000 and has the false value

© 2000-2010, MetaQuotes Software Corp.


44 Language Basics

Enumerations
Data of the enum type belong to a certain limited set of data. Defining the enumeration type:

enum name of enumerable type


{
list of values
};

The list of enumeration values is a list of variables, separated by commas.

Example:

enum months // enumeration of named constants


{
January,
February,
March,
April,
May,
June,
July,
August,
September,
October,
November,
December
};

After the enumeration is declared, a new integer-valued 4-byte data type appears. Declaration of
the new data type allows the compiler to strictly control types of passed parameters, because
enumeration introduces new named constants. In the above example, the January named constant has
the value of 0, February - 1, December - 11.

Rule: If a certain value is not assigned to a named constant - a member of the enumeration, its
new value will be formed automatically. If it is the first member of the enumeration, the 0 value will
be assigned to it. For all subsequent members, values will be calculated based on the value of the
previous members by adding one.

Example:

enum intervals // Enumeration of named constants


{
month=1, // Interval of one month
two_months, // Two months
quarter, // Three months - quarter
halfyear=6, // Half a year
year=12, // Year - 12 months
};

Notes

© 2000-2010, MetaQuotes Software Corp.


45 Language Basics

Unlike C++, the size of the internal representation of the enumerated type in MQL5 is always equal
to 4 bytes. That is, sizeof (months) returns the value 4.

Unlike C++, an anonymous enumeration can't be declared in MQL5. That is, a unique name must be
always specified after the enum keyword.

© 2000-2010, MetaQuotes Software Corp.


46 Language Basics

Real Types (double, float)


Real types (or floating-point types) represent values with a fractional part. In the MQL5 language
there are two types for floating point numbers.The method of representation of real numbers in the
computer memory is defined by the IEEE 754 standard and is independent of platforms, operating
systems or programming languages.

Type Size in bytes Minimal Maximum Representati C++ Analog


Positive Value on Accuracy
Value

float 4 1.175494351 3.402823466 7 significant float


e-38 e+38 digits

double 8 2.225073858 1.797693134 15 significant double


5072014e- 8623158e+30 digits
308 8

The double name means that the accuracy of these numbers is twice the accuracy of the float type
numbers. In most cases, the double type is the most convenient one. In many cases the limited
precision of float numbers is not enough. The reason why the float type is still used is saving the
memory (this is important for large arrays of real numbers).

Floating-point constants consist of an integer part, a point (.) and the fractional part. The integer
and fractional parts are sequences of decimal digits.

Examples:

double a=12.111;
double b=-956.1007;
float c =0.0001;
float d =16;

There is a scientific way of writing real constants, often this method of recording is more compact
than the traditional one.

Example:

double c1=1.12123515e-25;
double c2=0.000000000000000000000000112123515; // 24 zero after the decimal point

Print("1. c1 =",DoubleToString(c1,16));
// Result: 1. c1 = 0.0000000000000000

Print("2. c1 =",DoubleToString(c1,-16));
// Result: 2. c1 = 1.1212351499999999e-025

Print("3. c2 =",DoubleToString(c2,-16));
// Result: 3. c2 = 1.1212351499999999e-025

It should be remembered that real numbers are stored in memory with some limited accuracy in the
binary system, while generally the decimal notation is used. That's why many numbers that are

© 2000-2010, MetaQuotes Software Corp.


47 Language Basics

precisely represented in the decimal system can be written only as an infinite fraction in the binary
system.

For example, numbers 0.3 and 0.7 are represented in the computer as infinite fractions, while the
number of 0.25 is stored exactly, because it represents the power of two.

In this regard, it is strongly recommended not to compare two real numbers for equality, because
such a comparison is not correct.

Example:

void OnStart()
{
//---
double three=3.0;
double x,y,z;
x=1/three;
y=4/three;
z=5/three;
if(x+y==z) Print("1/3 + 4/3 == 5/3");
else Print("1/3 + 4/3 != 5/3");
// Result: 1/3 + 4/3 != 5/3
}

If you still need to compare the equality of two real numbers, then you can do this in two different
ways. The first way is to compare the difference between two numbers with some small quantity that
specifies the accuracy of comparison.

Example:

bool EqualDoubles(double d1,double d2,double epsilon)


{
if(epsilon<0) epsilon=-epsilon;
//---
if(d1-d2>epsilon) return false;
if(d1-d2<-epsilon) return false;
//---
return true;
}
void OnStart()
{
double d_val=0.7;
float f_val=0.7;
if(EqualDoubles(d_val,f_val,0.000000000000001)) Print(d_val,"equals",f_val);
else Print("Different: d_val=",DoubleToString(d_val,16),
" f_val=",DoubleToString(f_val,16));
// Result: Different: d_val= 0.7000000000000000 f_val= 0.6999999880790710
}

Noted that the value of epsilon in the above example can not be less than the predefined constants
DBL_EPSILON.The value of this constant is 2.2204460492503131e-016. The constant corresponding to

© 2000-2010, MetaQuotes Software Corp.


48 Language Basics

the float type is FLT_EPSILON = 1.192092896e-07. The meaning of these values is the following: it is
the lowest value that satisfies the condition 1.0 + DBL_EPSILON! = 1.0 (for numbers of float type 1.0
+ FLT_EPSILON! = 1.0).

The second way offers comparing the normalized difference of two real numbers with zero. It's
meaningless to compare the difference of normalized numbers with a zero, because any mathematical
operation with normalized numbers gives a non-normalized result.

Example:

bool CompareDoubles(double number1,double number2)


{
if(NormalizeDouble(number1-number2,8)==0) return(true);
else return(false);
}
void OnStart()
{
double d_val=0.3;
float f_val=0.3;
if(CompareDoubles(d_val,f_val)) Print(d_val,"equals",f_val);
else Print("Different: d_val=",DoubleToString(d_val,16),
" f_val=",DoubleToString(f_val,16));
// Result: Different: d_val= 0.3000000000000000 f_val= 0.3000000119209290
}

Some operations of the mathematical co-processor can result in the invalid real number, which can't
be used in mathematical operations and operations of comparison, because the result of operations
with invalid real numbers is undefined. For example, when trying to calculate the arcsine of 2, the
result is the negative infinity.

Example:

double abnormal = MathArcsin(2.0);


Print("MathArcsin(2.0) =",abnormal);
// Result: MathArcsin(2.0) = -1.#IND0000

Besides the minus infinity there is the plus infinity and NaN (not a number). To determine that this
number is invalid, you can use MathIsValidNumber(). According to the IEEE standard, they have a
special machine representation. For example, plus infinity for the double type has the bit
representation of 0x7FF0 0000 0000 0000.

Examples:

struct str1
{
double d;
};
struct str2
{
long l;
};

© 2000-2010, MetaQuotes Software Corp.


49 Language Basics

//--- Start
str1 s1;
str2 s2;
//---
s1.d=MathArcsin(2.0); // Get the invalid number -1.#IND
s2=s1;
printf("1. %f %I64X",s1.d,s2.l);
//---
s2.l=0xFFFF000000000000; // invalid number -1.#QNAN
s1=s2;
printf("2. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF7000000000000; // greatest nonnumber SNaN
s1=s2;
printf("3. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF8000000000000; // smallest nonnumber QNaN
s1=s2;
printf("4. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FFF000000000000; // greatest nonnumber QNaN
s1=s2;
printf("5. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FF0000000000000; // Positive infinity 1.#INF and smallest nnonnumber SNaN
s1=s2;
printf("6. %f %I64X",s1.d,s2.l);
//---
s2.l=0xFFF0000000000000; // Negative infinity -1.#INF
s1=s2;
printf("7. %f %I64X",s1.d,s2.l);
//---
s2.l=0x8000000000000000; // Negative zero -0.0
s1=s2;
printf("8. %f %I64X",s1.d,s2.l);
//---
s2.l=0x3FE0000000000000; // 0.5
s1=s2;
printf("9. %f %I64X",s1.d,s2.l);
//---
s2.l=0x3FF0000000000000; // 1.0
s1=s2;
printf("10. %f %I64X",s1.d,s2.l);
//---
s2.l=0x7FEFFFFFFFFFFFFF; // Greatest normalized number (MAX_DBL)
s1=s2;
printf("11. %.16e %I64X",s1.d,s2.l);
//---

© 2000-2010, MetaQuotes Software Corp.


50 Language Basics

s2.l=0x0010000000000000; // Smallest positive normalized (MIN_DBL)


s1=s2;
printf("12. %.16e %.16I64X",s1.d,s2.l);
//---
s1.d=0.7; // Show that the number of 0.7 - endless fraction
s2=s1;
printf("13. %.16e %.16I64X",s1.d,s2.l);
/*
1. -1.#IND00 FFF8000000000000
2. -1.#QNAN0 FFFF000000000000
3. 1.#SNAN0 7FF7000000000000
4. 1.#QNAN0 7FF8000000000000
5. 1.#QNAN0 7FFF000000000000
6. 1.#INF00 7FF0000000000000
7. -1.#INF00 FFF0000000000000
8. -0.000000 8000000000000000
9. 0.500000 3FE0000000000000
10. 1.000000 3FF0000000000000
11. 1.7976931348623157e+308 7FEFFFFFFFFFFFFF
12. 2.2250738585072014e-308 0010000000000000
13. 6.9999999999999996e-001 3FE6666666666666
*/

See also
DoubleToString, NormalizeDouble, Constants of Numeric Types

© 2000-2010, MetaQuotes Software Corp.


51 Language Basics

String Type
The string type is used for storing text strings. A text string is a sequence of characters in the
Unicode format with the final zero at the end of it.A string constant can be assigned to a string
variable. A string constant is a sequence of Unicode characters enclosed in double quotes: "This is a
string constant".

The internal representation is the 8-byte large structure. The first element of the structure is an
integer of the int buf_len type, it contains the size of the buffer allocated for the string. The second
element of the buf_ptr structure is the 32-bit pointer to a buffer containing the string. Right before
the buffer the str_len variable of the int type is placed; it contains the string length (number of
characters in the string to the final zero).

The member of the buf_len structure can take one of the following values:

0 – indicates that this is a constant string that is stored in a pool of constant strings;
-1 – indicates that the line belongs to the client terminal (this line is cleared by the client terminal,
and not by the performing subsystem);
number - the size of the buffer in characters of the short type placed in the computer memory to
store the string.

Tight before the buffer, there are 4 bytes for the service information about the string length.
Information about the string length is obtained by the StringLen() function from this place. The string
length can be of zero size, even if the buffer allocated for the string is of the non-zero size. The
string end in the buffer is always at the place where where first byte containing 0 is met.

If you need to include a double quote (") into a string, the backslash character (\) must be put
before it. Any special character constants can be written in a string, if the backslash character (\) is
typed before them.

Examples:

string svar="This is a character string";


string svar2=StringSubstr(svar,0,4);
Print("Copyright symbol\t\x00A9");
FileWrite(handle,"This string contains a new line symbols \n");
string MT5path="C:\\Program Files\\MetaTrader 5";

© 2000-2010, MetaQuotes Software Corp.


52 Language Basics

If a variable of the string type is not explicitly initialized, the compiler adds the code that resets the
specified structure. It is necessary for avoiding critical errors when calling such a variable.

© 2000-2010, MetaQuotes Software Corp.


53 Language Basics

Structures and Classes


Structures
A structure is a set of elements of any type (except for the void type). Thus, the structure combines
logically related data of different types.

Structure Declaration

The structure data type is determined by the following description:

struct structure_name
{
elements_description
};

The structure name can's be used as an identifier (name of a variable or function). It should be
noted that in MQL5 structure elements follow one another directly, without alignment. In C++ such an
order is made to the compiler using the following instruction:

#pragma pack(1)

If you want to do another alignment in the structure, use auxiliary members, "fillers" to the right
size.

Example:

struct trade_settings
{
uchar slippage; // value of the permissible slippage-size 1 byte
char reserved1; // skip 1 byte
short reserved2; // skip 2 bytes
int reserved4; // another 4 bytes are skipped. ensure alignment of the boundary 8 bytes
double take; // Values of the price of profit fixing
double stop; // Price value of the protective stop
};

Such a description of aligned structures is necessary only for transferring to imported dll-functions.

Attention: This example illustrates incorrectly designed data. It would be better first to declare the
take and stop large data of the double type, and then declare the slippage member of the double type.
In this case, the internal representation of data will always be the same regardless of the value
specified in #pragma pack().

If a structure contains variables of the string type and/or object of a dynamic array, the compiler
assigns an implicit constructor to such a structure. This constructor resets all the structure members
of string type and correctly initializes objects of the dynamic array.

Structures that do not contain strings or objects of dynamic arrays are called simple structures;
variables of such structures can be freely copied to each other, even if they are different structures.

Access to Structure Members

© 2000-2010, MetaQuotes Software Corp.


54 Language Basics

The structure is a new type of data allowing to declare variables of this type. The structure can be
declared only once within a project. The structure members are accessed using the point operation
(.).

Example:

struct trade_settings
{
double take; // values of the profit fixing price
double stop; // value of the protective stop price
uchar slippage; // value of the acceptable slippage
};
//--- create up and initialize a variable of the trade_settings type
trade_settings my_set={0.0,0.0,5};
if (input_TP>0) my_set.take=input_TP;

Classes
Classes differ from structures in the following:

the keyword class is used in declaration;


by default, all class members have access specifier private, unless otherwise indicated. Data-
members of the structure have the default type of access as public, unless otherwise indicated;
class objects always have a table of virtual functions, even if there are no virtual functions declared
in the class. Structures can't have virtual functions;
the new operator can be applied to class objects; this operator cannot be applied to structures;
classes can be inherited only from classes, structures can be inherited only from structures.

Classes and structures can have an explicit constructor and destructor. If you a constructor is
explicitly defined, the initialization of a structure or class variable using the initializing sequence is
impossible.

Example:

struct trade_settings
{
double take; // values of the profit fixing price
double stop; // value of the protective stop price
uchar slippage; // value of the acceptable slippage
//--- Constructor
trade_settings() { take=0.0; stop=0.0; slippage=5; }
//--- Destructor
~trade_settings() { Print("This is the end"); }
};
//--- Compiler will generate an error message that initialization is impossible
trade_settings my_set={0.0,0.0,5};

Constructors and Destructors

A constructor is a special function, which is called automatically when an object of structure or class

© 2000-2010, MetaQuotes Software Corp.


55 Language Basics

type is created, and is typically used to initialize class members. Further we will discuss only classes,
all the discussed can be applied to structures also, unless otherwise specified. The name of the
constructor must match with the name of the class. The constructor has no return type (you can
specify the type of void). In MQL5 constructors do not have any input parameters. Thus, each class
can have only one constructor.

Class members: strings, dynamic arrays and objects that require initialization will be initialized
anyway regardless of the constructor presence or absence.

A destructor is a special function that is called automatically when a class object is destroyed. The
name of the destructor is written as a class name with a tilde (~). Strings, dynamic arrays and
objects, requiring deinitialization, will be de-initialized anyway, regardless of the destructor presence
or absence. If there is a destructor, these actions will be performed after calling the destructor.

Destructors are always virtual, regardless of whether they are declared with the virtual keyword or
not.

Defining Class Methods

Class function-methods can be defined both inside the class and outside the class declaration. If the
method is defined within a class, then its body comes right after the method declaration.

Example:

class CTetrisShape
{
protected:
int m_type;
int m_xpos;
int m_ypos;
int m_xsize;
int m_ysize;
int m_prev_turn;
int m_turn;
int m_right_border;
public:
void CTetrisShape();
void SetRightBorder(int border) { m_right_border=border; }
void SetYPos(int ypos) { m_ypos=ypos; }
void SetXPos(int xpos) { m_xpos=xpos; }
int GetYPos() { return(m_ypos); }
int GetXPos() { return(m_xpos); }
int GetYSize() { return(m_ysize); }
int GetXSize() { return(m_xsize); }
int GetType() { return(m_type); }
void Left() { m_xpos-=SHAPE_SIZE; }
void Right() { m_xpos+=SHAPE_SIZE; }
void Rotate() { m_prev_turn=m_turn; if(++m_turn>3) m_turn=0; }
virtual void Draw() { return; }
virtual bool CheckDown(int& pad_array[]);
virtual bool CheckLeft(int& side_row[]);
virtual bool CheckRight(int& side_row[]);
};

Functions with SetRightBorder(int border) on the Draw() are declared and defined directly inside the
CTetrisShape class.

© 2000-2010, MetaQuotes Software Corp.


56 Language Basics

The CTetrisShape() constructor and methods CheckDown(int& pad_array[]), CheckLeft(int&


side_row[]) and CheckRight(int& side_row[]) are only declared inside the class, but not defined yet.
Definitions of these functions will be further in the code. In order to define the method outside the
class, the scope resolution operator is used, the class name is used as the as the scope.

Example:

//+------------------------------------------------------------------+
//| Constructor of the basic class |
//+------------------------------------------------------------------+
void CTetrisShape::CTetrisShape()
{
m_type=0;
m_ypos=0;
m_xpos=0;
m_xsize=SHAPE_SIZE;
m_ysize=SHAPE_SIZE;
m_prev_turn=0;
m_turn=0;
m_right_border=0;
}
//+------------------------------------------------------------------+
//| Checking ability to move down (for the stick and cube) |
//+------------------------------------------------------------------+
bool CTetrisShape::CheckDown(int& pad_array[])
{
int i,xsize=m_xsize/SHAPE_SIZE;
//---
for(i=0; i<xsize; i++)
{
if(m_ypos+m_ysize>=pad_array[i]) return(false);
}
//---
return(true);
}

Public, Protected and Private Access Modifiers

When developing a new class, it is recommended to restrict access to the members from the
outside. For these purposes keywords private or protected are used. In this case, hidden data can be
accessed only from function-methods of the same class. If the protected keyword is used, hidden data
can be accessed also from methods of classes - inheritors of this class. The same method can be used
to restrict the access to functions-methods of a class.

If you need to completely open access to members and/or methods of a class, use the keyword
public.

Example:

class CTetrisField
{
private:
int m_score; // Score
int m_ypos; // Current position of the figures
int m_field[FIELD_HEIGHT][FIELD_WIDTH]; // Matrix of the DOM
int m_rows[FIELD_HEIGHT]; // Numbering of the DOM rows

© 2000-2010, MetaQuotes Software Corp.


57 Language Basics

int m_last_row; // Last free row


CTetrisShape *m_shape; // Tetris figure
bool m_bover; // Game over
public:
void CTetrisField() { m_shape=NULL; m_bover=false; }
void Init();
void Deinit();
void Down();
void Left();
void Right();
void Rotate();
void Drop();
private:
void NewShape();
void CheckAndDeleteRows();
void LabelOver();
};

Any class members and methods declared after the specifier public: (and before the next access
specifier) are available in any reference to the class object by the program. In this example these are
the following members: functions CTetrisField(), Init(), Deinit(), Down(), Left(), Right(), Rotate() and
Drop().

Any members that are declared after the access specifier to the elements private: (and before the
next access specifier) are available only to members-functions of this class. Specifiers of access to
elements always end with a colon (:) and can appear in the class definition many times.

Access to the members of the basis class can be redefined during inheritance in derived classes.

© 2000-2010, MetaQuotes Software Corp.


58 Language Basics

Dynamic Array Object


Dynamic Arrays

A dynamic array is a 40-byte large structure. Maximum 4-dimension array can be declared.

struct MqlArrayObject
{
ushort type; // Encoded data type
ushort flags; // Flags that determine the status of the array
uint item_len; // Size of one element of the array in bytes
int allocated; // Actual size, allocated for the array
int range0; // Size of the first dimension (initially equal to 0)
int range1; // Size of the second dimension, if any. Otherwise 0
int range2; // Size of the third dimension, if any. Otherwise 0
int range3; // Size of the fourth dimension, if any. Otherwise 0
int reserved0; // Data for
int reserved1; // Internal
int reserved2; // Usage
};

When declaring a dynamic array (an array of unspecified value in the first pair of square brackets),
the compiler automatically creates a variable of the above structure (a dynamic array object) and
provides a code for the correct initialization.

Example:

double matrix[][10][20]; // 3-dimensional dynamic array


ArrayResize(matrix,5); // Set the size of the first dimension

Static Arrays

When all significant array dimensions are explicitly specified, the compiler pre-allocates the
necessary memory size. Such an array is called static. Nevertheless, the compiler allocates additional
memory for the object of a dynamic array, which (object) is associated with the pre-allocated static
buffer (memory part for storing the array).

Creating a dynamic array object is due to the possible need to pass this static array as a parameter
to some function.

Examples:

double stat_array[5]; // 1-dimensional static array


some_function(stat_array);
...
bool some_function(double& array[])
{
if(ArrayResize(array,100)) return(false);
...
return(true);
}

© 2000-2010, MetaQuotes Software Corp.


59 Language Basics

Arrays in Structures

When a static array is declared as a member of a structure, a dynamic array object is not created.
This is done to ensure compatibility of data structures used in the Windows API.

However, static arrays that are declared as members of structures, can also be passed to MQL5-
functions. In this case, when passing the parameter a temporary object of a dynamic array, connected
with the static array - structure member, will be created.

© 2000-2010, MetaQuotes Software Corp.


60 Language Basics

Typecasting
Casting Numeric Types

Often a necessity occurs to convert one numeric type into another. Not all numeric types can be
converted into another. Here is the scheme of allowed casting:

Solid lines with arrows indicate changes that are performed almost without any loss of information.
Instead of the char type, the bool type can be used (both take 1 byte of memory), instead of type int,
the color type can be used (4 bytes), instead of the long type, datetime can be used (take 8 bytes).
The four dashed grey lines, also arrowed, denote conversions, when the loss of accuracy can occur.
For example, the number of digits in an integer equal to 123456789 (int) is higher than the number of
digits that can be represented by float.

int n=123456789;
float f=n; // the content of f is equal to 1.234567892E8
Print("n=",n," f=",f);
// result n= 123456789 f= 123456792.00000

A number converted into float has the same order, but is less accurate. Conversions, contrary to
black arrows, can be performed with possible data loss. Conversions between char and uchar, short
and ushort, int and uint, long and ulong (conversions to both sides), may lead to the loss of data.

As a result of converting floating point values to integer type, the fractional part is always deleted.
If you want to round off a float to the nearest whole number (which in many cases is more useful), you
should use MathRound().

Example:

//--- Gravitational acceleration


double g=9.8;
double round_g=(int)g;
double math_round_g=MathRound(g);
Print("round_g= ",round_g);
Print("math_round_g =",math_round_g);
/*
Result:
round_g = 9.00000000
math_round_g = 10.00000000
*/

© 2000-2010, MetaQuotes Software Corp.


61 Language Basics

If two values are combined by a binary operator, before the operation execution the operand of a
lower type is converted to the higher type in accordance with the priority given in the below scheme:

The data types char, uchar, short, and ushort unconditionally are converted to the int type.

Examples:

char c1=3;
//--- First example
double d2=c1/2+0.3;
Print("c1/2+0.3 =",d2);
// Result: c1/2+0.3 = 1.30000000

//--- Second example


d2=c1/2.0+0.3;
Print("c1/2.0+0.3 =",d2);
// Result: c1/2.0+0.3 = 1.80000000

The calculated expression consists of two operations. In the first example, the variable c1 of the
char type is converted to a temporary variable of the int type, because the second operand in the
division operation, the constant 2, is of the higher type int. As a result of the integer division 3/2 we
get the value 1, which is of the int type.

In the second operation of the first example, the second operand is the constant 0.3, which is of the
double type, so the result of the first operation is converted into a temporary variable of the double
type with a value of 1.0.

In the second example the variable of the char type c1 is converted to a temporary variable of the
double type, because the second operand in the division operation, the constant 2.0, is of the double
type; no further conversions are made.

Typecasting of Numeric Types

In the expressions of the MQL5 language both explicit and implicit typecasting can be used. The
explicit typecasting is written as follows:

var_1 = (type)var_2;

An expression or function execution result can be used as the var_2 variable. The functional
recording of the explicit typecasting is also possible:

var_1 = type(var_2);

Let's consider an explicit typecasting on the basis of the first example.

//--- Third example


double d2=(double)c1/2+0.3;
Print("(double)c1/2+0.3 =",d2);
// Result: (double)c1/2+0.3 = 1.80000000

© 2000-2010, MetaQuotes Software Corp.


62 Language Basics

Before the division operation is performed, the c1 variable is explicitly cast to the double type. Now
the integer constant 2 is cast to the value 2.0 of the double type, because as a result of converting
the first operand has taken the double type. In fact, the explicit typecasting is a unary operation.

Besides, when trying to cast types, the result may go beyond the permissible range. In this case, the
truncation occurs. For example:

char c;
uchar u;
c=400;
u=400;
Print("c=",c); // Result c=-112
Print("u=",u); // Result u=144

Before operations (except for the assignment ones) are performed, the data are converted into the
maximum priority type. Before assignment operations are performed, the data are cast into the
target type.

Examples:

int i=1/2; // no types casting, the result is 0


Print("i=1/2 ",i);

int k=1/2.0; // the expression is cast to the double type,


Print("k=1/2 ",k); // then is to the target type of int, the result is 0

double d=1.0/2.0; // no types casting, the result is 0.5


Print("d=1/2.0; ",d);

double e=1/2.0; // the expression is cast to the double type,


Print("e=1/2.0; ",e);// that is the same as the target type, the result is 0.5

double x=1/2; // the expression of the int type is cast to the double target typr,
Print("x=1/2; ",x); // the result is 0.0

Typecasting for the String Type

The string type has the highest priority among simple types. Therefore, if one of operands of an
operation is of the string type, the second operand will be cast to a string automatically. Note that for
a string, a single dyadic two-place operation of addition is possible. The explicit casting of string to
any numeric type is allowed.

Examples:

string s1=1.0/8; // the expression is cast to the double type,


Print("s1=1.0/8; ",s1); // then is to the target type of string,
// result is "0.12500000" (a string containing 10 characters)

string s2=NULL; // string deinitialization


Print("s2=NULL; ",s2); // the result is an empty string
string s3="Ticket N"+12345; // the expression is cast to the string type

© 2000-2010, MetaQuotes Software Corp.


63 Language Basics

Print("s=\"Ticket N"+12345,s3);

string str1="true";
string str2="0,255,0";
string str3="2009.06.01";
string str4="1.2345e2";
Print(bool(str1));
Print(color(str2));
Print(datetime(str3));
Print(double(str4));

Typecasting of Simple Structure Types

Data of the simple structures type can be assigned to each other only if all the members of both
structures are of numeric types. In this case both operands of the assignment operation (left and
right) must be of the structures type. The member-wise casting is not performed, a simple copying is
done. If the structures are of different sizes, the number of bytes of the smaller size is copied. Thus
the absence of union in MQL5 is compensated.

Examples:

struct str1
{
double d;
};
//---
struct str2
{
long l;
};
//---
struct str3
{
int low_part;
int high_part;
};
//---
struct str4
{
string s;
};
//+------------------------------------------------------------------+
void OnStart()
{
str1 s1;
str2 s2;
str3 s3;
str4 s4;
//---
s1.d=MathArcsin(2.0); // get the invalid number -1. # IND

© 2000-2010, MetaQuotes Software Corp.


64 Language Basics

s2=s1;
printf("1. %f %I64X",s1.d,s2.l);
//---
s3=s2;
printf("2. high part of long %.8X low part of long %.8X",
s3.high_part,s3.low_part);
//---
s4.s="some constant string";
s3=s4;
printf("3. buffer len is %d constant string address is 0x%.8X",
s3.low_part,s3.high_part);
}

Another example illustrates the method of organizing a custom function for receiving RGB (Red,
Green, Blue) representation from the color type. Create two structures of the same size but with
different contents. For convenience, let's add a function returning the RGB representation of a color
as a string.

#property script_show_inputs
input color testColor=Blue;// set color for testing
//--- structure for representing color as RGB
struct RGB
{
uchar blue; // blue component of color
uchar green; // green component of color
uchar red; // red component of color
uchar empty; // this byte is not used
string toString(); // function for receiving a string
};
//--- function for showing color as a string
string RGB::toString(void)
{
string out="("+(string)red+":"+(string)green+":"+(string)blue+")";
return out;
}
//--- structure for storing of the built-in color type
struct builtColor
{
color c;
};
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- a variable for storing in RGB
RGB colorRGB;
//--- variable for storing the color type
builtColor test;

© 2000-2010, MetaQuotes Software Corp.


65 Language Basics

test.c=testColor;
//--- casting two structures by copying contents
colorRGB=test;
Print("color ",test.c,"=",colorRGB.toString());
//---
}

Typecasting of Base Class Pointers to Pointers of Derivative Classes

Objects of the open generated class can also be viewed as objects of the corresponding base class.
This leads to some interesting consequences.For example, despite the fact that objects of different
classes, generated by a single base class, may differ significantly from each other, we can create a
linked list (List) of them, as we view them as objects of the base type. But the converse is not true:
the base class objects are not automatically objects of a derived class.

You can use the explicit casting to convert the base class pointers to the pointers of a derived class.
But you must be fully confident in the admissibility of such a transformation, because otherwise a
critical runtime error will occur and the mql5 program will be stopped.

© 2000-2010, MetaQuotes Software Corp.


66 Language Basics

Void Type and NULL Constant


Syntactically the void type is a fundamental type along with types of char, uchar, bool, short,
ushort, int, uint, color, long, ulong, datetime, float, double and string. This type is used either to
indicate that the function does not return any value, or as a function parameter it denotes the
absence of parameters.

The predefined constant variable NULL is of the void type. It can be assigned to variables of any
other fundamental types without conversion. The comparison of fundamental type variables with the
NULL value is allowed.

Example:

//--- If the string is not initialized, then assign our predefined value to it
if(some_string==NULL) some_string="empty";

Also NULL can be compared to pointers to objects created with the new operator.

© 2000-2010, MetaQuotes Software Corp.


67 Language Basics

Object Pointers
In MQL5, there is a possibility to dynamically create objects of complex type. This is done by the
new operator, which returns a descriptor of the created object. Descriptor is 8 bytes large.
Syntactically, object descriptors in MQL5 are similar to pointers in C++.

Examples:

MyObject* hobject= new MyObject();

Again, unlike C++, the variable hobject from the example above is not a pointer to the memory, it
is a descriptor of the object.

© 2000-2010, MetaQuotes Software Corp.


68 Language Basics

Reference. Modifier & and Keyword this


Passing Parameters by Reference
In MQL5 parameters of simple types can be passed both by value and by reference, while
parameters of compound types are always passed by reference. To inform the compiler that a
parameter must be passed by reference, the ampersand character & is added before the parameter
name.

Passing a parameter by reference means passing the address of the variable, that's why all changes
in the parameter that is passed by reference will be immediately reflected in the source variable.
Using parameter passing by reference, you can implement return of several results of a function at the
same time. In order to prevent changing of a parameter passed by reference, use the const modifier.

Thus, if the input parameter of a function is an array, a structure or class object, symbol '&' is
placed in the function header after the variable type and before its name.

Example

class CDemoClass
{
private:
double m_array[];

public:
void setArray(double &array[]);
};
//+------------------------------------------------------------------+
//| filling the array |
//+------------------------------------------------------------------+
void CDemoClass::setArray(double &array[])
{
if(ArraySize(array)>0)
{
ArrayResize(m_array,ArraySize(array));
ArrayCopy(m_array, array);
}
}

In the above example class CDemoClass is declared, which contains the private member - array
m_array[] of double type. Function setArray() is declared, to which array[] is passed by reference. If
the function header doesn't contain the indication about passing by reference, i.e. doesn't contain the
ampersand character, an error message will be generated at the attempt to compile such a code.

Despite the fact that the array is passed by reference, we can't assign one array to another. We
need to perform the element-wise copying of contents of the source array to the recipient array. The
presence of & in the function description is the obligatory condition for arrays and structures when
passed as the function parameter.

Keyword this
A variable of class type (object) can be passed both by reference and by pointer. As well as
reference, the pointer allows having access to an object. After the object pointer is declared, the new
operator should be applied to it to create and initialize it.

© 2000-2010, MetaQuotes Software Corp.


69 Language Basics

The reserved word this is intended for obtaining the reference of the object to itself, which is
available inside class or structure methods. this always references to the object, in the method of
which it is used, and the expression GetPointer(this) gives the pointer of the object, whose member
is the function, in which call of GetPointer() is performed. In MQL5 functions can't return objects, but
they can return the object pointer.

Thus, if we need a function to return an object, we can return the pointer of this object in the form
of GetPointer(this). Let's add function getDemoClass() that returns pointer of the object of this class,
into the description of CDemoClass.

class CDemoClass
{
private:
double m_array[];

public:
void setArray(double &array[]);
CDemoClass *getDemoClass();
};
//+------------------------------------------------------------------+
//| filling the array |
//+------------------------------------------------------------------+
void CDemoClass::setArray(double &array[])
{
if(ArraySize(array)>0)
{
ArrayResize(m_array,ArraySize(array));
ArrayCopy(m_array,array);
}
}
//+------------------------------------------------------------------+
//| returns its own pointer |
//+------------------------------------------------------------------+
CDemoClass *CDemoClass::getDemoClass(void)
{
return(GetPointer(this));
}

Structures don't have pointers, operators new and delete can't be applied to them, not GetPointer
(this) can be used.

See also
Object Pointers, Creating and Deleting Objects, Visibility Scope and Lifetime of Variables

© 2000-2010, MetaQuotes Software Corp.


70 Language Basics

Operations and Expressions


Some characters and character sequences are of a special importance. These are so-called operation
symbols, for example:

+ - * / % Symbols of arithmetic operations


&& || Symbols of logical operations
= += *= Characters assignment operators

Operation symbols are used in expressions and have sense when appropriate operands are given
them. Punctuation marks are emphasized, as well. These are parentheses, braces, comma, colon, and
semicolon.

Operation symbols, punctuation marks, and spaces are used to separate language elements from
each other.

This section contains the description of the following topics:

Expressions
Arithmetical Operations
Assignment Operations
Operations of Relation
Boolean Operations
Bitwise Operations
Other Operations
Priorities and Operations Order

© 2000-2010, MetaQuotes Software Corp.


71 Language Basics

Expressions
An expression consists of one or more operands and operation symbols. An expression can be
written in several lines.

Examples:

a++; b = 10; // several expressions are located in one line


//--- one expression is divided into several lines
x = (y * z) /
(w + 2) + 127;

An expression that ends with a semicolon (;) is an operator.

© 2000-2010, MetaQuotes Software Corp.


72 Language Basics

Arithmetic Operations
Arithmetical operations include additive and multiplicative operations:

Sum of variables i = j + 2;
Difference of variables i = j - 3;
Changing the sign x = - x;
Product of variables z = 3 * x;
Division quotient i = j / 5;
Divisions reminder minutes = time % 60;
Adding 1 to the variable value i++;
Adding 1 to the variable value ++i;
Subtracting 1 from the variable value k--;
Subtracting 1 from the variable value --k;

Increment and decrement operations are applied only to variables, they can't be applied to
constants. The prefix increment (++i) and decrement (-k) are applied to the variable right before this
variable is used in an expression.

Post-increment (i++) and post-decrement (k-) are applied to the variable right after this variable is
used in an expression.

Examples:

int a=3;
a++; // valid expression
int b=(a++)*3; // invalid expression

© 2000-2010, MetaQuotes Software Corp.


73 Language Basics

Assignment Operations
The value of the expression that includes the given operation is the value of the left operand after
assignment:

Assignment the x value to the y variable y = x;

The following operations unite arithmetic or bitwise operations with operation of assignment:

Adding x to the y variable y += x;


Subtracting x from the y variable y -= x;
Multiplying the y variable by x y *= x;
Dividing the y variable by x y /= x;
Reminder of division of the y variable by x y %= x;
The shift of the binary representation of y to the right by x bit y >>= x;
The shift of the binary representation of y to the left by x bit y y <<= x;
AND bitwise operation of binary representations of y and x y &= x;
OR bitwise operation of binary representations of y and x y |= x;
Excluding OR bitwise operation of binary representations of y and x y ^= x;

Bitwise operations can be applied to integers only. When performing the operation of the logical
shift of the y representation to the right/left by x bits, the 5 smallest binary digits of the x value are
used, the highest ones are dropped, i.e. the shift is made to 0-31 bits.

By %= operation (y value by module of x), the result sign is equal to the sign of divided number.

The assignment operator can be used several times in an expression . In this case the processing of
the expression is performed from left to right:

y=x=3;

First, the variable x will be assigned the value 3, then the y variable will be assigned the value of x,
i.e. also 3.

© 2000-2010, MetaQuotes Software Corp.


74 Language Basics

Operations of Relation
Boolean FALSE is represented with an integer zero value, while the boolean TRUE is represented by
any non-zero value.

The value of expressions containing operations of relation or logical operations is FALSE (0) or TRUE
(1).

True if a is equal to b a == b;
True if a is not equal to b a != b;
True if a is less than b a < b;
True if a is greater than b a > b;
True if a is less than or equal to b a <= b;
True if a is greater than or equal to b a >= b;

The equality of two real numbers can't be compared. In most cases, two seemingly identical
numbers can be unequal because of different values in the 15th decimal place. In order to correctly
compare two real numbers, compare the normalized difference of these numbers with zero.

Example:

bool CompareDoubles(double number1,double number2)


{
if(NormalizeDouble(number1-number2,8)==0) return(true);
else return(false);
}
void OnStart()
{
double first=0.3;
double second=3.0;
double third=second-2.7;
if(first!=third)
{
if(CompareDoubles(first,third))
printf("%.16f %.16f are equal",first,third);
}
}
// Result: 0.3000000000000000 0.2999999999999998 are equal

© 2000-2010, MetaQuotes Software Corp.


75 Language Basics

Boolean Operations
Logical Negation NOT (!)

Operand of the logical negation (!) must be of arithmetic type. The result is TRUE (1), if the
operand value is FALSE (0); and it is equal to FALSE (0), if the operand differs from FALSE (0).

if(!a) Print("not 'a'");

Logical Operation OR (||)

Logical OR operation (||) of x and y values. The expression value is TRUE (1), if x or y value is true
(not null). Otherwise - FALSE (0).

if(x<0 || x>=max_bars) Print("out of range");

Logical Operation AND (&&)

Logical operation AND (&&) of x and y values. The expression value is TRUE (1), if the values of x
and y are true (not null). Otherwise - FALSE (0).Logical expressions are calculated fully, i.e. the so-
called "short assignment" scheme is not applied to them.

if(p!=x && p>y) Print("TRUE");

© 2000-2010, MetaQuotes Software Corp.


76 Language Basics

Bitwise Operations
Complement to One

Complement of the variable value up to one. The value of the expression contains 1 in all digits
where the variable value contains 0, and 0 in all digits where the variable contains 1.

b = ~n;

Example:

char a='a',b;
b=~a;
Print("a=",a, " b=",b);
// The result will be:
// a= 97 b= -98

Right Shift

The binary representation of x is shifted to the right by y digits. If the value to shift is of the
unsigned type, the logical right shift is made, i.e. the freed left-side bits will be filled with zeroes.

If the value to shift is of a sign type, the arithmetic right shift is made, i.e. the freed left-side
digits will be filled with the value of a sign bit (if the number is positive, the value of the sign bit is 0;
if the number is negative, the value of the sign bit is 1).

x = x >> y;

Example:

char a='a',b='b';
Print("Before: a=",a, " b=",b);
//--- shift to the right
b=a>>1;
Print("After: a=",a, " b=",b);
// The result will be:
// Before: a= 97 b= 98
// After: a= 97 b= 48

Left Shift

The binary representation of x is shifted to the left by y digits, the freed right-side digits are filled
with zeros.

x = x << y;

Example:

char a='a',b='b';
Print("Before: a=",a, " b=",b);
//--- shift to the left
b=a<<1;
Print("After: a=",a, " b=",b);

© 2000-2010, MetaQuotes Software Corp.


77 Language Basics

// The result will be:


// Before: a= 97 b= 98
// After: a= 97 b= -62

It is not recommended to shift by the number of bits larger or equal to the length of the variable
shifted, because the result of such an operation is undefined.

Bitwise AND Operation

The bitwise AND operation of binary-coded x and y representations. The value of the expression
contains a 1 (TRUE) in all digits where both x and y contain non-zero, and it contains 0 (FALSE) in all
other digits.

b = ((x & y) != 0);

Example:

char a='a',b='b';
//--- AND operation
char c=a&b;
Print("a=",a," b=",b);
Print("a&b=",c);
// The result will be:
// a= 97 b= 98
// a&b==96

Bitwise OR Operation

The bitwise OR operation of binary representations of x and y. The value of the expression contains
1 in all digits where x or y does not contain 0, and it contains 0 in all other digits.

b = x | y;

Example:

char a='a',b='b';
//--- OR operation
char c=a|b;
Print("a=",a," b=",b);
Print("a|b=",c);
// The result will be:
// a= 97 b= 98
// a|b==99

Bitwise Exclusive Operation OR

The bitwise exclusive OR (eXclusive OR) operation of binary representations of x and y. The value
of the expression contains a 1 in all digits where x and y have different binary values, and it contains
0 in all other digits.

b = x ^ y;

Example:

© 2000-2010, MetaQuotes Software Corp.


78 Language Basics

char a='a', b='b';


//--- Excluding OR operation
char c=a^b;
Print("a=",a," b=",b);
Print("a^b=",c);
// The result will be:
// a= 97 b= 98
// a^b==99

Bitwise operations are performed with integers only.

© 2000-2010, MetaQuotes Software Corp.


79 Language Basics

Other operations
Indexing ( [] )
When addressing the i-th element of the array, the expression value is the value of a variable with
the serial number i.

Example:

array[i] = 3; // Assign the value of 3 to i-th element of the array.

Only an integer can be index of an array. Four-dimensional and below arrays are allowed. Each
measurement is indexed from 0 to measurement size-1. In particular case, for a one-dimensional
array consisting of 50 elements, the reference to the first element will look like array [0], that to the
last element will be array [49].

When addressing beyond the array, the executing subsystem will generate a critical error, and the
program will be stopped.

Calling Function with x1, x2 ,..., xn Arguments


Each argument can represent a constant, variable, or expression of the corresponding type. The
arguments passed are separated by commas and must be inside of parentheses, the opening
parenthesis must follow the name of the called function.

The expression value is the value returned by the function. If the return value is of void type, such
function call cannot be placed to the right in the assignment operation. Please make sure that the
expressions x1,..., Xn are executed exactly in this order.

Example:

int length=1000000;
string a="a",b="b",c;
//---
int start=GetTickCount(),stop;
long i;
for(i=0;i<length;i++)
{
c=a+b;
}
stop=GetTickCount();
Print("time for 'c=a+b'=",(stop-start),"milliseconds, i =",i);

Comma Operation ( , )
Expressions separated by commas are executed from left to right. All side effects of the left
expression calculation can appear before the right expression is calculated. The result type and value
coincide with those of the right expression. The list of parameters to be passed (see above) can be
considered as an example.

Example:

© 2000-2010, MetaQuotes Software Corp.


80 Language Basics

for(i=0,j=99; i<100; i++,j--) Print(array[i][j]);

Dot Operator ( . )
For the direct access to the public members of structures and classes the dot operation is usesd.
Syntax:

Variable_name_of_structure_type.Member_name

Example:

struct SessionTime
{
string sessionName;
int startHour;
int startMinutes;
int endHour;
int endMinutes;
} st;
st.sessionName="Asian";
st.startHour=0;
st.startMinutes=0;
st.endHour=9;
st.endMinutes=0;

Scope Resolution Operation ( :: )


Each function in a mql5 program has its own execution scope. For example, the Print() system
function is performed in a global scope. Imported functions are called in the scope of the
corresponding import. Method functions of classes have the scope of the corresponding class. The
syntax of the scope resolution operation is as follows:

[Scope_name]::Function_name(parameters)

If there is no scope name, this is the explicit direction to use the global scope. If there is no scope
resolution operation, the function is sought in the nearest scope. If there is no function n the local
scope, the search is conducted in the global scope.

The scope resolution operation is also used to define function-class member.

type Calss_name::Function_name(parameters_description)
{
// function body
}

Example:

#property script_show_inputs
#import"kernel32.dll"
int GetLastError(void);
#import

© 2000-2010, MetaQuotes Software Corp.


81 Language Basics

class CCheckContext
{
int m_id;
public:
CCheckContext() { m_id=1234; }
protected:
int GetLastError() { return(m_id); }
};
class CCheckContext2 : public CCheckContext
{
int m_id2;
public:
CCheckContext2() { m_id2=5678; }
void Print();
protected:
int GetLastError() { return(m_id2); }
};
void CCheckContext2::Print()
{
::Print("Terminal GetLastError",::GetLastError());
::Print("kernel32 GetLastError",kernel32::GetLastError());
::Print("parent GetLastError",CCheckContext::GetLastError());
::Print("our GetLastError",GetLastError());
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
CCheckContext2 test;
test.Print();
}
//+------------------------------------------------------------------+

Operation of Obtaining Data Type Size or Size of Any Data Type


Object ( sizeof )
Using the sizeof operation, the memory size corresponding to an identifier or type can be defined.
The sizeof operation is of the following format:

Example:

sizeof(expression)

Any identifier, or type name enclosed in brackets can be used as an expression. Note that the void
type name can't be used, and the identifier cannot belong to the field of bits, or be a function name.

If the expression is the name of a static array (i.e. the first dimension is given), then the result is
the size of the whole array (i.e. the product of the number of elements the the type length). If the

© 2000-2010, MetaQuotes Software Corp.


82 Language Basics

expression is the name of a dynamic array (the first dimension is not specified), the result will be the
size of the object of the dynamic array.

When sizeof is applied to the name of structure or class type, or to the identifier of the structure or
class type, the result is the actual size of the structure or class.

Example:

struct myStruct
{
char h;
int b;
double f;
} str;
Print("sizeof(str) =",sizeof(str));
Print("sizeof(myStruct) =",sizeof(myStruct));

The size is calculated at the compilation stage.

© 2000-2010, MetaQuotes Software Corp.


83 Language Basics

Precedence Rules
Each group of operations in the table has the same priority. The higher the priority of operations is,
the higher it is position of the group in the table. The precedence rules determine the grouping of
operations and operands.

Attention: Precedence of operations in the MQL5 language corresponds to the priority adopted in C+
+, and differs from the priority given in the MQL4 language.

Operation Desciption Execution Order

() Function Call From left to right


[] Referencing to an array
. element
Referencing to a structure
element

! Logical negation Right to left


~ Bitwise negation
– (complement)
++ Sign changing
-- Increment by one
(type) Decrement by one
sizeof Typecasting
Determining size in bytes

* Multiplication From left to right


/ Division
% Module division

+ Addition From left to right


– Subtraction

<< Left shift From left to right


>> Right shift

< Less than From left to right


<= Less than or equal
> Greater than
>= Greater than or equal

== Equal From left to right


!= Not equal

& Bitwise AND operation From left to right

^ Bitwise exclusive OR From left to right

| Bitwise OR operation From left to right

&& Logical AND operation From left to right

|| Logical OR operation From left to right

?: Conditional Operator Right to left

© 2000-2010, MetaQuotes Software Corp.


84 Language Basics

= Assignment Right to left


*= Multiplication with assignment
/= Division with assignment
%= Module with assignment
+= Addition with assignment
-= Subtraction with assignment
<<= Left shift with assignment
>>= Right shift with assignment
&= Bitwise AND with assignment
^= Exclusive OR with assignment
|= Bitwise OR with assignment

, Comma From left to right

To change the operation execution order, parenthesis that are of higher priority are used.

© 2000-2010, MetaQuotes Software Corp.


85 Language Basics

Operators
Language operators describe some algorithmic operations that must be executed to accomplish a
task. The program body is a sequence of such operators. Operators following one by one are separated
by semicolons.

Operator Description

Compound operator {} One or more operators of any type, enclosed in


curly braces {}

Expression operator (;) Any expression that ends with a semicolon (;)

return operator Terminates the current function and returns


control to the calling program

if-else conditional operator Is used when it's necessary to make a choice

?: conditional operator A simple analog of the if-else conditional


operator

switch selection operator Passes control to the operator, which


corresponds to the expression value

while loop operator Performs an operator until the expression


checked becomes false. The expression is
checked before each iteration

for loop operator Performs an operator until the expression


checked becomes false. The expression is
checked before each iteration

do-while loop operator Performs an operator until the expression


checked becomes false. The end condition is
checked, after each loop. The loop body is
always executed at least once.

break operator Terminates the execution of the nearest


attached external operator switch, while, do-
while or for

continue operator Passes control to the beginning of the nearest


external loop operator while, do-while or for

new operator Creates an object of the appropriate size and


returns a descriptor of the created object.

delete operator Deletes the object created by the new operator

One operator can occupy one or more lines. Two or more operators can be located in the same line.
Operators that control over the execution order (if, if-else, switch, while and for), can be nested into
each.

Example:

if(Month() == 12)

© 2000-2010, MetaQuotes Software Corp.


86 Language Basics

if(Day() == 31) Print("Happy New Year!");

© 2000-2010, MetaQuotes Software Corp.


87 Language Basics

Compound Operator
A compound operator (a block) consists of one or more operators of any type, enclosed in braces {}.
The closing brace must not be followed by a semicolon (;).

Example:

if(x==0)
{
Print("invalid position x=",x);
return;
}

© 2000-2010, MetaQuotes Software Corp.


88 Language Basics

Expression Operator
Any expression followed by a semicolon (;) is the operator. Here are some examples of expression
operators.

Assignment Operator
Identifier = expression;

x=3;
y=x=3;
bool equal=(x==y);

Assignment operator can be used many times in an expression. In this case, the expression is
processed from left to right:

Function Calling Operator


Function_name (argument1,..., argumentN);

FileClose(file);

Empty Operator
Consists only of a semicolon (;) and is used to denote an empty body of a control operator.

© 2000-2010, MetaQuotes Software Corp.


89 Language Basics

Return Operator
The return operator terminates the current function execution and returns control to the calling
program. The expression calculation result is returned to the calling function. The expression can
contain an assignment operator.

Example:

int CalcSum(int x, int y)


{
return(x+y);
}

In functions with the void return type, the return operator without expression must be used:

void SomeFunction()
{
Print("Hello!");
return; // this operator can be removed
}

The right brace of the function means implicit execution of the return operator without expression.

What can be returned: simple types, simple structures, object pointers. With the return operator
you can't return any arrays, class objects, variables of compound structure type.

© 2000-2010, MetaQuotes Software Corp.


90 Language Basics

If-Else Conditional Operator


The IF - ELSE operator is used when a choice must be made. Formally, the syntax is as follows:

if (expression)
operator1
else
operator2

If the expression is true, operator1 is executed and control is given to the operator that follows
operator2 (operator2 is not executed). If the expression is false, operator2 is executed.

The else part of the if operator can be omitted. Thus, a divergence may appear in nested if
operators with omitted else part. In this case, else addresses to the nearest previous if operator in
the same block that has no else part.

Examples:

//--- The else part refers to the second if operator:


if(x>1)
if(y==2) z=5;
else z=6;
//--- The else part refers to the first if operator:
if(x>l)
{
if(y==2) z=5;
}
else z=6;
//--- Nested operators
if(x=='a')
{
y=1;
}
else if(x=='b')
{
y=2;
z=3;
}
else if(x=='c')
{
y=4;
}
else Print("ERROR");

© 2000-2010, MetaQuotes Software Corp.


91 Language Basics

?: conditional Operator
The general form of the ternary operator is as follows:

expression1? expression2:expression3

For the first operand - "expression1" - any expression that results in a bool type value can be used.
If the result is true, then the operator set by the second operand, i.e. "expression2" is executed.

If the first operand is false, the third operand - "expression3" is performed. The second and third
operands, i.e. "expression2" and "expression3" should return values of one type and should not be of
void type. The result of the conditional operator execution is the result of expression2 or result of the
expression3, depending on the result of expression1.

Example:

//--- normalize difference between open and close prices for a day range
double true_range = (High==Low)?0:(Close-Open)/(High-Low);

This entry is equivalent to the following:

double true_range;
if(High==Low)true_range=0; // if High and Low are equal
else true_range=(Close-Open)/(High-Low); // if the range is not null

© 2000-2010, MetaQuotes Software Corp.


92 Language Basics

Switch Operator
It compares the expression value with constants in all variants of case and gives control to the
operator that corresponds to the expression value. Each variant of case can be marked with an integer
constant, a literal constant or a constant expression. The constant expression can's contain variables
or function calls. Expression of the switch operator must be of integer type.

switch(expression)
{
case constant: operators
case constant: operators
...
default: operators
}

Operators connected with the default label are executed if none of the constants in case operators
equals to the expression value. The default variant should not necessarily be announced and should
not necessarily be the last one. If none of the constants corresponds to the expression value and the
default variant is not available, no actions are executed.

The keyword case and the constant are just labels, and if operators are executed for some case
variant, the program will further execute the operators of all following variants until the break
operator occurs. It makes it possible to bind a subsequence of operators with several variants.

A constant expression is calculated during compilation. No two constants in one switch operator can
have the same value.

Examples:

//--- First example


switch(x)
{
case 'A':
Print("CASE A");
break;
case 'B':
case 'C':
Print("CASE B or C");
break;
default:
Print("NOT A, B or C");
break;
}

//--- Second example


string res="";
int i=0;
switch(i)
{
case 1:
res=i;break;

© 2000-2010, MetaQuotes Software Corp.


93 Language Basics

default:
res="default";break;
case 2:
res=i;break;
case 3:
res=i;break;
}
Print(res);
/*
Result
default
*/

© 2000-2010, MetaQuotes Software Corp.


94 Language Basics

While Loop Operator


The while operator consists of a checked expression and the operator, which must be fulfilled:

while(expression)
operator;

If the expression is true, the operator is executed until the expression becomes false. If the
expression is false, the control is passed to the next operator. The expression value is defined before
the operator is executed. Therefore, if the expression is false from the very beginning, the operator
will not be executed at all.

Example:

while(k<n)
{
y=y*x;
k++;
}

© 2000-2010, MetaQuotes Software Corp.


95 Language Basics

For Loop Operator


The for operator consists of three expressions and an executable operator:

for(expression1; expression2; expression3)


operator;

Expression1 describes the loop initialization. Expression2 checks the conditions of the loop
termination. If it is true, the loop body for is executed. The loop repeats expression2 becomes false.
If it is false, the loop is terminated, and control is transferred to the next operator. Expression3 is
calculated after each iteration.

The for operator is equivalent to the following succession of operators:

expression1;
while(expression2)
{
operator;
expression3;
};

Any of the three or all three expressions can be absent in the for operator, but the semicolons (;)
that separate them must be omitted. If expression2 is omitted, it is considered constantly true. The
for(;;) operator is a continuous loop, equivalent to the while(1) operator. Each expression 1 or 3 can
consist of several expressions combined by a comma operator ','.

Examples:

for(x=1;x<=7;x++) Print(MathPower(x,2));
//--- Another example
for(;;)
{
Print(MathPower(x,2));
x++;
if(x>10) break;
}
//--- Third example
for(i=0,j=n-l;i<n;i++,j--) a[i]=a[j];

© 2000-2010, MetaQuotes Software Corp.


96 Language Basics

Loop Operator do while


The for and while loops check the termination at the beginning, not at the end of a loop. The third
loop operator do - while checks the condition of termination at the end, after each loop iteration. The
loop body is always executed at least once.

do
operator;
while(expression)

First the operator is executed, then the expression is calculated. If it is true, then the operator is
executed again, and so on. If the expression becomes false, the loop terminates.

Example:

//--- Calculate the Fibonacci series


int counterFibonacci=15;
int i=0,first=0,second=1;
int currentFibonacciNumber;
do
{
currentFibonacciNumber=first+second;
Print("i=",i," currentFibonacciNumber=",currentFibonacciNumber);
first=second;
second=currentFibonacciNumber;
i++; // without this operator an infinite loop will appear!
}
while(i<counterFibonacci);

© 2000-2010, MetaQuotes Software Corp.


97 Language Basics

Break Operator
The break operator terminates the execution of the nearest nested outward switch, while, do-while
or for operator. The control is passed to the operator that follows the terminated one. One of the
purposes of this operator is to finish the looping execution when a certain value us assigned to a
variable.

Example:

//--- searching for the first zero element


for(i=0;i<array_size;i++)
if(array[i]==0)
break;

© 2000-2010, MetaQuotes Software Corp.


98 Language Basics

Continue Operator
The continue operator passes control to the beginning of the nearest outward loop while, do-while or
for operator, the next iteration being called. The purpose of this operator is opposite to that of break
operator.

Example:

//--- Sum of all nonzero elements


int func(int array[])
{
int array_size=ArraySize(array);
int sum=0;
for(int i=0;i<array_size; i++)
{
if(a[i]==0) continue;
sum+=a[i];
}
return(sum);
}

© 2000-2010, MetaQuotes Software Corp.


99 Language Basics

Object Create Operator new


The new operator automatically creates an object of a corresponding size, calls the object
constructor and returns descriptor of the created object. In case of failure, the operator returns a null
descriptor that can be compared with the NULL constant.

The new operator can be applied only to class objects. They can't be applied to structures.

The operator shall not be used to create arrays of objects. To do this, use ArrayResize().

Example:

//+------------------------------------------------------------------+
//| Figure creation |
//+------------------------------------------------------------------+
void CTetrisField::NewShape()
{
m_ypos=HORZ_BORDER;
//--- randomly create one of the 7 possible shapes
int nshape=rand()%7;
switch(nshape)
{
case 0: m_shape=new CTetrisShape1; break;
case 1: m_shape=new CTetrisShape2; break;
case 2: m_shape=new CTetrisShape3; break;
case 3: m_shape=new CTetrisShape4; break;
case 4: m_shape=new CTetrisShape5; break;
case 5: m_shape=new CTetrisShape6; break;
case 6: m_shape=new CTetrisShape7; break;
}
//--- draw
if(m_shape!=NULL)
{
//--- pre-settings
m_shape.SetRightBorder(WIDTH_IN_PIXELS+VERT_BORDER);
m_shape.SetYPos(m_ypos);
m_shape.SetXPos(VERT_BORDER+SHAPE_SIZE*8);
//--- draw
m_shape.Draw();
}
//---
}

It should be noted that the object descriptor not a pointer to the memory.

The object created with the new operator must be explicitly removed by the delete operator.

© 2000-2010, MetaQuotes Software Corp.


100 Language Basics

Object Delete Operator delete


The delete operator deletes an object created by the new operator, calls the corresponding class
destructor and frees up memory occupied by the object. A real descriptor of an existing object is used
as an operand. After the delete operation is executed, the object descriptor becomes invalid.

Example:

//--- delete figure


delete m_shape;
m_shape=NULL;
//--- create a new figure
NewShape();

© 2000-2010, MetaQuotes Software Corp.


101 Language Basics

Functions
Every task can be divided into subtasks, each of which can either be directly represented in the
form of a code, or divided into smaller sub-tasks. This method is called stepwise refinement.
Functions are used for writing the code of sub-tasks to be solved. The code that describes what a
function does is called function definition:

function_header
{
instructions
}

All that is before the first brace is the header of the function definition, and what is between braces
is the body of the function definition. The function header includes a description of the return value
type, name (identifier) and formal parameters. The number of parameters passed to the function is
limited and cannot exceed 64.

The function can be called from other parts of the program as many times as necessary. In fact, the
return type, function identifier and parameter types constitute the function prototype.

Function prototype is the function declaration, but not its definition. Due to the explicit declaration
of the return type and a list of argument types, the strict type checking and implicit typecasting are
possible during function calls. Very often function declarations are used in classes to improve the code
readability.

The function definition must exactly match its declaration. Each declared function must be defined.

Example:

double // return value type


linfunc (double a, double b) // function name and parameter list
{
// composite operator
return (a + b); // return value
}

The return operator can return the value of an expression located in this operator. If necessary, the
expression value is converted to the function result type. A function that returns no value should be
described as that of void type.

Example:

void errmesg(string s)
{
Print("error: "+s);
}

Parameters passed to the function can have default values, which are defined by constants of that
type.

Example:

© 2000-2010, MetaQuotes Software Corp.


102 Language Basics

int somefunc(double a,
double d=0.0001,
int n=5,
bool b=true,
string s="passed string")
{
Print("Required parameter a=",a);
Print("Pass the following parameters: d=",d," n=",n," b=",b," s=",s);
return(0);
}

If any of parameters has a default value, all subsequent parameters must also have default values.

Example of incorrect declaration:

int somefunc(double a,
double d=0.0001, // default value 0.0001 declared
int n, // default value is not specified !
bool b, // default value is not specified !
string s="passed string")
{
}

© 2000-2010, MetaQuotes Software Corp.


103 Language Basics

Function Call
If a name that has not been described before, appears in the expression and is followed by the left
parenthesis, it is contextually considered as the name of a function.

function_name (x1, x2,..., xn)

Arguments (formal parameters) are passed by value, i.e. each expression xl,..., Xn is calculated,
and the value is passed to the function. The order of expressions calculation and that of values
loading are guaranteed. During the execution, the system checks the number and type of arguments
passed to the function. Such way of addressing to the function is called a value call.

Function call is an expression, the value of which is the value returned by the function. The function
type described above must correspond with the type of the return value. The function can be declared
or described in any part of the program on the global scope, i.e., outside other functions. The
function cannot be declared or described inside of another function.

Examples:

int start()
{
double some_array[4]={0.3, 1.4, 2.5, 3.6};
double a=linfunc(some_array, 10.5, 8);
//...
}
double linfunc(double x[], double a, double b)
{
return (a*x[0] + b);
}

At calling of a function with default parameters, the list of parameters to be passed can be limited,
but not before the first default parameter.

Examples:

void somefunc(double init,


double sec=0.0001, //set default values
int level=10);
//...
somefunc(); // Wrong call. The first parameter must be presented.
somefunc(3.14); // Correct call
somefunc(3.14,0.0002); // Correct call
somefunc(3.14,0.0002,10); // Correct call

When calling a function, one may not skip parameters, even those having default values:

somefunc(3.14, , 10); // Wrong call -> the second parameter was skipped.

© 2000-2010, MetaQuotes Software Corp.


104 Language Basics

Passing Parameters
There are two methods, by which the machine language can pass arguments to a subprogram
(function). The first method is to send a parameter by value. This method copies the argument value
into a formal function parameter. Therefore, any changes in this parameter within the function have
no influence on the corresponding call argument.

//+------------------------------------------------------------------+
//| Passing parameters by value |
//+------------------------------------------------------------------+
double FirstMethod(int i,int j)
{
double res;
//---
i*=2;
j/=2;
res=i+j;
//---
return(res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a=14,b=8;
Print("a and b before call:",a,b);
double d=FirstMethod(a,b);
Print("a and b after call:",a,b);
}
//--- Result of script execution
// a and b before call: 14 8
// a and b after call: 14 8

The second method is to pass by reference. In this case, reference to a parameter (not its value) is
passed to a function parameter. Inside the function, it is used to refer to the actual parameter
specified in the call. This means that the parameter changes will affect the argument used to call the
function.

//+------------------------------------------------------------------+
//| Passing parameters by reference |
//+------------------------------------------------------------------+
double SecondMethod(int &i,int &j)
{
double res;
//---
i*=2;
j/=2;
res=i+j;

© 2000-2010, MetaQuotes Software Corp.


105 Language Basics

//---
return(res);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a=14,b=8;
Print("a and b before call;",a,b);
double d=SecondMethod(a,b);
Print("a and b after call:",a,b);
}
//+------------------------------------------------------------------+
//--- result of script execution
// a and b before call: 14 8
// a and b after call: 28 4

MQL5 uses both methods, with one exception: arrays and structure type variables (class objects)
are always passed by reference. In order to exclude changes in actual parameters (arguments passed
at function call) use the access specifier const. When trying to change the contents of a variable
declared with the const specifier, the compiler will generate an error.

Note

It should be noted that parameters are passed to a function in reversed order, i.e., first the last
parameter is calculated and passed, and then the last but one, etc. The last calculated and passed
parameter is the one that stands first after braces.

Example:

void OnStart()
{
//---
int a[]={0,1,2};
int i=0;

func(a[i],a[i++],"First call(i="+string(i)+")");
func(a[i++],a[i],"Second call(i="+string(i)+")");
// Result:
// First call(i=0) : par1 = 1 par2 = 0
// Second call(i=1) : par1 = 1 par2 = 1

}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void func(int par1,int par2,string comment)
{

© 2000-2010, MetaQuotes Software Corp.


106 Language Basics

Print(comment,": par1 =",par1," par2 =",par2);


}

At first call in the mentioned example the i variable first takes part in the concatenation of strings

"First call(i="+string(i)+")"

Here its value doesn't change. The i variable takes part in the calculation of the a[i++] array
element, i.e. after the i element of the array is taken, the i variable is incremented. And only after
that the first parameter with the changed value of i variable is calculated.

At the second call when calculating all three parameters, one and the same value of i is used, the
one that was calculated on the first phase of function calling, and only after the first parameters is
calculated the i variable is changed again.

© 2000-2010, MetaQuotes Software Corp.


107 Language Basics

Function Overloading
Usually the function name tends to reflect its main purpose. As a rule, readable programs contain
various well selected identifiers. Sometimes different functions are used for the same purposes. Let's
consider, for example, a function that calculates the average value of an array of double precision
numbers and the same function, but operating with an array of integers. Both are convenient to be
called AverageFromArray:

//+------------------------------------------------------------------+
//| The calculation of average for an array of double type |
//+------------------------------------------------------------------+
double AverageFromArray(const double array[],int size)
{
if(size<=0) return 0.0;
double sum=0.0;
double aver;
//---
for(int i=0;i<size;i++)
{
sum+=array[i]; // Addition to the double
}
aver=sum/size; // Just divide the sum by the number
//---
Print("Calculation of the average for an array of double type");
return aver;
}
//+------------------------------------------------------------------+
//| The calculation of average for an array of int type |
//+------------------------------------------------------------------+
double AverageFromArray(const int array[],int size)
{
if(size<=0) return 0.0;
double aver=0.0;
int sum=0;
//---
for(int i=0;i<size;i++)
{
sum+=array[i]; // Addition to the double
}
aver=(double)sum/size;// Give the amount of type double, and divide
//---
Print("Calculation of the average for an array of int type");
return aver;
}

Each function contains the message output via the Print() function;

Print("Calculation of the average for an array of int type");

The compiler selects a necessary function in accordance with the types of arguments and their

© 2000-2010, MetaQuotes Software Corp.


108 Language Basics

quantity. The rule, according to which the choice is made, is called the signature matching algorithm.
A signature is a list of types used in the function declaration.

Example:

//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int a[5]={1,2,3,4,5};
double b[5]={1.1,2.2,3.3,4.4,5.5};
double int_aver=AverageFromArray(a,5);
double double_aver=AverageFromArray(b,5);
Print("int_aver=",int_aver," double_aver=",double_aver);
}
//--- Result of the script
// Calculate the average for an array of int type
// Calculate the average for an array of double type
// int_aver= 3.00000000 double_aver= 3.30000000

Overloading is the practice of assigning multiple values to a function. Selecting a specific value
depends on the types of arguments received by the function. A specific function is selected based on
the correspondence of the list of arguments when calling the function, to the list of parameters in the
function declaration.

When an overloaded function is called, the compiler must have an algorithm to select the
appropriate function. The algorithm that performs this choice depends on conversions of what type
are present. The best correlation must be unique. It must be the best for at least one argument, and
as well as the other correspondences for all other arguments.

Below is a matching algorithm for each argument.

Algorithm of Choosing an Overloaded Function


1. Use strict matching (if possible).
2. Try standard type increase.
3. Try standard typecasting.

The standard type increase is better than other standard conversions. Increase is the conversion of
float to double, of bool, char, short or enum to int. Typecasting of arrays of similar integer types also
belongs to typecasting. Similar types are: bool, char, uchar, since all the three types are single-byte
integers; double-byte integers short and ushort; 4-byte integers int, uint, and color; long, ulong, and
datetime.

Of course, the strict matching is the best. To achieve such a consistency typecasting can be used.
The compiler cannot cope with ambiguous situations. Therefore you should not rely on subtle
differences of types and implicit conversions that make the overloaded function unclear.

If you doubt, use explicit conversion to ensure strict compliance.

© 2000-2010, MetaQuotes Software Corp.


109 Language Basics

Examples of overloaded functions in MQL5 can be seen in the example of ArrayInitialize() functions.

Function overloading rules apply to overload of class methods.

Overloading of system functions is allowed, but it should be observed that the compiler is able to
accurately select the necessary function. For example, we can overload the system function fmax() in
3 different ways, but only two variants are correct.

Example:

// overload is permissible - differs in the number of parameters


double fmax(double a,double b,double c);

// overload with error


// number of parameters is different, but the last has a default value
// this leads to the concealment of the system function when calling, which is unacceptable
double fmax(double a,double b,double c=DBL_MIN);

// normal overload by the parameter type


int fmax(int a,int b);

© 2000-2010, MetaQuotes Software Corp.


110 Language Basics

Description of External Functions


Type of external functions defined in another module, should be explicitly described. The absence of
such a description can lead to errors when compiling, building, or executing a program. When
describing an external object, use the keyword #import indicating the module.

Examples:

#import "user32.dll"
int MessageBoxW(int hWnd ,string szText,string szCaption,int nType);
int SendMessageW(int hWnd,int Msg,int wParam,int lParam);
#import "lib.ex5"
double round(double value);
#import

With the help of import, it is easy to describe functions that are called from external DLL or
compiled EX5 libraries. EX5 libraries are compiled ex5 files, which have the library property. Only
function described with the export modifier can be imported from EX5 libraries.

© 2000-2010, MetaQuotes Software Corp.


111 Language Basics

Exporting Functions
A function declared in a mql5 program with the export postmodifier can be used in another mql5
program. Such a function is called exportable, and it can be called from other programs after
compilation.

int Function() export


{
}

This modifier orders the compiler to add the function into the table of EX5 functions exported by
this ex5 file. Only function with such a modifier are accessible ("visible") from other mql5 programs.

The library property tells the compiler that the EX5-file will be a library, and the compiler will show it
in the header of EX5.

All functions that are planned as exportable ones must be marked with the export modifier.

© 2000-2010, MetaQuotes Software Corp.


112 Language Basics

Event Handling Functions


The MQL5 language provides processing of some predefined events. Functions for handling these
events must be defined in the a MQL5 program; function name, return type, composition of
parameters (if there are any) and their types must strictly conform to the description of the event
handler function.

The event handler of the client terminal identifies functions, handling this or that event, by the type
of return value and type of parameters. If other parameters, not corresponding to below descriptions,
are specified for a corresponding function, or another return type is indicated for it, such a function
will not be used as an event handler.

OnStart

The OnStart() function is the Start event handler, which is automatically generated only for running
scripts. It must be of void type, with no parameters:

void OnStart();

For the OnStart() function, the int return type can be specified.

OnInit

The OnInit() function is the Init event handler. It must be of void or int type, with no parameters:

void OnInit();

The Init event is generated immediately after an Expert Advisor or an indicator is downloaded; this
event is not generated for scripts. The OnInit() function is used for initialization. If OnInit() has the
int type of the return value, the non-zero return code means unsuccessful initialization, and it
generates the Deinit event with the code of deinitialization reason REASON_INITFAILED.

The OnInit() function of the void type always denotes successful initialization.

OnDeinit

The OnDeinit() function is called during deinitialization and is the Deinit event handler. It must be
declared as the void type and should have one parameter of the const int type, which contains the
code of deinitialization reason. If a different type is declared, the compiler will generate a warning,
but the function will not be called. For scripts the Deinit event is not generated and therefore the
OnDeinit() function can't be used in scripts.

void OnDeinit(const int reason);

The Deinit event is generated for Expert Advisors and indicators in the following cases:

before reinitialization due to the change of a symbol or chart period, to which the mql5 program is
attached;
before reinitialization due to the change of input parameters;
before unloading a mql5 program.

OnTick

© 2000-2010, MetaQuotes Software Corp.


113 Language Basics

The NewTick event is generated for Expert Advisors only when a new tick for a symbol is received,
to the chart of which the Expert Advisor is attached. It's useless to define the OnTick() function in a
custom indicator or script, because the Tick event is not generated for them.

The Tick event is generated only for Expert Advisors, but this does not mean that Expert Advisors
required the OnTick() function, since not only Tick events are generated for Expert Advisors, but also
events of Timer, BookEvent and ChartEvent are generated. It must be declared as the void type, with
no parameters:

void OnTick();

OnTimer

The OnTimer() function is called when the Timer event occurs, which is generated by the system
timer only for Expert Advisors - it can't be used in scripts or indicators. The frequency of the event
occurrence is set when subscribing to notifications about this event to be received by the
EventSetTimer() function.

You can unsubscribe from receiving timer events for a particular Expert Advisor using the
EventKillTimer() function. The function must be defined with the void type, with no parameters:

void OnTimer();

It is recommended to call the EventSetTimer() function once in the OnInit() function, and the
EventKillTimer() function should be called once in OnDeinit().

Every Expert Advisor, as well as every indicator works with its own timer and receives events only
from it. As soon as a mql5 program stops operating, the timer is destroyed forcibly if it was created
but hasn't been disabled by the EventKillTimer() function.

OnTrade

The function is called upon the occurrence of Trade, which appears when you change the list of
placed orders and open positions, the history of orders and history of deals. When a trade activity is
performed pending order opening, position opening/closing, stops setting, pending order triggering,
etc.) the history of orders and trades and/or list of positions and current orders is changed
accordingly.

void OnTrade();

Users must independently implement in the code the verification of a trade account state when such
an event is received (if this is required by the trade strategy conditions). If the OrderSend() function
call has been completed successfully and returned a value of true, this means that the trading server
has put the order into the queue for execution and assigned a ticket number to it. As soon as the
server processes this order. the Trade event will be generated. And if the user remembers the ticket
value, during OnTrade() event handling he/she will be able to find out what happened to the order
using this value.

OnBookEvent

The OnBookEvent() function is the BookEvent handler. BookEvent is generated for Expert Advisors
only when Depth of Market changes. It must be of the void type and have one parameter of the string
type:

© 2000-2010, MetaQuotes Software Corp.


114 Language Basics

void OnBookEvent (const string& symbol);

To receive BookEvent events for any symbol, you just need to pre-subscribe to receive these events
for this symbol using the MarketBookAdd() function. In order to unsubscribe from receiving the
BookEvent events for a particular symbol, call MarketBookRelease().

Unlike other events, the BookEvent event is broadcast. This means that if one Expert Advisor
subscribes to receiving BookEvent events using MarketBookAdd, all the other Experts Advisors that
have the OnBookEvent() handler will receive this event. It is therefore necessary to analyze the name
of the symbol, which is passed to the handler as the const string& symbol parameter.

OnChartEvent

OnChartEvent() is the handler of a group of ChartEvent events:

CHARTEVENT_KEYDOWN — event of a keystroke, when the chart window is focused;


CHARTEVENT_OBJECT_CREATE — event of graphical object creation;
CHARTEVENT_OBJECT_CHANGE — event of an object property changed via the properties dialog;
CHARTEVENT_OBJECT_DELETE — event of graphical object deletion;
CHARTEVENT_OBJECT_CLICK — event of a mouse click in a graphical object belonging to the chart;
CHARTEVENT_OBJECT_DRAG — event of a graphical object move using the mouse;
CHARTEVENT_OBJECT_ENDEDIT — event of the finished text editing in the entry box of the
LabelEdit graphical object;
CHARTEVENT_CUSTOM+n — ID of the user event, where n is in the range from 0 to 65535.
CHARTEVENT_CUSTOM_LAST — the last acceptable ID of a custom event (CHARTEVENT_CUSTOM
+65535).

The function can be called only in Expert Advisors and indicators. The function should be of void
type with 4 parameters:

void OnChartEvent(const int id, // Event ID


const long& lparam, // Parameter of type long event
const double& dparam, // Parameter of type double event
const string& sparam // Parameter of type string events
);

OnCalculate

The OnCalculate() function is called only in custom indicators when it's necessary to calculate the
indicator values by the Calculate event. This usually happens when a new tick is received for the
symbol, for which the indicator is calculated. This indicator is not required to be attached to any price
chart of this symbol.

The OnCalculate() function must have a return type int. There are two possible definitions. Within
one indicator you cannot use both versions of the function.

The first form is intended for those indicators that can be calculated on a single data buffer. An
example of such an indicator is Custom Moving Average.

int OnCalculate (const int rates_total, // size of the price[] array

© 2000-2010, MetaQuotes Software Corp.


115 Language Basics

const int prev_calculated, // bars handled on a previous call


const int begin, // where the significant data start from
const double& price[] // array to calculate
);

As the price[] array, one of timeseries or a calculated buffer of some indicator can be passed. To
determine the direction of indexing in the price[] array, call ArrayGetAsSeries(). In order not to
depend on the default values, you must unconditionally call the ArraySetAsSeries() function for those
arrays, that are expected to work with.

The appropriate timeseries or indicator as the price[] array is selected by the user when starting the
indicator in the "Parameters" tab. To do this you must specify the necessary item in the drop-down list
of the "Apply to" field.

To receive values of a custom indicator from other mql5 programs, the iCustom() function is used,
which returns the indicator handle for nest operations. You can also specify the appropriate price[]
array or the handle of another indicator. This parameter should be transmitted last in the list of input
variables of the custom indicator.
Example:

void OnStart()
{
//---
string terminal_path=StatusInfoString(STATUS_TERMINAL_PATH);
int handle_customMA=iCustom(Symbol(),PERIOD_CURRENT, "Custom Moving Average",13,0, MODE_EMA,PRIC
if(handle_customMA>0)
Print("handle_customMA =",handle_customMA);
else
Print("Cannot open or not EX5 file '"+terminal_path+"\\MQL5\\Indicators\\"+"Custom Moving Ave
}

In this example, the last parameter passed is the PRICE_TYPICAL value (from the
ENUM_APPLIED_PRICE enumeration), which indicates that the custom indicator will be built on typical
prices obtained as (High+Low+Close)/3. If this parameter is not specified, the indicator is built based
on PRICE_CLOSE values, i.e. closing prices of each bar.

© 2000-2010, MetaQuotes Software Corp.


116 Language Basics

Another example that shows passing of the indicator handler as the last parameter to specify the
price[] array, is given in the description of the iCustom() function.

The second form is intended for all other indicators, in which more than one timeseries is used for
calculations.

int OnCalculate (const int rates_total, // size of input timeseries


const int prev_calculated, // bars handled in previous call
const datetime& time[], // Time
const double& open[], // Open
const double& high[], // High
const double& low[], // Low
const double& close[], // Close
const long& tick_volume[], // Tick Volume
const long& volume[], // Real Volume
const int& spread[] // Spread
);

Parameters of open[], high[], low[] and close[] contain arrays with open prices, high and low prices
and close prices of the current timeframe.The time[] parameter contains an array with open time
values, the spread[] parameter has an array containing the history of spreads (if any spread is
provided for the traded security). The parameters of volume[] and tick_volume[] contain the history
of trade and tick volume, respectively.

To determine the indexing direction of time[], open[], high[], low[], close[], tick_volume[], volume
[] and spread[], call ArrayGetAsSeries(). In order not to depend on default values, you should
unconditionally call the ArraySetAsSeries() function for those arrays, which are expected to work with.

The first rates_total parameter contains the number of bars, available to the indicator for
calculation, and corresponds to the number of bars available in the chart.

We should noted the connection between the return value of OnCalculate() and the second input
parameter prev_calculated. During the function call, the prev_calculated parameter contains a value
returned by OnCalculate() during previous call. This allows for economical algorithms for calculating
the custom indicator in order to avoid repeated calculations for those bars that haven't changed since
the previous run of this function.

For this, it is usually enough to return the value of the rates_total parameter, which contains the
number of bars in the current function call. If since the last call of OnCalculate() price data has
changed (a deeper history downloaded or history blanks filled), the value of the input parameter
prev_calculated will be set to zero by the terminal.

Note: if OnCalculate returns zero, then the indicator values are not shown in the DataWindow of the
client terminal.

To understand it better, it would be useful to start the indicator, whose code is attached below.

Indicator Example:
#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1

© 2000-2010, MetaQuotes Software Corp.


117 Language Basics

//---- plot Line


#property indicator_label1 "Line"
#property indicator_type1 DRAW_LINE
#property indicator_color1 DarkBlue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double LineBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,LineBuffer,INDICATOR_DATA);
//---
return(0);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime& time[],
const double& open[],
const double& high[],
const double& low[],
const double& close[],
const long& tick_volume[],
const long& volume[],
const int& spread[])
{
//--- Get the number of bars available for the current symbol and chart period
int bars=Bars(Symbol(),0);
Print("Bars =",bars,", rates_total =",rates_total,", prev_calculated =",prev_calculated);
Print("time[0] =",time[0]," time[rates_total-1] =",time[rates_total-1]);
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+

See also
Running Programs, Client Terminal Events, Working with Events

© 2000-2010, MetaQuotes Software Corp.


118 Language Basics

Variables
Declaring Variables

Variables must be declared before they are used. Unique names are used to identify variables.
Descriptions of variables are used for them to be defined and for types to be declared. Description is
not an operator.

Simple types are:

char, short, int, long, uchar, ushort, uint, ulong – integers;


color – integer representing the RGB-color;
datetime – the date and time, an unsigned integer containing the number of seconds since 0 hour
January 1, 1970;
bool – boolean values true and false;
double – double-precision floating point number;
float – single-precision floating point number;
string – character strings.

Examples:

string szInfoBox;
int nOrders;
double dSymbolPrice;
bool bLog;
datetime tBegin_Data = D'2004.01.01 00:00';
color cModify_Color = C'0x44,0xB9,0xE6';

Complex or compound types:

Structures are composite data types, constructed using other types.

struct MyTime
{
int hour; // 0-23
int minute; // 0-59
int second; // 0-59
};
...
MyTime strTime; // Variable of the previously declared structure MyTime MyTime

You can't declare variables of the structure type until you declare the structure.

Arrays

Array is the indexed sequence of identical-type data:

int a[50]; // One-dimensional array of 50 integers.


double m[7][50]; // Two-dimensional array of seven arrays,
// each of them consisting of 50 numbers.
MyTime t[100]; // Array containing elements such as MyTime

© 2000-2010, MetaQuotes Software Corp.


119 Language Basics

Only an integer can be an array index. No more than four-dimensional arrays are allowed.
Numbering of array elements starts with 0. The last element of a one-dimensional array has the
number which is 1 less than the array size. This means that call for the last element of an array
consisting of 50 integers will appear as a[49]. The same concerns multidimensional arrays: A
dimension is indexed from 0 to the dimension size-1. The last element of a two-dimensional array
from the example will appear as m[6][49].

Static arrays can't be represented as timeseries, i.e., the ArraySetAsSeries() function, which sets
access to array elements from the end to beginning, can't be applied to them. If you want to provide
access to an array the same as in timeseries, use the dynamic array object.

If there is an attempt to access out of the array range, the executing subsystem will generate a
critical error and the program will be stopped.

Access Specifiers

Access specifiers define how the compiler can access variables, members of structures or classes.

The const specifier declares a variable as a constant, and does not allow to change this variable
during runtime. A single initialization of a variable is allowed when declaring it. The const specifier
can't be applied to members of structures and classes.

Sample

int OnCalculate (const int rates_total, // size of the price[] array


const int prev_calculated, // bars handled on a previous call
const int begin, // where the significant data start from
const double& price[] // array to calculate
);

To access members of structures and classes use the following qualifiers:

public – allows unrestricted access to the variable or class method


protected – allows access from methods of this class, as well as from methods of publicly inherited
classes. Other access is impossible;
private – allows access to variables and class methods only from methods of the same class.
virtual – applies only to class methods (but not to methods of structures) and tells the compiler that
this method should be placed in the table of virtual functions of the class.

Storage Classes

There are three storage classes: static, input and extern. These modifiers of a storage class
explicitly indicate to the compiler that corresponding variables are distributed in a pre-allocated area
of memory, which is called the global pool. Besides, these modifiers indicate the special processing of
variable data. If a variable declare on a local level is not a static one, memory for such a variable is
allocated automatically at a program stack.

© 2000-2010, MetaQuotes Software Corp.


120 Language Basics

Local Variables
A variable declared inside a function is local. The scope of a local variable is limited to the function
range inside which it is declared. Local variable can be initialized by outcome of any expression. Every
call of the function initializes a local variable. Local variables are stored in memory area of the
corresponding function.

Example:

int somefunc()
{
int ret_code=0;
...
return(ret_code);
}

Scope of a variable is a program part, in which a variable can referred to. Variables declared inside
a block (at the internal level), have the block as their scope. The block scope start with the variable
declaration and ends with the final right brace.

Local variables declared in the beginning of a function also have the scope of block, as well as
function parameters that are local variables. Any block can contain variable declarations. If blocks are
nested and the identifier in the external block has the same name as the identifier in the internal
block, the external block identifier is hidden, until the operation of the internal block is over.

Example:

void OnStart()
{
//---
int i=5; // local variable of the function
{
int i=10; // function variable
Print("In block i=",i); // result is i=10;
}
Print("Outside block i=",i); // result is i=5;
}

This means that while the internal block is running, it sees values of its own local identifiers, not
the values of identifiers with identical names in the external block.

Example:

void OnStart()
{
//---
int i=5; // local variable of the function
for(int i=0;i<3;i++)
Print("Inside for i =",i);
Print("Outside the block i =",i);
}
/* Execution result

© 2000-2010, MetaQuotes Software Corp.


121 Language Basics

Inside for i = 0
Inside for i = 1
Inside for i = 2
Outside block i = 5
*/

Local variables declared as static have the scope of the block, despite the fact that they exist since
the program start.

© 2000-2010, MetaQuotes Software Corp.


122 Language Basics

Formal Parameters
Parameters passed to the function are local. The scope is the function block. Formal parameters
must have names differing from those of external variables and local variables defined within one
function. Some values can be assigned to formal parameters in the function block. If a formal
parameter is declared with the const modifier, its value can't be changed within the function.

Example:

void func(const int x[], double y, bool z)


{
if(y>0.0 && !z)
Print(x[0]);
...
}

Formal parameters can be initialized by constants. In this case, the initializing value is considered
as the default value. Parameters, next to the initialized one, must also be initialized.

Example:

void func(int x, double y = 0.0, bool z = true)


{
...
}

When calling such a function, the initialized parameters can be omitted, the defaults being
substituted instead of them.

Example:

func(123, 0.5);

Parameters of simple types are passed by value, i.e., modifications of the corresponding local
variable of this type inside the called function will not be shown in the calling function in any way.
Arrays of any type and data of the structure type are always passed by reference. If it's necessary to
prohibit modifying the array or structure contents, the parameters of these types must be declared
with the const keyword.

There is an opportunity to pass parameters of simple types by reference. In this case, modification
of such parameters will affect the corresponding variables in the called function passed by reference.
In order to indicate that a parameter is passed by reference, put the & modifier after the data type.

Example:

void func(int& x, double& y, double& z[])


{
double calculated_tp;
...
for(int i=0; i<OrdersTotal(); i++)
{
if(i==ArraySize(z)) break;
if(OrderSelect(i)==false) break;

© 2000-2010, MetaQuotes Software Corp.


123 Language Basics

z[i]=OrderOpenPrice();
}
x=i;
y=calculated_tp;
}

Parameters passed by reference, can't be initialized by default values.

Maximum 64 parameters can be passed into a function.

See also
Input Variables

© 2000-2010, MetaQuotes Software Corp.


124 Language Basics

Static Variables
The storage class of static defines a static variable. The static modifier is indicated before the data
type.

Example:

int somefunc()
{
static int flag=10;
...
return(flag);
}

A static variable can be initialized by a constant or constant expression corresponding to its type,
unlike a simple local variable, which can be initialized by any expression.

Static variables exist from the moment of program execution and are initialized only once before
the specialized functions OnInit() is called. If the initial values are not specified, variables of the
static storage class are taking zero initial values.

Local variables declared with the static keyword retain their values throughout the function lifetime.
With each next function call, such local variables contain the values that they had during the previous
call.

Any variables in a block, except formal parameters of a function, can be defined as static. If a
variable declare on a local level is not a static one, memory for such a variable is allocated
automatically at a program stack.

Example:

int Counter()
{
static int count;
count++;
if(count%100==0) Print("Function Counter has been called",count,"times");
return count;
}
void OnStart()
{
//---
int c=345;
for(int i=0;i<1000;i++)
{
int c=Counter();
}
Print("c =",c);
}

© 2000-2010, MetaQuotes Software Corp.


125 Language Basics

Global Variables
Global variables are created by placing their declarations outside function descriptions. Global
variables are defined at the same level as functions, i.e., they are not local in any block.

Example:

int GlobalFlag=10; // Global variable


int OnStart()
{
...
}

The scope of global variables is the entire program. Global variables are accessible from all
functions defined in the program. They are initialized to zero unless another initial value is explicitly
defined. A global variable can be initialized only by a constant or constant expression that corresponds
to its type.

Global Variables are initialized only once right after the program is loaded into the client terminal
memory.

Note: Variables declared at global level must not be mixed up with the client terminal global
variables that can be accessed using the GlobalVariable...() functions.

© 2000-2010, MetaQuotes Software Corp.


126 Language Basics

Input Variables
The input storage class defines the external variable. The input modifier is indicated before the
data type. A variable with the input modifier can't be changed inside mql5-programs, such variables
can be accessed for reading only. Values of input variables can be changed only by a user from the
program properties window.

Example:

//--- input parameters


input int MA_Period=13;
input int MA_Shift=0;
input ENUM_MA_METHOD MA_Method=MODE_SMMA;

Input variables determine the input parameters of a program. They are available from the
Properties window of a program.

It is possible to set another way to display names of input parameters in the Inputs tab. To do this,
a string comment is used, which should be located after the description of an input parameter in the
same line. Thus, names more understandable for a user can be matched to input parameters.

Example:

//--- input parameters


input int InpMAPeriod=13; // Smoothing period
input int InpMAShift=0; // Line horizontal shift
input ENUM_MA_METHOD InpMAMethod=MODE_SMMA; // Smoothing method

© 2000-2010, MetaQuotes Software Corp.


127 Language Basics

Note: Arrays and variables of complex types can't act as input variables.

Passing Parameters When Calling Custom Indicators from MQL5 Programs

Custom Indicators are called using the iCustom() function. After the name of the custom indicator,
parameters should go in a strict accordance with the declaration of input variables of this custom
indicator. If indicated parameters are less than input variables declared in the called custom indicator,
the missing parameters are filled with values specified during the declaration of variables.

If the custom indicator uses the OnCalculate function of the first type (i.e., the indicator is
calculated using the same array of data), then one of ENUM_APPLIED_PRICE values or handle of
another indicator should be used as the last parameter when calling such a custom indicator. All
parameters corresponding to input variables must be clearly indicated.

Enumerations as input Parameters

Not only built-in enumerations provided in MQL5, but also user defined variables can be used as
input variables (input parameters for mql5 programs). For example, we can create the dayOfWeek
enumeration, describing days of the week, and use the input variable to specify a particular day of the
week, not as a number, but in a more common way.

Example:

#property script_show_inputs
//--- day of week
enum dayOfWeek
{
S=0, // Sunday
M=1, // Monday
T=2, // Tuesday
W=3, // Wednesday
Th=4, // Thursday
Fr=5, // Friday,
St=6, // Saturday
};

© 2000-2010, MetaQuotes Software Corp.


128 Language Basics

//--- input parameters


input dayOfWeek swapday=W;

In order to enable a user to select a necessary value from the properties window during the script
startup, we use the preprocessor command #property script_show_inputs. We start the script and can
choose one of values of the dayOfWeek enumeration from the list. We start the EnumInInput script
and go to the Inputs tab. By default, the value of swapday (day of triple swap charge) is Wednesday
(W = 3), but we can specify any other value, and use this value to change the program operation.

Number of possible values of an enumeration is limited. Therefore, in order to select the input
value the drop-down list is used. Mnemonic names of enumeration members are used for values
displayed in the list. If a comment is associated with a mnemonic name, as shown in this example,
the comment content is used instead of the mnemonic name.

Each value of the dayOfWeek enumeration has its value from 0 to 6, but in the list of parameters,
comments specified for each value will be shown. This provides additional flexibility for writing
programs with clear descriptions of input parameters.

See also
iCustom, Enumerations, Properties of Programs

© 2000-2010, MetaQuotes Software Corp.


129 Language Basics

Extern Variables
The extern keyword is used for declaring variable identifiers as identifiers of the static storage
class with global lifetime. These variables exist from the start of the program and memory for them is
allocated and initialized immediately after the start of the program.

You can create programs that consist of multiple source files; in this case a directive to the
preprocessor #include is used. Variables declared as an extern with the same type and identifier can
exist in different source files of one project.

When compiling the whole project, all the extern variables with the same type and an identifier are
associated with one part of memory of the global variable pool. Extern variables are useful for
separate compilation of source files. Extern variables can be initialized, but only once - existence of
several initializes extern variables of the same type and with the same identifier is prohibited.

© 2000-2010, MetaQuotes Software Corp.


130 Language Basics

Initialization of Variables
Any variable can be initialized during definition. If a variable is not initialized explicitly, the value
stored in this variable can be any. Implicit initialization is not used.

Global and static variables can be initialized only by a constant of the corresponding type or a
constant expression. Local variables can be initialized by any expression, not just a constant.

Initialization of global and static variables is performed only once. Initialization of local variables is
made every time you call the corresponding functions.

Examples:

int n = 1;
string s = "hello";
double f[] = { 0.0, 0.236, 0.382, 0.5, 0.618, 1.0 };
int a[4][4] = { {1, 1, 1, 1}, {2, 2, 2, 2}, {3, 3, 3, 3}, {4, 4, 4, 4 } };
//--- from tetris
int right[4]={WIDTH_IN_PIXELS+VERT_BORDER,WIDTH_IN_PIXELS+VERT_BORDER,
WIDTH_IN_PIXELS+VERT_BORDER,WIDTH_IN_PIXELS+VERT_BORDER};

List of values of the array elements must be enclosed in curly brackets. Missed initializing
sequences are considered equal to 0. The initializing sequence must have at least one value: this
value is initialized to the first element of the corresponding structure or array, missing elements are
considered equal to zero.

If the size of the initialized array is not specified, it is determined by a compiler, based on the size
of the initialization sequence. Multi-dimensional arrays cannot be initialized by a one-dimensional
sequence (a sequence without additional curly brackets), except for the case, when only one
initializing element is specified (zero, as a rule).

Arrays (including those announced at the local level) can be initialized only by constants.

Examples:

struct str3
{
int low_part;
int high_part;
};
struct str10
{
str3 s3;
double d1[10];
int i3;
};
void OnStart()
{
str10 s10_1={{1,0},{1.0,2.1,3.2,4.4,5.3,6.1,7.8,8.7,9.2,10.0},100};
str10 s10_2={{1,0},{0},100};
str10 s10_3={{1,0},{1.0}};

© 2000-2010, MetaQuotes Software Corp.


131 Language Basics

//---
Print("1. s10_1.d1[5] =",s10_1.d1[5]);
Print("2. s10_2.d1[5] =",s10_2.d1[5]);
Print("3. s10_3.d1[5] =",s10_3.d1[5]);
Print("4. s10_3.d1[0] =",s10_3.d1[0]);
}

© 2000-2010, MetaQuotes Software Corp.


132 Language Basics

Visibility Scope and Lifetime of Variables


There are two basic types of scope: local scope and global scope.

A variable declared outside all functions is located into the global scope. Access to such variables
can be done from anywhere in the program.These variables are located in the global pool of memory,
so their lifetime coincides with the lifetime of the program.

A variable declared inside a block (part of code enclosed in curly brackets) belongs to the local
scope. Such a variable is not visible (and therefore not available) outside the block, in which it is
declared. The most common case of local declaration is a variable declared within a function. A
variable declared locally, is located on the stack, and the lifetime of such a variable is equal to the
lifetime of the function.

Since the scope of a local variable is the block in which it is declared, it is possible to declare
variables with the same name, as those of variables declared in other blocks; as well as of those
declared at upper levels, up to the global level.

Example:

void CalculateLWMA(int rates_total,int prev_calculated,int begin,const double &price[])


{
int i,limit;
static int weightsum=0;
double sum=0;
//---
if(prev_calculated==0)
{
limit=MA_Period+begin;
//--- set empty value for first limit bars
for(i=0; i<limit; i++) LineBuffer[i]=0.0;
//--- calculate first visible value
double firstValue=0;
for(int i=begin; i<limit; i++)
{
int k=i-begin+1;
weightsum+=k;
firstValue+=k*price[i];
}
firstValue/=(double)weightsum;
LineBuffer[limit-1]=firstValue;
}
else
{
limit=prev_calculated-1;
}

for(i=limit;i<rates_total;i++)
{
sum=0;

© 2000-2010, MetaQuotes Software Corp.


133 Language Basics

for(int j=0; j<MA_Period; j++) sum+=(MA_Period-j)*price[i-j];


LineBuffer[i]=sum/weightsum;
}
//---
}

Pay attention to the variable i, declared in line

for(int i=begin; i<limit; i++)


{
int k=i-begin+1;
weightsum+=k;
firstValue+=k*price[i];
}

Its scope is only the for cycle; outside of this cycle there is another variable with the same name,
declared at the beginning of the function. In addition, the k variable is declared in the loop body, its
scope is the loop body.

Local variables can be declared with the access specifier static. In this case, the compiler has a
variable in the global pool of memory. Therefore, the lifetime of a static variable is equal to the
lifetime of the program. Here the scope of such a variable is limited to the block in which it is
declared.

© 2000-2010, MetaQuotes Software Corp.


134 Language Basics

Creating and Deleting Objects


After a mql5 program is loaded for execution, memory is allocated to each variable according to its
type. According to the access level all variables are divided into two types - global variables and local
variables. According to the memory class they can be input parameters of a mql5 program, static and
automatic. If necessary, each variable is initialized by a corresponding value. After being used a
variable is unintialized and memory used by it is returned to the MQL5 executable system.

Initialization and Deinitialization of Global Variables


Global variables are initialized automatically right after a mql5 program is loaded and before any of
function is called. During initialization initial values are assigned to variables of simple types and a
constructor (if there is any) is called for objects. Input variables are always declared at a global level,
and are initialized by values set by a user in the dialog during the program start.

Despite the fact that static variables are usually declared at a local level, the memory for these
variables is pre-allocated, and initialization is performed right after a program is loaded, the same as
for global variables.

The initialization order corresponds to the variable declaration order in the program.
Deinitialization is performed in the reverse order. This rule is true only for the variables that were not
created by the new operator. Such variables are created and initialized automatically right after
loading, and are deinitialized before the program unloading.

Initialization and Deinitialization of Local Variables


If a variable declared on a local level is not a static one, memory is allocated automatically for such
a variable. Local variables, as well as global ones, are initialized automatically at the moment when
the program execution meets the declaration of a local variable. Thus the initialization order
corresponds to the order of declaration.

Local variables are deinitialized at the end of the program block, in which they were declared, and
in the order opposite to their declaration. A program block is a compound operator that can be a part
of selection operator switch, cycle operator (for, while, do-while), a function body or a part of the if-
else operator.

Local variables are initialized only at the moment when the program execution meets the variable
declaration. If during the program execution the block, in which the variable is declared, was not
executed, such a variable is not initialized.

Initialization and Deinitialization of Objects Placed


A special case is that with object pointers, because declaration of a pointer does not entail
initialization of a corresponding objects. Dynamically placed objects are initialized only at the moment
when the class sample is created by the new operator. Initialization of objects presupposes call of a
constructor of a corresponding class. If there is no corresponding constructor in the class, its members
of a simple type will not be automatically initialized; members of types string, dynamic array and
complex object will be automatically initialized.

Pointers can be declared on a local or global level; and they can be initialized by the empty value of
NULL or by the value of the pointer of the same or inherited type. If the new operator is called for a

© 2000-2010, MetaQuotes Software Corp.


135 Language Basics

pointer declared on a local level, the delete operator for this pointer must be performed before exiting
the level. Otherwise the pointer will be lost and the explicit deletion of the object will fail.

All objects created by the expression of object_pointer=new Class_name, must be then deleted by
the delete(object_pointer) operator. If for some reasons such a variable is not deleted by the delete
operator when the program is completed, the corresponding entry will appear in the "Experts" journal.
One can declare several variables and assign a pointer of one object to all of them.

If a dynamically created object has a constructor, this constructor will be called at the moment of
the new operator execution. If an object has a destructor, it will be called during the execution of the
delete operator.

Thus dynamically placed objects are created only at the moment when are created by the new
operator, and are assuredly deleted either by thedelete operator or automatically by the executing
system of MQL5 during the program unloading. The order of declaration of pointers of dynamically
created object doesте influence the order of their initialization. The order of initialization and
deinitialization is fully controlled by the programmer.

Brief Characteristics of Variables


The main information about the order of creation, deletion, about calls of constructors and
destructors is given in the below table.

Global automatic Local automatic Dynamically


variable variable created object

Initialization right after a mql5 when he code line at the execution of


program is loaded where it is declared is the new operator
reached during
execution

Initialization order in the order of in the order of irrespective of the


declaration declaration order of declaration

Deinitialization before a mql5 when execution exits when the delete


program is unloaded the declaration block operator is executed
or before a mql5
program is unloaded

Deinitialization order in the order opposite in the order opposite irrespective of the
to the initialization to the initialization initialization order
order order

Constructor call at mql5 program at initialization at the execution of


loading the new operator

Destructor call at mql5 program when exiting the at the execution of


unloading block where the the delete operator
variable was
initialized

Error logs log in the "Experts" log in the "Experts" log in the "Experts"
journal about the journal about the journal about
attempt to delete an attempt to delete an undeleted dynamically

© 2000-2010, MetaQuotes Software Corp.


136 Language Basics

automatically created automatically created created objects at the


object object unload of a mql5
program

© 2000-2010, MetaQuotes Software Corp.


137 Language Basics

Preprocessor
Preprocessor is a special subsystem of the MQL5 compiler that is intended for preparation of the
program source code immediately before the program is compiled.

Preprocessor allows enhancement of the source code readability. The code can be structured by
including of specific files containing source codes of mql5-programs. The possibility to assign
mnemonic names to specific constants contributes to enhancement of the code readability.

Preprocessor also allows determining specific parameters of mql5-programs:

Declare constants
Set program properties
Include files in program text
Import functions

If the # symbol is used in the first line of the program, this line is a preprocessor directive. A
preprocessor directive ends with a line feed character.

© 2000-2010, MetaQuotes Software Corp.


138 Language Basics

Declaration of Constants (#define)


The #define dirctive can be used to assign mnemonic names to constants.

#define identifier token_string

The #define directive substitutes token_string for all further found entries of identifier in the
source text. The identifier is replaced only if it is a separate token. The identifier is not replaced if it
is part of a comment, part of a string, or part of another longer identifier.

The constant identifier is governed by the same rules as variable names. The value can be of any
type:

#define ABC 100


#define PI 3.14
#define COMPANY_NAME "MetaQuotes Software Corp."
...
void ShowCopyright()
{
Print("Copyright 2001-2009, ",COMPANY_NAME);
Print("http://www.metaquotes.net");
}

token_string can consist of several tokens, such as keywords, constants, constant and non-constant
expressions. token_string ends with the end of the line and can't be transferred to the next line.

Example:

#define TWO 2
#define THREE 3
#define INCOMPLETE TWO+THREE
#define COMPLETE (TWO+THREE)
void OnStart()
{
Print("2+3*2 =",INCOMPLETE*2);
Print("(2+3)*2 =",COMPLETE*2);
}
/* Result
2+3*2 = 8
(2+3)*2 = 10
*/

© 2000-2010, MetaQuotes Software Corp.


139 Language Basics

Program Properties (#property)


Every mql5-program allows to specify additional specific parameters named #property that help
client terminal in proper servicing for programs without the necessity to launch them explicitly. This
concerns external settings of indicators, first of all. Properties described in included files are
completely ignored. Properties must be specified in the main mq5-file.

#property identifier value

The compiler will write declared values in the configuration of the module executed.

Constant Type Description

link string link to the company website

copyright string the company name

version string program version, maximum 31


characters

description string brief text description of a


mql5-program. Several
description can be present,
each of them describes one
line of the text. The total
length of all description can
not exceed 511 characters
including line feed.

stacksize int size of the stack for recursive


calls

library a library; no start function is


assigned, functions with the
export modifier can be
imported in other mql5-
programs

indicator_applied_price int specifies the default value for


the "Apply to" field. You can
specify one of the values of
ENUM_APPLIED_PRICE. If the
property is not specified, the
default value is PRICE_CLOSE

indicator_chart_window show the indicator in the chart


window

indicator_separate_window show the indicator in a


separate window

indicator_buffers int number of buffers for


indicator calculation

indicator_plots int number of graphic series in


the indicator

© 2000-2010, MetaQuotes Software Corp.


140 Language Basics

indicator_minimum double the bottom scaling limit for a


separate indicator window

indicator_maximum double the top scaling limit for a


separate indicator window

indicator_labelN string sets a label for the N-th


graphic series displayed in
DataWindow. For graphic
series requiring multiple
indicator buffers
(DRAW_CANDLES,
DRAW_FILLING and others),
the tag names are defined by
the separator ';'.

indicator_colorN color the color for displaying line N,


where N is the number of
graphic series; numbering
starts from 1

indicator_widthN int line thickness in graphic series


, where N - number of graphic
series, numbering starts from
1

indicator_styleN int line style in graphic series,


specified by the values of
ENUM_LINE_STYLE. N -
number of graphic series,
numbering starts from 1

indicator_typeN int type of graphical construction,


specified by the values of
ENUM_DRAW_TYPE. N -
number of graphic series,
numbering starts from 1

indicator_levelN double horizontal level of N in a


separate indicator window

indicator_levelcolor color color of horizontal levels of the


indicator

indicator_levelwidth int thickness of horizontal levels


of the indicator

indicator_levelstyle int style of horizontal levels of the


indicator

script_show_confirm display a confirmation window


before running the script

script_show_inputs display a window with the


properties before running the

© 2000-2010, MetaQuotes Software Corp.


141 Language Basics

script and disable this


confirmation window

tester_indicator string Name of a custom indicator in


the format of "
indicator_name.ex5".
Indicators that require testing
are defined automatically from
the call of the iCustom()
function, if the corresponding
parameter is set through a
constant string. For all other
cases (use of the
IndicatorCreate() function or
use of a non-constant string in
the parameter that sets the
indicator name) this property
is required

tester_file string Library name with the


extension, in single quotes.
Input files to be tested, if
there are necessary ones,
must always be specified

tester_library string File name for a tester with the


indication of extension, in
single quotes (as a constant
string). The specified file will
be passed to tester. Libraries
that require testing are
defined automatically.
However, if any of libraries is
used by a custom indicator,
this property is required

Sample Task of Description and Version Number

#property version "3.70" // Current version of the Expert Advisor


#property description "ZigZag universal with Pesavento Patterns"
#property description "At the moment in the indicator several ZigZags with different algorithms are
#property description "It is possible to embed a large number of other indicators showing the highs
#property description "lows and automatically build from these highs and lows various graphical too

© 2000-2010, MetaQuotes Software Corp.


142 Language Basics

Examples of Specifying a Separate Label for Each Indicator Buffer ( "C open; C high; C low; C
close")

#property indicator_chart_window
#property indicator_buffers 4
#property indicator_plots 1
#property indicator_type1 DRAW_CANDLES
#property indicator_width1 3
#property indicator_label1 "C open;C high;C low;C close"

© 2000-2010, MetaQuotes Software Corp.


143 Language Basics

Including Files (#include)


The #include command line can be placed anywhere in the program, but usually all inclusions are
placed at the beginning of the source code. Call format:

#include <file_name>
#include "file_name"

Examples:

#include <WinUser32.mqh>
#include "mylib.mqh"

The preprocessor replaces the line #include <file_name> with the content of the file WinUser32.
mqh. Angle brackets indicate that the WinUser32.mqh file will be taken from the standard directory
(usually it is terminal_installation_directory\MQL5\Include). The current directory is not visible.

If the file name is enclosed in quotation marks, the search is made in the current directory (which
contains the main source file). The standard directory is not visible.

© 2000-2010, MetaQuotes Software Corp.


144 Language Basics

Importing Function (#import)


Functions are imported from compiled MQL5 modules (*. ex5 files) and from operating system
modules (files *. dll). The module name is specified in the #import directive. For compiler to be able
to correctly form the imported function call and organize proper transmission parameters, the full
description of functions is needed. Function descriptions immediately follow the #import "module
name" directive. New command #import (can be without parameters) completes the block of imported
function descriptions.

#import "file_name"
func1 define;
func2 define;
...
funcN define;
#import

Imported functions can have any names. Functions having the same names but from different
modules can be imported at the same time. Imported functions can have names that coincide with the
names of built-in functions. Operation of scope resolution defines which of the functions should be
called.

Since the imported functions are outside the compiled module, the compiler can not verify the
validity of passed parameters. Therefore, to avoid run-time errors, one must accurately describe the
composition and order of parameters passed to imported functions. Parameters passed to imported
functions (both from EX5, and from the DLL-module) can have default values.

The following can't be used for parameters in imported functions:

pointers (*);
links to objects that contain dynamic arrays and/or pointers.
Classes, string arrays or complex objects that contain strings and/or dynamic arrays of any types
cannot be passed as a parameter to functions imported from DLL.

Examples:

#import "user32.dll"
int MessageBoxW(uint hWnd,string lpText,string lpCaption,uint uType);
#import "stdlib.ex5"
string ErrorDescription(int error_code);
int RGB(int red_value,int green_value,int blue_value);
bool CompareDoubles(double number1,double number2);
string DoubleToStrMorePrecision(double number,int precision);
string IntegerToHexString(int integer_number);
#import "ExpertSample.dll"
int GetIntValue(int);
double GetDoubleValue(double);
string GetStringValue(string);
double GetArrayItemValue(double &arr[],int,int);
bool SetArrayItemValue(double &arr[],int,int,double);
double GetRatesItemValue(double &rates[][6],int,int,int);
#import

© 2000-2010, MetaQuotes Software Corp.


145 Language Basics

To import functions during execution of a mql5 program, early binding is used. This means that the
library is loaded during the loading of a program using its ex5 program.

It's not recommended to use a fully qualified name of the loadable module of type Drive:
\Directory\FileName.Ext. MQL5 libraries are loaded from the terminal_dir\MQL5\Libraries folder.

© 2000-2010, MetaQuotes Software Corp.


146 Language Basics

Object-Oriented Programming
Object-oriented programming (OOP) is programming primarily focused on data, data and behavior
being inseparably linked. Data and behavior together constitute a class, while objects are class
instances.

The components of the object-oriented approach are:

Encapsulation and type extensibility


Inheritance
Polymorphism
Overloading
Virtual functions

OOP considers computation as modeling of behavior. The modeled item is the object represented by
computational abstractions. Suppose we want to write a well known game "Tetris". To do this, we
must learn how to model the appearance of random shapes composed of four squares joined together
by ribs. Also we need to regulate the falling speed of shapes, define operations of rotation and shift of
shapes. Moving of shapes on the screen is limited by the DOM boundaries, this requirement must also
be modeled. Besides that, filled rows of cubes must be destroyed and earned points must be counted.

Thus, this easy-to-understand game requires the creation of several models - shape model, DOM
model, shape movement model and so on. All these models are abstractions, represented by
calculations in the computer. To describe these models, the concept of Abstract Data Type, ADT (or
complex data type) is used. Strictly speaking, the model of the "shapes" motion in the DOM is not a
data type, but it is the totality of operations with the "shape" data type, using the restrictions of the
"DOM" data type.

Objects are class variables. Object-oriented programming allows you to easily create and use ADT.
Object-oriented programming uses the inheritance mechanism. The advance of the inheritance is in
the fact that it allows obtaining derivative types from data types already defined by a user.

For example, to create Tetris shapes, it's convenient to create a base class Shape first; the other
seven classes representing all of the possible shape types can be derived on its basis. Behavior of
shapes is defined in the base class, while implementation of behavior of each separate shape is
defined in derivative classes.

In OOP objects are responsible for their behavior. ADT developer should include a code to describe
any behavior that would normally be expected from the corresponding objects. The fact that the
object itself is responsible for its behavior, greatly simplifies the task of programming for the user of
this object.

If we want to draw a shape on the screen, we need to know where the center will be and how to
draw it. If a separate shape is well aware of how to draw itself, the programmer should send a "draw"
message when using such a shape.

The MQL5 Language is a C++ like, and it also has the encapsulation mechanism for the
implementation of ADT. Encapsulation combines, on the one hand, the internal details of the
implementation of a particular type and, on the other hand, externally accessible functions that can
influence objects of this type. Implementation details may be inaccessible for a program that uses this

© 2000-2010, MetaQuotes Software Corp.


147 Language Basics

type.

The concept of OOP has a set of related concepts, including the following:

Simulation of actions from the real world


Availability of user-defined data types
Hiding the implementation details
Possibility of the code reuse through inheritance
Interpretation of function calls during execution
Some of these concepts are rather vague, some are abstract, others are of general character.

© 2000-2010, MetaQuotes Software Corp.


148 Language Basics

Encapsulation and Extensibility of Types


OOP is a balanced approach to writing software. Data and behavior are packed together. This
encapsulation creates user-defined data types, extending the language data types and interacting with
them. Types extensibility is an opportunity to add to the language user-defined data types, which are
also easy to use, as well as basic types.

An abstract data type, for example, a string, is a description of the ideal, well known behavior type.

The string user knows that the string operations, such as concatenation or print, have a certain
behavior. Concatenation and print operations are called methods.

A certain implementation of ADT may have some restrictions, for example, strings can be limited in
length. These limitations affect the behavior opened to all. At the same time, internal or private
implementation details do not affect directly the way the user sees the object. For example, the string
is often implemented as an array, while the internal base address of this array and its name are not
essential for the user.

Encapsulation is the ability to hide the implementation details when the open interfaces to user-
defined type is provided. In MQL5, as well as in C++, class and structure definitions (class and struct)
are used for the encapsulation provisions in combination with access keywords private, protected and
public.

The public keyword shows that access to the members that stand behind it, is open without
restrictions. Without this keyword, class members are locked by default. Private members are
accessible only by member functions only of its class.

Protected class functions are available to class functions not only in its class, but also in its inheritor
classes. Public class functions are available for any function within the scope of the class declaration.
The protection makes possible to hide part of the class implementation, thus preventing unexpected
changes in the structure of data. Access restriction or data hiding is a feature of the object-oriented
programming.

Usually, class functions are protected and declared with the protected modifier, the reading and
writing of the values are performed by using special so-called set-and get-methods that are defined by
the publics access modifier.

Example:

class CPerson{}
{
protected:
string m_name; // name
public:
void SetName(string n){m_name=n;}// sets name
string GetName(){return (m_name);} // returns name
};

This approach offers several advantages. First, by function name we can understand what it does -

© 2000-2010, MetaQuotes Software Corp.


149 Language Basics

sets or gets the value of a class member. Secondly, perhaps in the future we will need to change the
type of the m_name CPerson variable in the CPerson class or in any it's derivative classes.

In this case, we'll need just to change the implementation of functions SetName() and GetName(),
while objects of the CPerson class will be available for using in a program without any code changes
because the user will not even know that the data type of m_name has changed.

Example:

struct Name
{
string first_name; // name
string last_name; // last name
};

class CPerson
{
protected:
Name m_name; // name
public:
void SetName(string n);
string GetName(){return(m_name.first_name+" "+m_name.last_name);}
private:
string GetFirstName(string full_name);
string GetLastName(string full_name);
};

void CPerson::SetName(string n)
{
m_name.first_name=GetFirstName(n);
m_name.last_name=GetLastName(n);
}

string CPerson::GetFirstName(string full_name)


{
int pos=StringFind(full_name," ");
if(pos>0) StringSetCharacter(full_name,pos,0);
return(full_name);
}

string CPerson::GetLastName(string full_name)


{
string ret_string;
int pos=StringFind(full_name," ");
if(pos>0) ret_string=StringSubstr(full_name,pos+1);
else ret_string=full_name;
return(ret_string);
}

© 2000-2010, MetaQuotes Software Corp.


150 Language Basics

Inheritance
The characteristic feature of OOP is the encouragement of code reuse through inheritance. A new
class is made from the existing, which is called the base class. The derived class uses the members of
the base class, but can also modify and supplement them.

Many types are variations of the existing types. It is often tedious to develop a new code for each
of them. In addition, the new code implies new errors. The derived class inherits the description of
the base class, thus any re-development and re-testing of code is unnecessary. The inheritance
relationships are hierarchical.

Hierarchy is a method that allows to copy the elements in all their diversity and complexity. It
introduces the objects classification. For example, the periodic table of elements has gases. They
possess to properties inherent to all periodic elements.

Inert gases constitute the next important subclass. The hierarchy is that the inert gas, such as
argon is a gas, and gas, in its turn, is part of the system. Such a hierarchy allows to interpret
behaviour of inert gases easily. We know that their atoms contain protons and electrons, that is true
for all other elements.

We know that they are in a gaseous state at room temperature, like all the gases. We know that no
gas from inert gas subclass enters usual chemical reaction with other elements, and its a property of
all inert gases.

Consider an example of the inheritance of geometric shapes. To describe the whole variety of
simple shapes (circle, triangle, rectangle, square etc.), the best way is to create a base class (ADT),
which is the ancestor of all the derived classes.

Let's create a base class CShape, which contains just the most common members describing the
shape. These members describe properties that are characteristic of any shape - the type of the shape
and main anchor point coordinates.

Example:

//--- The base class Shape


class CShape{}
{
protected:
int m_type; // Shape type
int m_xpos; // X - coordinate of the base point
int m_ypos; // Y - coordinate of the base point
public:
CShape(){m_type=0; m_xpos=0; m_ypos=0;} // constructor
void SetXPos(int x){m_xpos=x;} // set X
void SetYPos(int y){m_ypos=y;} // set Y
};

Next, create new classes derived from the base class, in which we will add necessary fields, each
specifying a certain class. For the Circle shape it is necessary to add a member that contains the
radius value. The Square shape is characterized by the side value. Therefore, derived classes,
inherited from the base class CShape will be declared as follows:

© 2000-2010, MetaQuotes Software Corp.


151 Language Basics

//--- The derived class circle


class CCircle{} : public CShape // After a colon we define the base class
{ // from which inheritance is made
private:
int m_radius; // circle radius

public:
CCircle(){m_type=1;}// constructor, type 1
};

For the Square shape class declaration is similar:

//--- the derived class Square


class CSquare{} : public CShape // After a colon we define the base class
{ // from which inheritance is made
private:
int m_square_side; // square side

public:
CSquare(){m_type=2;} // constructor, type 2
};

It should be noted that while object is created the base class constructor is called first, and then the
constructor of the derived class is called. When an object is destroyed first the destructor of the
derived class is called, and then a base class destructor is called.

Thus, by declaring the most general members in the base class, we can add an additional members
in derived classes, which specify a particular class. Inheritance allows creating powerful code libraries
that can be reused many times.

The syntax for creating a derived class from an already existing on is as follows:

class class_name :
(public | protected | private) opt base_class_name

{
class members declaration
};

One of aspects of the derived class is the visibility (openness) of its members, successors (heirs).
The public, protected and private keywords are used to indicate the extent, to which members of the
base class will be available for the derived one. The public keyword after a colon in the header of a
derived class indicates that the protected and public members of the base class CShape should be
inherited as protected and public members of the derived class CCircle.

The private class members of the base class are not available for the derived class. The public
inheritance also means that derived classes (CCircle and CSquare) are CShapes. That is, the Square
(CSquare) is a shape (CShape), but the shape does not necessarily have to be a square.

The derived class is a modification of the base class, it inherits the protected and public members
of the base class. The constructors and destructors of the base class cannot be inherited. In addition

© 2000-2010, MetaQuotes Software Corp.


152 Language Basics

to members of the base class, new members are added in a derivative class.

The derived class may include the implementation of member functions, different from the base
class. It has nothing common with an overload, when the meaning of the same function name may be
different for different signatures.

In protected inheritance, public and protected members of base class become protected members of
derived class. In private inheritance, the public and protected members of base class become private
members of the derived class.

In protected and private inheritance, the relation that "the object of a derivative class is object of a
base class" is not true. The protected and private inheritance types are rare, and each of them needs
to be used carefully.

MQL5 has no multiple inheritance.

© 2000-2010, MetaQuotes Software Corp.


153 Language Basics

Polymorphism
Polymorphism is an opportunity for different classes of objects, related through inheritance, to
respond in various ways when calling the same function element. It helps to create a universal
mechanism describing the behavior of not only the base class, but also descendant classes.

Let's continue to develop a base class CShape, and define a member function GetArea(), designed
to calculate the area of a shape. In all the descendant classes, produced by inheritance from the base
class, we re-define this function in accordance with rules of calculating the area of a particular shape.

For a square (class CSquare), the area is calculated through its sides, for a circle (class CCircle),
area is expressed through its radius etc. We can create an array to store objects of CShape type, in
which both objects of a base class and those of all descendant classes can be stored. Further we can
call the same function for each element of the array.

Example:

//--- Base class


class CShape{};
{
protected:
int m_type; // Shape type
int m_xpos; // X - coordinate of the base point
int m_ypos; // Y - coordinate of the base point
public:
void CShape(){m_type=0;}; // constructor, type=0
int GetType(){return(m_type);};// returns type of the shape
virtual
double GetArea(){return (0); }// returns area of the shape
};

Now, all of the derived classes have a member function getArea(), which returns a zero value. The
implementation of this function in each descendant will vary.

//--- The derived class Circle


class CCircle{} : public CShape // After a colon we define the base class
{ // from which inheritance is made
private:
int m_radius; // circle radius

public:
void CCircle(){m_type=1;}; // constructor, type=1
void SetRadius(double r){m_radius=r;};
virtual double GetArea(){return (3.14*m_radius*m_radius);}// circle area
};

For the class Square the declaration is the same:

//--- The derived class Square


class CSquare{} : public CShape // After a colon we define the base class
{ // from which inheritance is made

© 2000-2010, MetaQuotes Software Corp.


154 Language Basics

private:
int m_square_side; // square side

public:
void CSquare(){m_type=2;}; // constructor, type=1
void SetSide(double s){m_square_side=s;};
virtual double GetArea(){return (m_square_side*m_square_side);}// square area
};

For calculating the area of the square and circle, we need the corresponding values of m_radius and
m_square_side, so we have added the functions SetRadius and SetSide() in the declaration of the
corresponding class. Now we can declare an array of the Shap typee and fill it with objects of derived
classes:

CShape[10] shapes; // array of CShape objects


//... here we fill array by derived objects
for (int i=0; i<10;i++)
{
//--- type and area of the shape
Print("Object type "+shapes[i].GetType()+" has an area "+ shapes[i].GetArea());
};

But besides the redefining of functions during inheritance, polymorphism also includes the
implementation of one and the same functions with different sets of parameters within a class. This
means that the class may have several functions with the same name but with a different type and/or
set of parameters. In this case, polymorphism is implemented through the function overload.

© 2000-2010, MetaQuotes Software Corp.


155 Language Basics

Overload
Within one class it is possible to define two or more methods that use the same name, but have
different numbers of parameters. When this occurs, methods are called overloaded and such a process
is referred to as method overloading.

Method overloading is one of ways of polymorthism realization. Overloading of methods is


performed according to the same rules as the function overloading.

If the called function has no exact match, the compiler searches for a suitable function on three
levels sequentially:
1. search within class methods;
2. search within the base class methods, consistently from the nearest ancestor to the very first.
3. search among other functions.

If there is no exact correspondence at all levels, but several suitable functions at different levels
have been found, the function found at the least level is used. Within one level, there can't be more
than one suitable function.

MQL5 has no operator overloading.

© 2000-2010, MetaQuotes Software Corp.


156 Language Basics

Virtual Functions
The virtual keyword is the function specifier, which provides a mechanism to select dynamically at
runtime an appropriate function-member among the functions of basic and derived classes. Structures
cannot have virtual functions. It can be used to change the declarations for function-members only.

The virtual function, like an ordinary function, must have an executable body. When called, its
semantic is the same as that of other functions.

A virtual function may be overridden in a derived class. The choice of what function definition
should be called for a virtual function is made dynamically (at runtime). A typical case is when a base
class contains a virtual function, and derived classes have their own versions of this function.

The pointer to the base class can indicate either a base class object or the object of a derived class.
The choice of the member-function to call will be performed at runtime and will depend on the type of
the object, not the type of the pointer. If there is no member of a derived type, the virtual function of
the base class is used by default.

Destructors are always virtual, regardless of whether they are declared with the virtual keyword or
not.

Let's consider the use of virtual functions on the example of MT5_Tetris.mq5. The base class
CTetrisShape with the virtual function Draw is defined in the included file MT5_TetisShape.mqh.

//+------------------------------------------------------------------+
class CTetrisShape
{
protected:
int m_type;
int m_xpos;
int m_ypos;
int m_xsize;
int m_ysize;
int m_prev_turn;
int m_turn;
int m_right_border;
public:
void CTetrisShape();
void SetRightBorder(int border) { m_right_border=border; }
void SetYPos(int ypos) { m_ypos=ypos; }
void SetXPos(int xpos) { m_xpos=xpos; }
int GetYPos() { return(m_ypos); }
int GetXPos() { return(m_xpos); }
int GetYSize() { return(m_ysize); }
int GetXSize() { return(m_xsize); }
int GetType() { return(m_type); }
void Left() { m_xpos-=SHAPE_SIZE; }
void Right() { m_xpos+=SHAPE_SIZE; }
void Rotate() { m_prev_turn=m_turn; if(++m_turn>3) m_turn=0; }

© 2000-2010, MetaQuotes Software Corp.


157 Language Basics

virtual void Draw() { return; }


virtual bool CheckDown(int& pad_array[]);
virtual bool CheckLeft(int& side_row[]);
virtual bool CheckRight(int& side_row[]);
};

Further, for each derived class, this function is implemented in accordance with characteristics of a
descendant class. For example, the first shape CTetrisShape1 has its own implementation of the Draw
() function:

class CTetrisShape1 : public CTetrisShape


{
public:
//--- shape drawing
virtual void Draw()
{
int i;
string name;
//---
if(m_turn==0 || m_turn==2)
{
//--- horizontal
for(i=0; i<4; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos+i*SHAPE_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos);
}
}
else
{
//--- vertical
for(i=0; i<4; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos+i*SHAPE_SIZE);
}
}
}
}

The Square shape is described by class CTetrisShape6 and has its own implementation of the Draw()
method:

class CTetrisShape6 : public CTetrisShape


{
public:
//--- Shape drawing
virtual void Draw()

© 2000-2010, MetaQuotes Software Corp.


158 Language Basics

{
int i;
string name;
//---
for(i=0; i<2; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos+i*SHAPE_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos);
}
for(i=2; i<4; i++)
{
name=SHAPE_NAME+(string)i;
ObjectSetInteger(0,name,OBJPROP_XDISTANCE,m_xpos+(i-2)*SHAPE_SIZE);
ObjectSetInteger(0,name,OBJPROP_YDISTANCE,m_ypos+SHAPE_SIZE);
}
}
};

Depending on the class, to which the created object belongs, it calls the virtual function of this or
that derived class.

void CTetrisField::NewShape()
{
//--- creating one of the 7 possible shapes randomly
int nshape=rand()%7;
switch(nshape)
{
case 0: m_shape=new CTetrisShape1; break;
case 1: m_shape=new CTetrisShape2; break;
case 2: m_shape=new CTetrisShape3; break;
case 3: m_shape=new CTetrisShape4; break;
case 4: m_shape=new CTetrisShape5; break;
case 5: m_shape=new CTetrisShape6; break;
case 6: m_shape=new CTetrisShape7; break;
}
//--- draw
m_shape.Draw();
//---
}

© 2000-2010, MetaQuotes Software Corp.


159 Standard Constants, Enumerations and Structures

Standard Constants, Enumerations and Structures


To simplify the program writing and to make program texts more convenient for perception, the
MQL5 language provides predefined standard constants and enumerations. Besides that, service
structures are used for storing information.

Standard constants are similar to macros and are of int type.

The constants are grouped by their purposes:

Chart constants are used when working with price charts: opening, navigation, setting parameters;
Objects constants are intended for processing graphical objects that can be created and displayed in
charts;
Indicators constants are used for working with standard and custom indicators;
Environment state describe properties of a mql5-program, show information about a client terminal,
security and current account;
Trade constants allow to specify a variety of information in the course of trading;
Named constants are constants of the MQL5 language;
Data structures describe data storage formats used;
Codes of errors and warnings describe compiler messages and trading server answers to trade
requests;
In/out constants are designed for working with file functions and displaying messages on the screen
by the MessageBox() function.

© 2000-2010, MetaQuotes Software Corp.


160 Standard Constants, Enumerations and Structures

Chart Constants
Constants describing various properties of charts are divided into the following groups:

Types of events – events that occur when working with charts;


Chart timeframes – standard built-in periods;
Properties of chart – identifiers that are used as parameters of chart functions;
Positioning constants - value of a parameter of the ChartNavigate() function;
Displaying charts - setting the chart appearance.

© 2000-2010, MetaQuotes Software Corp.


161 Standard Constants, Enumerations and Structures

Types of Chart Events


There are 7 types of events that can be processed using the predefined function OnChartEvent().
For custom events 65536 identifiers are provided in the range of CHARTEVENT_CUSTOM to
CHARTEVENT_CUSTOM_LAST inclusive. To generate a custom event, the EventChartCustom() function
should be used.

ENUM_CHART_EVENT

ID Description

CHARTEVENT_KEYDOWN Keystrokes

CHARTEVENT_OBJECT_CREATE Graphical object created

CHARTEVENT_OBJECT_DELETE Graphical object deleted

CHARTEVENT_CLICK Clicking on a chart

CHARTEVENT_OBJECT_CLICK Clicking on a graphical object

CHARTEVENT_OBJECT_DRAG Drag and drop of a graphical object

CHARTEVENT_OBJECT_ENDEDIT End of text editing in the graphical object Edit

CHARTEVENT_CUSTOM Initial number of an event from a range of


custom events

CHARTEVENT_CUSTOM_LAST The final number of an event from a range of


custom events

Example:

© 2000-2010, MetaQuotes Software Corp.


162 Standard Constants, Enumerations and Structures

#define KEY_NUMPAD_5 12
#define KEY_LEFT 37
#define KEY_UP 38
#define KEY_RIGHT 39
#define KEY_DOWN 40
#define KEY_NUMLOCK_DOWN 98
#define KEY_NUMLOCK_LEFT 100
#define KEY_NUMLOCK_5 101
#define KEY_NUMLOCK_RIGHT 102
#define KEY_NUMLOCK_UP 104
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
Print("The expert with name",MQL5InfoString(MQL5_PROGRAM_NAME),"is running");
//---
return(0);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void OnChartEvent(const int id, // Event identifier
const long& lparam, // Event parameter of long type
const double& dparam, // Event parameter of double type
const string& sparam // Event parameter of string type
)
{
//--- the left mouse button has been pressed on the chart
if(id==CHARTEVENT_CLICK)
{
Print("The coordinates of the mouse click on the chart are: x=",lparam," y=",dparam);
}
//--- the mouse has been clicked on the graphic object
if(id==CHARTEVENT_OBJECT_CLICK)
{
Print("The mouse has been clicked on the object with name '"+sparam+"'");
}
//--- the key has been pressed
if(id==CHARTEVENT_KEYDOWN)
{
switch(lparam)
{
case KEY_NUMLOCK_LEFT: Print("The KEY_NUMLOCK_LEFT has been pressed"); break;
case KEY_LEFT: Print("The KEY_LEFT has been pressed"); break;
case KEY_NUMLOCK_UP: Print("The KEY_NUMLOCK_UP has been pressed"); break;
case KEY_UP: Print("The KEY_UP has been pressed"); break;
case KEY_NUMLOCK_RIGHT: Print("The KEY_NUMLOCK_RIGHT has been pressed"); break;
case KEY_RIGHT: Print("The KEY_RIGHT has been pressed"); break;
case KEY_NUMLOCK_DOWN: Print("The KEY_NUMLOCK_DOWN has been pressed"); break;
case KEY_DOWN: Print("The KEY_DOWN has been pressed"); break;
case KEY_NUMPAD_5: Print("The KEY_NUMPAD_5 has been pressed"); break;
case KEY_NUMLOCK_5: Print("The KEY_NUMLOCK_5 has been pressed"); break;
default: Print("Some not listed key has been pressed");
}
ChartRedraw();
}
//--- the object has been deleted
if(id==CHARTEVENT_OBJECT_DELETE)
{

© 2000-2010, MetaQuotes Software Corp.


163 Standard Constants, Enumerations and Structures

Print("The object with name",sparam,"has been deleted");


}
//--- the object has been created
if(id==CHARTEVENT_OBJECT_CREATE)
{
Print("The object with name",sparam,"has been created");
}
//--- the object has been moved or its anchor point coordinates has been changed
if(id==CHARTEVENT_OBJECT_DRAG)
{
Print("The anchor point coordinates of the object with name",sparam,"has been changed");
}
//--- the text in the Edit of object has been changed
if(id==CHARTEVENT_OBJECT_ENDEDIT)
{
Print("The text in the Edit field of the object with name",sparam,"has been changed");
}
}

See also
Event Handling Functions, Working with events

© 2000-2010, MetaQuotes Software Corp.


164 Standard Constants, Enumerations and Structures

Chart Timeframes
All predefined timeframes of charts have unique identifiers. The PERIOD_CURRENT identifier means
the current period of a chart, at which a mql5-program is running.

ENUM_TIMEFRAMES

ID Description

PERIOD_CURRENT Current timeframe

PERIOD_M1 1 minute

PERIOD_M2 2 minutes

PERIOD_M3 3 minutes

PERIOD_M4 4 minutes

PERIOD_M5 5 minutes

PERIOD_M6 6 minutes

PERIOD_M10 10 minutes

PERIOD_M12 12 minutes

PERIOD_M15 15 minutes

PERIOD_M20 20 minutes

PERIOD_M30 30 minutes

PERIOD_H1 1 hour

PERIOD_H2 2 hours

PERIOD_H3 3 hours

PERIOD_H4 4 hours

PERIOD_H6 6 hours

PERIOD_H8 8 hours

PERIOD_H12 12 hours

PERIOD_D1 1 hours

PERIOD_W1 1 week

PERIOD_MN1 1 month

Example:

string chart_name="test_Object_Chart";
Print("Let's try to create a Chart object with the name ",chart_name);
//--- If such an object does not exist - create it
if(ObjectFind(0,chart_name)<0)ObjectCreate(0,chart_name,OBJ_CHART,0,0,0,0,0);

© 2000-2010, MetaQuotes Software Corp.


165 Standard Constants, Enumerations and Structures

//--- Define symbol


ObjectSetString(0,chart_name,OBJPROP_SYMBOL,"EURUSD");
//--- Set X coordinate of the anchor point
ObjectSetInteger(0,chart_name,OBJPROP_XDISTANCE,100);
//--- Set Y coordinate of the anchor point
ObjectSetInteger(0,chart_name,OBJPROP_YDISTANCE,100);
//--- Set the width of chart
ObjectSetInteger(0,chart_name,OBJPROP_XSIZE,400);
//--- Set the height
ObjectSetInteger(0,chart_name,OBJPROP_YSIZE,300);
//--- Set the timeframe
ObjectSetInteger(0,chart_name,OBJPROP_PERIOD,PERIOD_D1);
//--- Set scale (from 0 to 5)
ObjectSetInteger(0,chart_name,OBJPROP_SCALE,4);
//--- Disable selection by a mouse
ObjectSetInteger(0,chart_name,OBJPROP_SELECTABLE,false);

See also

PeriodSeconds, Period, Date and Time, Visibility of objects

© 2000-2010, MetaQuotes Software Corp.


166 Standard Constants, Enumerations and Structures

Chart Properties
Identifiers of ENUM_CHART_PROPERTY enumerations are used as parameters of functions for
working with charts. The abbreviation of r/o in the "Type property" column means that this property is
read-only and can not be changed. When accessing certain properties, it's necessary to specify an
additional parameter-modifier (modifier), which serves to indicate the number of chart subwindows. 0
means the main window.

For functions ChartSetInteger() and ChartGetInteger()

ENUM_CHART_PROPERTY_INTEGER

ID Description Property Type

CHART_MODE Chart type (candlesticks, bars enum ENUM_CHART_MODE


or line)

CHART_FOREGROUND Price chart in the background bool

CHART_SHIFT Mode of price chart indent bool


from the right border

CHART_AUTOSCROLL Mode of automatic moving to bool


the right border of the chart

CHART_SCALE Scale int from 0 to 5

CHART_SCALEFIX Fixed scale mode bool

CHART_SCALEFIX_11 Scale 1:1 mode bool

CHART_SCALE_PT_PER_BAR Scale to be specified in points bool


per bar

CHART_SHOW_OHLC Show OHLC values in the upper bool


left corner

CHART_SHOW_BID_LINE Display Bid values as a bool


horizontal line in a chart

CHART_SHOW_ASK_LINE Display Ask values as a bool


horizontal line in a chart

CHART_SHOW_LAST_LINE Display Last values as a bool


horizontal line in a chart

CHART_SHOW_PERIOD_SEP Display vertical separators bool


between adjacent periods

CHART_SHOW_GRID Display grid in the chart bool

CHART_SHOW_VOLUMES Display volume in the chart enum


ENUM_CHART_VOLUME_MODE

CHART_SHOW_OBJECT_DESCR Pop-up descriptions of bool


graphical objects

CHART_VISIBLE_BARS The number of bars on the int r/o

© 2000-2010, MetaQuotes Software Corp.


167 Standard Constants, Enumerations and Structures

chart that can be displayed

CHART_WINDOWS_TOTAL The total number of chart int r/o


windows, including indicator
subwindows

CHART_WINDOW_IS_VISIBLE Visibility of subwindows bool r/o modifier - subwindow


number

CHART_WINDOW_HANDLE Chart window handle (HWND) int r/o

CHART_FIRST_VISIBLE_BAR Number of the first visible bar int r/o


in the chart. Indexing of bars
is the same as for timeseries.

CHART_WIDTH_IN_BARS Chart width in bars int r/o

CHART_WIDTH_IN_PIXELS Chart width in pixels int r/o

CHART_HEIGHT_IN_PIXELS Chart height in pixels int r/o modifier -


subwindow number

CHART_COLOR_BACKGROUND Chart background color color

CHART_COLOR_FOREGROUND Color of axes, scales and OHLC color


line

CHART_COLOR_GRID Grid color color

CHART_COLOR_VOLUME Color of volumes and position color


opening levels

CHART_COLOR_CHART_UP Color for the up bar, shadows color


and body borders of bull
candlesticks

CHART_COLOR_CHART_DOWN Color for the down bar, color


shadows and body borders of
bear candlesticks

CHART_COLOR_CHART_LINE Line chart color and color of color


Japanese candlesticks Dodge

CHART_COLOR_CANDLE_BULL Body color of a bull candlestick color

CHART_COLOR_CANDLE_BEAR Bode color of a bear color


candlestick

CHART_COLOR_BID Bid price level color color

CHART_COLOR_ASK Ask price level color color

CHART_COLOR_LAST Line color of the last executed color


deal price (Last)

CHART_COLOR_STOP_LEVEL Color of stop order levels (Stop color


Loss and Take Profit)

For functions ChartSetDouble() and ChartGetDouble()

© 2000-2010, MetaQuotes Software Corp.


168 Standard Constants, Enumerations and Structures

ENUM_CHART_PROPERTY_DOUBLE

ID Description Property Type

CHART_SHIFT_SIZE The size of the zero bar indent double (from 10 to 50


from the right border in percents)
percents

CHART_FIXED_MAX Fixed chart maximum double

CHART_FIXED_MIN Fixed chart minimum double

CHART_POINTS_PER_BAR Scale in points per bar double

CHART_PRICE_MIN Chart maximum double r/o modifier -


subwindow number

CHART_PRICE_MAX Chart minimum double r/o modifier -


subwindow number

For functions ChartSetString() and ChartGetString()

ENUM_CHART_PROPERTY_STRING

ID Description Property Type

CHART_COMMENT Text of a comment in a chart string

Example:

int chartMode=ChartGetInteger(0,CHART_MODE);
switch(chartMode)
{
case(CHART_BARS): Print("CHART_BARS"); break;
case(CHART_CANDLES): Print("CHART_CANDLES");break;
default:Print("CHART_LINE");
}
bool shifted=ChartGetInteger(0,CHART_SHIFT);
if(shifted) Print("CHART_SHIFT = true");
else Print("CHART_SHIFT = false");
bool autoscroll=ChartGetInteger(0,CHART_AUTOSCROLL);
if(autoscroll) Print("CHART_AUTOSCROLL = true");
else Print("CHART_AUTOSCROLL = false");
int chartHandle=ChartGetInteger(0,CHART_WINDOW_HANDLE);
Print("CHART_WINDOW_HANDLE =",chartHandle);
int windows=ChartGetInteger(0,CHART_WINDOWS_TOTAL);
Print("CHART_WINDOWS_TOTAL =",windows);
if(windows>1)
{
for(int i=0;i<windows;i++)
{
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,i);
double priceMin=ChartGetDouble(0,CHART_PRICE_MIN,i);

© 2000-2010, MetaQuotes Software Corp.


169 Standard Constants, Enumerations and Structures

double priceMax=ChartGetDouble(0,CHART_PRICE_MAX,i);
Print(i+": CHART_HEIGHT_IN_PIXELS =",height,"pixels");
Print(i+": CHART_PRICE_MIN =",priceMin);
Print(i+": CHART_PRICE_MAX =",priceMax);
}
}

© 2000-2010, MetaQuotes Software Corp.


170 Standard Constants, Enumerations and Structures

Positioning Constants
Three identifiers from the ENUM_CHART_POSITION list are the possible values of the position
parameter for the ChartNavigate() function.

ENUM_CHART_POSITION

ID Description

CHART_BEGIN Chart beginning (the oldest prices)

CHART_CURRENT_POS Current position

CHART_END Chart end (the latest prices)

Example:

long handle=ChartOpen("EURUSD",PERIOD_H12);
if(handle!=0)
{
ChartSetInteger(handle,CHART_AUTOSCROLL,false);
ChartSetInteger(handle,CHART_SHIFT,true);
ChartSetInteger(handle,CHART_MODE,CHART_LINE);
ResetLastError();
bool res=ChartNavigate(handle,CHART_END,150);
if(!res) Print("Navigate failed. Error= ",GetLastError());
ChartRedraw();
}

© 2000-2010, MetaQuotes Software Corp.


171 Standard Constants, Enumerations and Structures

Chart Representation
Price charts can be displayed in three ways:

as bars;
as candlesticks;
as a line.

The specific way of displaying the price chart is set by the function ChartSetInteger(chart_handle,
CHART_MODE, chart_mode), where chart_mode is one of the values of the ENUM_CHART_MODE
enumeration.

ENUM_CHART_MODE

ID Description

CHART_BARS Display as a sequence of bars

CHART_CANDLES Display as Japanese candlesticks

CHART_LINE Display as a a line drawn by Close prices

To specify the mode of displaying volumes in the price chart the function ChartSetInteger
(chart_handle, CHART_SHOW_VOLUMES, volume_mode) is used, where volume_mode is one of values
of the ENUM_CHART_VOLUME_MODE enumeration.

ENUM_CHART_VOLUME_MODE

ID Description

CHART_VOLUME_HIDE Volumes are not shown

CHART_VOLUME_TICK Tick volumes

CHART_VOLUME_REAL Trade volumes

Example:

//--- Get the handle of the current chart


long handle=ChartID();
if(handle>0) // If it succeeded, additionally customize
{
//--- Disable autoscroll
ChartSetInteger(handle,CHART_AUTOSCROLL,false);
//--- Set the indent of the right border of the chart
ChartSetInteger(handle,CHART_SHIFT,true);
//--- Display as candlesticks
ChartSetInteger(handle,CHART_MODE,CHART_CANDLES);
//--- Scroll by 100 bars from the beginning of history
ChartNavigate(handle,CHART_CURRENT_POS,100);
//--- Set the tick volume display mode
ChartSetInteger(handle,CHART_SHOW_VOLUMES,CHART_VOLUME_TICK);

© 2000-2010, MetaQuotes Software Corp.


172 Standard Constants, Enumerations and Structures

See also

ChartOpen, ChartID

© 2000-2010, MetaQuotes Software Corp.


173 Standard Constants, Enumerations and Structures

Object Constants
There are 39 graphical objects that can be created and displayed in the price chart. All constants for
working with objects are divided into 9 groups:

Object types – Identifiers of graphical objects;


Object properties – setting and getting properties of graphical objects;
Methods of object binding – constants of object positioning in the chart;
Binding corner – an indication of the angle of the schedule, which is positioned on the object;
Visibility of objects – setting timeframes in which an object is visible;
Levels of Elliott Waves – wave gradation markings;
Gann objects – trend constants for Gann fan and Gann grid;
Web colors – constants of predefined web colors;
Wingdings – codes of characters of the Wingdings font.

© 2000-2010, MetaQuotes Software Corp.


174 Standard Constants, Enumerations and Structures

Object Types
When a graphical object is created using the ObjectCreate() function, it's necessary to specify the
type of object being created, which can be one of the values of the ENUM_OBJECT enumeration.
Further specifications of object properties are possible using functions for working with graphical
objects.

ENUM_OBJECT

ID Description

OBJ_VLINE Vertical Line

OBJ_HLINE Horizontal Line

OBJ_TREND Trend Line

OBJ_TRENDBYANGLE Trend Line By Angle

OBJ_CHANNEL Equidistant Channel

OBJ_STDDEVCHANNEL Standard Deviation Channel

OBJ_REGRESSION Linear Regression Channel

OBJ_PITCHFORK Andrews’ Pitchfork

OBJ_GANNLINE Gann Line

OBJ_GANNFAN Gann Fan

OBJ_GANNGRID Gann Grid

OBJ_FIBO Fibonacci Retracement

OBJ_FIBOTIMES Fibonacci Time Zones

OBJ_FIBOFAN Fibonacci Fan

OBJ_FIBOARC Fibonacci Arcs

OBJ_FIBOCHANNEL Fibonacci Channel

OBJ_EXPANSION Fibonacci Expansion

OBJ_ELLIOTWAVE5 Elliott Motive Wave

OBJ_ELLIOTWAVE3 Elliott Correction Wave

OBJ_RECTANGLE Rectangle

OBJ_TRIANGLE Triangle

OBJ_ELLIPSE Ellipse

OBJ_CYCLES Cycle Lines

OBJ_ARROW_THUMB_UP Thumbs Up

OBJ_ARROW_THUMB_DOWN Thumbs Down

OBJ_ARROW_UP Arrow Up

© 2000-2010, MetaQuotes Software Corp.


175 Standard Constants, Enumerations and Structures

OBJ_ARROW_DOWN Arrow Down

OBJ_ARROW_STOP Stop Sign

OBJ_ARROW_CHECK Check Sign

OBJ_ARROW_LEFT_PRICE Left Price Label

OBJ_ARROW_RIGHT_PRICE Right Price Label

OBJ_ARROW Arrow

OBJ_TEXT Text

OBJ_LABEL Label

OBJ_BUTTON Button

OBJ_CHART Chart

OBJ_BITMAP Bitmap

OBJ_BITMAP_LABEL Bitmap Label

OBJ_EDIT Edit

© 2000-2010, MetaQuotes Software Corp.


176 Standard Constants, Enumerations and Structures

Object Properties
Every graphical object in a price chart has a certain set of properties. Values of object properties
are wet up and received by corresponding functions for working with graphical objects. For each
object type there is its own set of properties. Here al possible values from the
ENUM_OBJECT_PROPERTY enumeration family are listed. Some properties require clarification, such
as the level number for the Fibonacci extension object. In such cases it is necessary to specify the
value of the modifier parameter in the functions of ObjectSet...() and ObjectGet...().

For functions ObjectSetInteger() and ObjectGetInteger()

ENUM_OBJECT_PROPERTY_INTEGER

Identifier Description Property Type

OBJPROP_COLOR Color color

OBJPROP_STYLE Style ENUM_LINE_STYLE

OBJPROP_WIDTH Line thickness int

OBJPROP_BACK Object in the background bool

OBJPROP_SELECTED Object is selected bool

OBJPROP_READONLY Ability to edit text in the Edit bool


object

OBJPROP_TYPE Object type ENUM_OBJECT

OBJPROP_TIME Time coordinate datetime modifier=number of


anchor point

OBJPROP_SELECTABLE Object availability bool

OBJPROP_CREATETIME Time of object creation datetime r/o

OBJPROP_LEVELS Number of levels int

OBJPROP_LEVELCOLOR Color of the line-level color modifier=level number

OBJPROP_LEVELSTYLE Style of the line-level ENUM_LINE_STYLE


modifier=level number

OBJPROP_LEVELWIDTH Thickness of the line-level int modifier=level number

OBJPROP_FONTSIZE Font size int

OBJPROP_RAY_LEFT Ray goes to the left bool

OBJPROP_RAY_RIGHT Ray goes to the right bool

OBJPROP_ELLIPSE Ellipse bool

OBJPROP_ARROWCODE Arrow code for the Arrow char


object

OBJPROP_TIMEFRAMES Visibility of an object at set of flags flags


timeframes

© 2000-2010, MetaQuotes Software Corp.


177 Standard Constants, Enumerations and Structures

OBJPROP_ANCHOR Location of the anchor point of ENUM_ARROW_ANCHOR (for


a graphical object OBJ_ARROW),
ENUM_ANCHORPOINT (for
OBJ_LABEL and OBJ_TEXT)

OBJPROP_XDISTANCE The distance in pixels along int


the X axis from the binding
corner

OBJPROP_YDISTANCE The distance in pixels along int


the Y axis from the binding
corner

OBJPROP_DIRECTION Trend of the Gann object ENUM_GANN_DIRECTION

OBJPROP_DEGREE Level of the Elliott Wave ENUM_ELLIOT_WAVE_DEGREE


Marking

OBJPROP_DRAWLINES Displaying lines for marking bool


the Elliott Wave

OBJPROP_STATE Button state (pressed / bool


depressed)

OBJPROP_XSIZE The size of the object Chart int


along the X axis (width in
pixels)

OBJPROP_YSIZE The size of the object Chart int


along the Y axis (height in
pixels)

OBJPROP_PERIOD Timeframe for the object ENUM_TIMEFRAMES


Chart

OBJPROP_DATE_SCALE Displaying the time scale for bool


the object Chart

OBJPROP_PRICE_SCALE Displaying the price scale for bool


the object "graph"

OBJPROP_CHART_SCALE The scale for the object Chart int value in the range 0–5

OBJPROP_BGCOLOR The background color for the color


object Edit

OBJPROP_CORNER The corner of the chart to link ENUM_BASECORNER


a graphical object

For functions ObjectSetDouble() and ObjectGetDouble()

ENUM_OBJECT_PROPERTY_DOUBLE

Identifier Description Property Type

OBJPROP_PRICE Price coordinate double modifier=number of


anchor point

© 2000-2010, MetaQuotes Software Corp.


178 Standard Constants, Enumerations and Structures

OBJPROP_LEVELVALUE Level value double modifier=level number

OBJPROP_SCALE Scale (properties of Gann double


objects and Fibonacci Arcs)

OBJPROP_ANGLE Angle double

OBJPROP_DEVIATION Deviation for the Standard double


Deviation Channel

For functions ObjectSetString() and ObjectGetString()

ENUM_OBJECT_PROPERTY_STRING

Identifier Description Property Type

OBJPROP_NAME Object name string

OBJPROP_TEXT Description of the object (the string


text contained in the object)

OBJPROP_LEVELTEXT Level description string modifier=level number

OBJPROP_FONT Font string

OBJPROP_BMPFILE The name of BMP-file for string modifier: 0-state ON,


Bitmap Label 1-state OFF

OBJPROP_SYMBOL Symbol for the Chart object string

Example:

#define UP "\x0431"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
string label_name="my_OBJ_LABEL_object";
if(ObjectFind(0,label_name)<0)
{
Print("Object ",label_name," not found. Error code =",GetLastError());
//--- create Label object
ObjectCreate(0,label_name,OBJ_LABEL,0,0,0);
//--- set X coordinate
ObjectSetInteger(0,label_name,OBJPROP_XDISTANCE,200);
//--- set Y coordinate
ObjectSetInteger(0,label_name,OBJPROP_YDISTANCE,300);
//--- define text color
ObjectSetInteger(0,label_name,OBJPROP_COLOR,White);
//--- define text for object Label
ObjectSetString(0,label_name,OBJPROP_TEXT,UP);
//--- define font

© 2000-2010, MetaQuotes Software Corp.


179 Standard Constants, Enumerations and Structures

ObjectSetString(0,label_name,OBJPROP_FONT,"Wingdings");
//--- define font size
ObjectSetInteger(0,label_name,OBJPROP_FONTSIZE,10);
//--- 45 degrees rotation clockwise
ObjectSetDouble(0,label_name,OBJPROP_ANGLE,-45);
//--- disable for mouse selecting
ObjectSetInteger(0,label_name,OBJPROP_SELECTABLE,false);
//--- draw it on the chart
ChartRedraw(0);
}
}

© 2000-2010, MetaQuotes Software Corp.


180 Standard Constants, Enumerations and Structures

Methods of Object Binding


Graphical objects Text and Label (OBJ_TEXT and OBJ_LABEL) can have one of 9 different ways of
coordinate binding. The necessary variant can be specified using the function ObjectSetInteger
(chart_handle, object_name, OBJPROP_ANCHOR, anchor_point_mode), where anchor_point_mode is
one of the values of ENUM_ANCHORPOINT.

ENUM_ANCHOR_POINT

ID Description

ANCHOR_LEFT_UPPER Anchor point at the upper left corner

ANCHOR_LEFT Anchor point to the left in the center

ANCHOR_LEFT_LOWER Anchor point at the lower left corner

ANCHOR_LOWER Anchor point below in the center

ANCHOR_RIGHT_LOWER Anchor point at the lower right corner

ANCHOR_RIGHT Anchor point to the right in the center

ANCHOR_RIGHT_UPPER Anchor point at the upper right corner

ANCHOR_UPPER Anchor point above in the center

ANCHOR_CENTER Anchor point strictly in the center of the object

Example:

string text_name="my_OBJ_TEXT_object";
if(ObjectFind(0,text_name)<0)
{
Print("Object",text_name,"not found. Error code =",GetLastError());
//--- Get the maximal price of the chart
double chart_max_price=ChartGetDouble(0,CHART_PRICE_MAX,0);
//--- Create object Label
ObjectCreate(0,text_name,OBJ_TEXT,0,TimeCurrent(),chart_max_price);
//--- Set color of the text
ObjectSetInteger(0,text_name,OBJPROP_COLOR,White);
//--- Set background color
ObjectSetInteger(0,text_name,OBJPROP_BGCOLOR,Green);
//--- Set text for the Label object
ObjectSetString(0,text_name,OBJPROP_TEXT,TimeToString(TimeCurrent()));
//--- Set text font
ObjectSetString(0,text_name,OBJPROP_FONT,"Trebuchet MS");
//--- Set font size
ObjectSetInteger(0,text_name,OBJPROP_FONTSIZE,10);
//--- Bind to the upper right corner
ObjectSetInteger(0,text_name,OBJPROP_ANCHOR,ANCHOR_RIGHT_UPPER);
//--- Rotate 90 degrees counter-clockwise
ObjectSetDouble(0,text_name,OBJPROP_ANGLE,90);
//--- Forbid the selection of the object by mouse

© 2000-2010, MetaQuotes Software Corp.


181 Standard Constants, Enumerations and Structures

ObjectSetInteger(0,text_name,OBJPROP_SELECTABLE,false);
//--- redraw object
ChartRedraw(0);
}

Graphical objects Arrow (OBJ_ARROW) have only 2 ways of linking their coordinates. Identifiers are
listed in ENUM_ARROW_ANCHOR.

ENUM_ARROW_ANCHOR

ID Description

ANCHOR_TOP Anchor on the top side

ANCHOR_BOTTOM Anchor on the bottom side

Example:

void OnStart()
{
//--- Auxiliary arrays
double Ups[],Downs[];
datetime Time[];
//--- Set the arrays as timeseries
ArraySetAsSeries(Ups,true);
ArraySetAsSeries(Downs,true);
ArraySetAsSeries(Time,true);
//--- Create handle of the Indicator Fractals
int FractalsHandle=iFractals(NULL,0);
Print("FractalsHandle =",FractalsHandle);
//--- Set Last error value to Zero
ResetLastError();
//--- Try to copy the values of the indicator
int copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Print("Unable to copy the upper fractals. Error =",GetLastError());
return;
}

ResetLastError();
//--- Try to copy the values of the indicator
copied=CopyBuffer(FractalsHandle,1,0,1000,Downs);
if(copied<=0)
{
Print("Unable to copy the bottom fractals. Error =",GetLastError());
return;
}

ResetLastError();
//--- Copy timeseries containing the opening bars of the last 1000 ones

© 2000-2010, MetaQuotes Software Corp.


182 Standard Constants, Enumerations and Structures

copied=CopyTime(NULL,0,0,1000,Time);
if(copied<=0)
{
Print("Unable to copy the Opening Time of the last 1000 bars");
return;
}

int upcounter=0,downcounter=0; // count there the number of arrows


bool created;// receive the result of attempts to create an object
for(int i=2;i<copied;i++)// Run through the values of the indicator iFractals
{
if(Ups[i]!=EMPTY_VALUE)// Found the upper fractal
{
if(upcounter<10)// Create no more than 10 "Up" arrows
{
//--- Try to create an "Up" object
created=ObjectCreate(0,string(Time[i]),OBJ_ARROW_THUMB_UP,0,Time[i],Ups[i]);
if(created)// If set up - let's make tuning for it
{
//--- Point anchor is below in order not to cover bar
ObjectSetInteger(0,string(Time[i]),OBJPROP_ANCHOR,ANCHOR_BOTTOM);
//--- Final touch - painted
ObjectSetInteger(0,string(Time[i]),OBJPROP_COLOR,Blue);
upcounter++;
}
}
}
if(Downs[i]!=EMPTY_VALUE)// Found a lower fractal
{
if(downcounter<10)// Create no more than 10 arrows "Down"
{
//--- Try to create an object "Down"
created=ObjectCreate(0,string(Time[i]),OBJ_ARROW_THUMB_DOWN,0,Time[i],Downs[i]);
if(created)// If set up - let's make tuning for it
{
//--- Point anchor is above in order not to cover bar
ObjectSetInteger(0,string(Time[i]),OBJPROP_ANCHOR,ANCHOR_TOP);
//--- Final touch - painted
ObjectSetInteger(0,string(Time[i]),OBJPROP_COLOR,Red);
downcounter++;
}
}
}
}
}

After the script execution the chart will look like in this figure.

© 2000-2010, MetaQuotes Software Corp.


183 Standard Constants, Enumerations and Structures

© 2000-2010, MetaQuotes Software Corp.


184 Standard Constants, Enumerations and Structures

The Chart Corner to Which an Object Is Attached


There is a number graphical objects, for which you can set the corner of a chart, relative to which
coordinates are specified in pixels. These are the following types of objects (in brackets object type
identifiers are specified):

Label (OBJ_LABEL);
Button (OBJ_BUTTON);
Chart (OBJ_CHART);
Bitmap Label (OBJ_BITMAP_LABEL);
Edit (OBJ_EDIT).

In order to specify the chart corner, from which X and Y coordinates will be measured in pixels, use
ObjectSetInteger(chartID, name, OBJPROP_CORNER, chart_corner), where:

chartID - chart identifier;


name – name of a graphical object;
OBJPROP_CORNER – property ID to specify the corner for binding;
chart_corner – the desired chart corner, can be one of the values of the ENUM_BASECORNER
enumeration.

ENUM_BASE_CORNER

ID Description

CORNER_LEFT_UPPER Center of coordinates is in the upper left corner


of the chart

CORNER_LEFT_LOWER Center of coordinates is in the lower left corner


of the chart

CORNER_RIGHT_LOWER Center of coordinates is in the lower right


corner of the chart

CORNER_RIGHT_UPPER Center of coordinates is in the upper right


corner of the chart

Example:

void CreateLabel(long chart_id,


string name,
int chart_corner,
string text_label,
int x_ord,
int y_ord)
{
//---
ObjectCreate(chart_id,name,OBJ_LABEL,0,0,0);
ResetLastError();
if(!ObjectSetInteger(chart_id,name,OBJPROP_CORNER,chart_corner))
Print("Unable to set the angle to bind the object",

© 2000-2010, MetaQuotes Software Corp.


185 Standard Constants, Enumerations and Structures

name,", error code ",GetLastError());


ObjectSetInteger(chart_id,name,OBJPROP_XDISTANCE,x_ord);
ObjectSetInteger(chart_id,name,OBJPROP_YDISTANCE,y_ord);
ObjectSetString(chart_id,name,OBJPROP_TEXT,text_label);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
string arrows[4]={"LEFT_UPPER","RIGHT_UPPER","RIGHT_LOWER","LEFT_LOWER"};
CreateLabel(0,arrows[0],CORNER_LEFT_UPPER,"0",50,50);
CreateLabel(0,arrows[1],CORNER_RIGHT_UPPER,"1",50,50);
CreateLabel(0,arrows[2],CORNER_RIGHT_LOWER,"2",50,50);
CreateLabel(0,arrows[3],CORNER_LEFT_LOWER,"3",50,50);
}

© 2000-2010, MetaQuotes Software Corp.


186 Standard Constants, Enumerations and Structures

Visibility of Objects
The combination of object visibility flags determines chart timeframes, where the object is visible.
To set/get the value of the OBJPROP_TIMEFRAMES property, you can use functions ObjectSetInteger()
/ObjectGetInteger().

ID Value Description

OBJ_PERIOD_M1 0x00000001 The object is drawn in 1-


minute chart

OBJ_PERIOD_M2 0x00000002 The object is drawn in 2-


minute chart

OBJ_PERIOD_M3 0x00000004 The object is drawn in 3-


minute chart

OBJ_PERIOD_M4 0x00000008 The object is drawn in 4-


minute chart

OBJ_PERIOD_M5 0x00000010 The object is drawn in 5-


minute chart

OBJ_PERIOD_M6 0x00000020 The object is drawn in 6-


minute chart

OBJ_PERIOD_M10 0x00000040 The object is drawn in 10-


minute chart

OBJ_PERIOD_M12 0x00000080 The object is drawn in 12-


minute chart

OBJ_PERIOD_M15 0x00000100 The object is drawn in 15-


minute chart

OBJ_PERIOD_M20 0x00000200 The object is drawn in 20-


minute chart

OBJ_PERIOD_M30 0x00000400 The object is drawn in 30-


minute chart

OBJ_PERIOD_H1 0x00000800 The object is drawn in 1-hour


chart

OBJ_PERIOD_H2 0x00001000 The object is drawn in 2-hour


chart

OBJ_PERIOD_H3 0x00002000 The object is drawn in 3-hour


chart

OBJ_PERIOD_H4 0x00004000 The object is drawn in 4-hour


chart

OBJ_PERIOD_H6 0x00008000 The object is drawn in 6-hour


chart

OBJ_PERIOD_H8 0x00010000 The object is drawn in 8-hour


chart

© 2000-2010, MetaQuotes Software Corp.


187 Standard Constants, Enumerations and Structures

OBJ_PERIOD_H12 0x00020000 The object is drawn in 12-hour


chart

OBJ_PERIOD_D1 0x00040000 The object is drawn in day


charts

OBJ_PERIOD_W1 0x00080000 The object is drawn in week


charts

OBJ_PERIOD_MN1 0x00100000 The object is drawn in month


charts

OBJ_ALL_PERIODS 0 The object is drawn in all


timeframes

Visibility flags can be combined using the symbol "|", for example, the combination of flags
OBJ_PERIOD_M10|OBJ_PERIOD_H4 means that the object will be visible on the 10-minute and 4-hour
timeframes.

Example:

void OnStart()
{
//---
string highlevel="PreviousDayHigh";
string lowlevel="PreviousDayLow";
double prevHigh; // The previous day High
double prevLow; // The previous day Low
double highs[],lows[]; // Arrays for High and Low

//--- Reset the last error


ResetLastError();
//--- Get the last 2 High values on the daily timeframe
int highsgot=CopyHigh(Symbol(),PERIOD_D1,0,2,highs);
if(highsgot>0) // If copying was successful
{
Print("High prices for the last 2 days were obtained successfully");
prevHigh=highs[0]; // The previous day High
Print("prevHigh =",prevHigh);
if(ObjectFind(0,highlevel)<0) // Object with the name highlevel not found
{
ObjectCreate(0,highlevel,OBJ_HLINE,0,0,0); // Create the Horizontal Line object
}
//--- Set value for the price level for the line highlevel
ObjectSetDouble(0,highlevel,OBJPROP_PRICE,0,prevHigh);
//--- Set the visibility only PERIOD_M10 and PERIOD_H4
ObjectSetInteger(0,highlevel,OBJPROP_TIMEFRAMES,OBJ_PERIOD_M10|OBJ_PERIOD_H4);
}
else
{
Print("Could not get High prices over the past 2 days, Error =",GetLastError());
}

© 2000-2010, MetaQuotes Software Corp.


188 Standard Constants, Enumerations and Structures

//--- Reset the last error


ResetLastError();
//--- Get the 2 days values Low on the daily timeframe
int lowsgot=CopyLow(Symbol(),PERIOD_D1,0,2,lows);
if(lowsgot>0) // If copying was successful
{
Print("Low prices for the last 2 days were obtained successfully");
prevLow=lows[0]; // The previous day Low
Print("prevLow =",prevLow);
if(ObjectFind(0,lowlevel)<0) // Object with the name lowlevel not found
{
ObjectCreate(0,lowlevel,OBJ_HLINE,0,0,0); // Create the Horizontal Line object
}
//--- Set value for the price level for the line lowlevel
ObjectSetDouble(0,lowlevel,OBJPROP_PRICE,0,prevLow);
//--- Set the visibility only PERIOD_M10 and PERIOD_H4
ObjectSetInteger(0,lowlevel,OBJPROP_TIMEFRAMES,OBJ_PERIOD_M10|OBJ_PERIOD_H4);
}
else Print("Could not get Low prices for the last 2 days, Error =",GetLastError());

ChartRedraw(0); // redraw the chart forcibly


}

See also

PeriodSeconds, Period, Chart timeframes, Date and Time

© 2000-2010, MetaQuotes Software Corp.


189 Standard Constants, Enumerations and Structures

Levels of Elliott Wave


Elliott Waves are represented by two graphical objects of types OBJ_ELLIOTWAVE5 and
OBJ_ELLIOTWAVE3. To set the wave size (method of wave labeling), the OBJPROP_DEGREE property is
used, to which one of values of the ENUM_ELLIOT_WAVE_DEGREE enumeration can be assigned.

ENUM_ELLIOT_WAVE_DEGREE

ID Description

ELLIOTT_GRAND_SUPERCYCLE Grand Supercycle

ELLIOTT_SUPERCYCLE Supercycle

ELLIOTT_CYCLE Cycle

ELLIOTT_PRIMARY Primary

ELLIOTT_INTERMEDIATE Intermediate

ELLIOTT_MINOR Minor

ELLIOTT_MINUTE Minute

ELLIOTT_MINUETTE Minuette

ELLIOTT_SUBMINUETTE Subminuette

Example:

for(int i=0;i<ObjectsTotal(0);i++)
{
string currobj=ObjectName(0,i);
if((ObjectGetInteger(0,currobj,OBJPROP_TYPE)==OBJ_ELLIOTWAVE3) ||
((ObjectGetInteger(0,currobj,OBJPROP_TYPE)==OBJ_ELLIOTWAVE5)))
{
//--- set the marking level in INTERMEDIATE
ObjectSetInteger(0,currobj,OBJPROP_DEGREE,ELLIOTT_INTERMEDIATE);
//--- show lines between tops of waves
ObjectSetInteger(0,currobj,OBJPROP_DRAWLINES,true);
//--- set line color
ObjectSetInteger(0,currobj,OBJPROP_COLOR,Blue);
//--- set line width
ObjectSetInteger(0,currobj,OBJPROP_WIDTH,5);
//--- set description
ObjectSetString(0,currobj,OBJPROP_TEXT,"test script");
}
}

© 2000-2010, MetaQuotes Software Corp.


190 Standard Constants, Enumerations and Structures

Gann Objects
For Gann Fan (OBJ_GANNFAN) and Gann Grid (OBJ_GANNGRID) of two values of
ENUM_GANN_DIRECTION can be specified, which will set the trend direction.

ENUM_GANN_DIRECTION

ID Description

GANN_UP_TREND Line corresponding to the uptrend line

GANN_DOWN_TREND Line corresponding to the downward trend

To set the scale of the main line as 1x1, use function ObjectSetDouble(chart_handle,
gann_object_name, OBJPROP_SCALE, scale), where:

chart_handle – chart window where the object is located;


gann_object_name – object name;
OBJPROP_SCALE – identifier of the "Scale" property;
scale – required scale in units of Pips/Bar.

Example of creating Gann Fan:

void OnStart()
{
//---
string my_gann="OBJ_GANNFAN object";
if(ObjectFind(0,my_gann)<0)// Object not found
{
//--- Inform about the failure
Print("Object",my_gann,"not found. Error code =",GetLastError());
//--- Get the maximal price of the chart
double chart_max_price=ChartGetDouble(0,CHART_PRICE_MAX,0);
//--- Get the minimal price of the chart
double chart_min_price=ChartGetDouble(0,CHART_PRICE_MIN,0);
//--- How many bars are shown in the chart?

© 2000-2010, MetaQuotes Software Corp.


191 Standard Constants, Enumerations and Structures

int bars_on_chart=ChartGetInteger(0,CHART_VISIBLE_BARS);
//--- Create an array, to write the opening time of each bar to
datetime Time[];
//--- Arrange access to the array as that of timeseries
ArraySetAsSeries(Time,true);
//--- Now copy data of bars visible in the chart into this array
int times=CopyTime(NULL,0,0,bars_on_chart,Time);
if(times<=0)
{
Print("Could not copy the array with the open time!");
return;
}
//--- Preliminary preparations completed

//--- Index of the central bar in the chart


int center_bar=bars_on_chart/2;
//--- Chart equator - between the maximum and minimum
double mean=(chart_max_price+chart_min_price)/2.0;
//--- Set the coordinates of the first anchor point to the center
ObjectCreate(0,my_gann,OBJ_GANNFAN,0,Time[center_bar],mean,
//--- Second anchor point to the right
Time[center_bar/2],(mean+chart_min_price)/2.0);
Print("Time[center_bar]/="+(string)Time[center_bar]+" Time[center_bar/2]="+(string)Time[cent
//Print("Time[center_bar]/="+Time[center_bar]+" Time[center_bar/2]="+Time[center_bar/2]);
//--- Set the scale in units of Pips / Bar
ObjectSetDouble(0,my_gann,OBJPROP_SCALE,10);
//--- Set the line trend
ObjectSetInteger(0,my_gann,OBJPROP_DIRECTION,GANN_UP_TREND);
//--- Set the line width
ObjectSetInteger(0,my_gann,OBJPROP_WIDTH,1);
//--- Define the line style
ObjectSetInteger(0,my_gann,OBJPROP_STYLE,STYLE_DASHDOT);
//--- Set the line color
ObjectSetInteger(0,my_gann,OBJPROP_COLOR,YellowGreen);
//--- Allow the user to select an object
ObjectSetInteger(0,my_gann,OBJPROP_SELECTABLE,true);
//--- Select it yourself
ObjectSetInteger(0,my_gann,OBJPROP_SELECTED,true);
//--- Draw it on the chart
ChartRedraw(0);
}
}

© 2000-2010, MetaQuotes Software Corp.


192 Standard Constants, Enumerations and Structures

Web Colors
The following color constants are defined for the color type:

Black DarkGreen DarkSlateG Olive Green Teal Navy Purple


ray

M aroon Indigo M idnightBl DarkBlue DarkOliveG SaddleBro ForestGre OliveDrab


ue reen wn en

SeaGreen DarkGolde DarkSlateB Sienna M ediumBlu Brown DarkTurqu DimGray


nrod lue e oise

LightSeaGr DarkViolet FireBrick M ediumVio M ediumSe Chocolate Crimson SteelBlue


een letRed aGreen

Goldenrod M ediumSp LawnGree CadetBlue DarkOrchi YellowGre LimeGreen OrangeRed


ringGreen n d en

DarkOrang Orange Gold Yellow Chartreus Lime SpringGree Aqua


e e n

DeepSkyBl Blue M agenta Red Gray SlateGray Peru BlueViolet


ue

LightSlate DeepPink M ediumTu DodgerBlu Turquoise RoyalBlue SlateBlue DarkKhaki


Gray rquoise e

IndianRed M ediumOr GreenYell M ediumAq DarkSeaGr Tomato RosyBrown Orchid


chid ow uamarine een

M ediumPu PaleViolet Coral Cornflowe DarkGray SandyBrow M ediumSla Tan


rple Red rBlue n teBlue

DarkSalmo BurlyWood HotPink Salmon Violet LightCoral SkyBlue LightSalmo


n n

Plum Khaki LightGree Aquamarin Silver LightSkyBl LightSteel LightBlue


n e ue Blue

PaleGreen Thistle PowderBlu PaleGolde PaleTurqu LightGray Wheat NavajoWhit


e nrod oise e

M occasin LightPink Gainsboro PeachPuff Pink Bisque LightGolde BlanchedAl


nrod mond

LemonChif Beige AntiqueWh PapayaWhi Cornsilk LightYello LightCyan Linen


fon ite p w

Lavender M istyRose OldLace WhiteSmok Seashell Ivory Honeydew AliceBlue


e

Lavender M intCream Snow White


Blush

Color can be set to an object using the ObjectSetInteger() function. For setting color to custom
indicators the PlotIndexSetInteger() function is used. For getting color values there are similar
functions ObjectGetInteger() and PlotIndexGetInteger().

Example:

© 2000-2010, MetaQuotes Software Corp.


193 Standard Constants, Enumerations and Structures

//---- indicator settings


#property indicator_chart_window
#property indicator_buffers 3
#property indicator_plots 3
#property indicator_type1 DRAW_LINE
#property indicator_type2 DRAW_LINE
#property indicator_type3 DRAW_LINE
#property indicator_color1 Blue
#property indicator_color2 Red
#property indicator_color3 Lime

© 2000-2010, MetaQuotes Software Corp.


194 Standard Constants, Enumerations and Structures

Wingdings
Characters of Wingdings used with the OBJ_ARROW object:

A necessary character can be set using the ObjectSetInteger() function.

Example:

void OnStart()
{
//---
string up_arrow="up_arrow";
datetime time=TimeCurrent();
double lastClose[1];
int close=CopyClose(Symbol(),Period(),0,1,lastClose); // Get the Close price
//--- If the price was obtained
if(close>0)
{
ObjectCreate(0,up_arrow,OBJ_ARROW,0,0,0,0,0); // Create an arrow
ObjectSetInteger(0,up_arrow,OBJPROP_ARROWCODE,241); // Set the arrow code
ObjectSetInteger(0,up_arrow,OBJPROP_TIME,time); // Set time
ObjectSetDouble(0,up_arrow,OBJPROP_PRICE,lastClose[0]);// Set price
ChartRedraw(0); // Draw arrow now
}
else
Print("Unable to get the latest Close price!");
}

© 2000-2010, MetaQuotes Software Corp.


195 Standard Constants, Enumerations and Structures

Indicators Constants
There are 37 predefined technical indicators, which can be used in programs written in the MQL5
language. In addition, there is an opportunity to create custom indicators using the iCustom()
function. All constants required for that are divided into 5 groups:

Price constants – for selecting the type of price or volume, on which an indicator is calculated;
Smoothing methods – built-in smoothing methods used in indicators;
Indicator lines – identifiers of indicator buffers when accessing indicator values using CopyBuffer();
Drawing styles – for indicating one of 18 types of drawing and setting the line drawing style;
Custom indicators properties are used in functions for working with custom indicators;
Types of indicators are used for specifying the type of technical indicator when creating a handle
using IndicatorCreate();
Identifiers of data types are used for specifying the type of data passed in an array of the MqlParam
type into the IndicatorCreate() function.

© 2000-2010, MetaQuotes Software Corp.


196 Standard Constants, Enumerations and Structures

Price Constants
Calculations of technical indicators require price values and/or values of volumes, on which
calculations will be performed. There are 7 predefined identifiers from the ENUM_APPLIED_PRICE
enumeration, used to specify the desired price base for calculations.

ENUM_APPLIED_PRICE

ID Description

PRICE_CLOSE Close price

PRICE_OPEN Open price

PRICE_HIGH The maximum price for the period

PRICE_LOW The minimum price for the period

PRICE_MEDIAN Median price, (high + low)/2

PRICE_TYPICAL Typical price, (high + low + close)/3

PRICE_WEIGHTED Average price, (high + low + close + close)/4

If the volume is used in calculations, it's necessary to specify one of the two values from the
ENUM_APPLIED_VOLUME enumeration.

ENUM_APPLIED_VOLUME

ID Description

VOLUME_TICK Tick volume

VOLUME_REAL Trade volume

The iStochastic() technical Indicator can be calculated in two ways using:

either only Close prices;


or High and Low prices.
To select a necessary variant for calculation, specify one of the values of the ENUM_STO_PRICE
enumeration.

ENUM_STO_PRICE

ID Description

STO_LOWHIGH Calculation is based on Low/High prices

STO_CLOSECLOSE Calculation is on prices Close/Close based

If a technical indicator uses for calculations price data, type of which is set by
ENUM_APPLIED_PRICE, then handle of any indicator (built in the terminal or written by a user) can be
used as the input price series. In this case, values of the zero buffer of the indicator indicator will be
used for calculations. This makes it easy to build values of one indicator using values of another
indicator. The handle of a custom indicator is created by calling the iCustom() function.

© 2000-2010, MetaQuotes Software Corp.


197 Standard Constants, Enumerations and Structures

Example:

#property indicator_separate_window
#property indicator_buffers 2
#property indicator_plots 2
//--- input parameters
input int RSIperiod=14; // Period for calculating the RSI
input int Smooth=8; // Smoothing period RSI
input ENUM_MA_METHOD meth=MODE_SMMA; // Method of smoothing
//---- plot RSI
#property indicator_label1 "RSI"
#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//---- plot RSI_Smoothed
#property indicator_label2 "RSI_Smoothed"
#property indicator_type2 DRAW_LINE
#property indicator_color2 Navy
#property indicator_style2 STYLE_SOLID
#property indicator_width2 1
//--- indicator buffers
double RSIBuffer[]; // Here we store the values of RSI
double RSI_SmoothedBuffer[]; // Here will be smoothed values of RSI
int RSIhandle; // Handle to the RSI indicator
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,RSIBuffer,INDICATOR_DATA);
SetIndexBuffer(1,RSI_SmoothedBuffer,INDICATOR_DATA);
IndicatorSetString(INDICATOR_SHORTNAME,"iRSI");
IndicatorSetInteger(INDICATOR_DIGITS,2);
//---
RSIhandle=iRSI(NULL,0,RSIperiod,PRICE_CLOSE);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const int begin,
const double &price[]
)

© 2000-2010, MetaQuotes Software Corp.


198 Standard Constants, Enumerations and Structures

//--- Reset the value of the last error


ResetLastError();
//--- Get RSI indicator data in an array RSIBuffer []
int copied=CopyBuffer(RSIhandle,0,0,rates_total,RSIBuffer);
if(copied<=0)
{
Print("Unable to copy the values of the indicator RSI. Error =",
GetLastError(),", copied =",copied);
return(0);
}
//--- Create the indicator of average values using values of RSI
int RSI_MA_handle=iMA(NULL,0,Smooth,0,meth,RSIhandle);
copied=CopyBuffer(RSI_MA_handle,0,0,rates_total,RSI_SmoothedBuffer);
if(copied<=0)
{
Print("Unable to copy the smoothed indicator of RSI. Error =",
GetLastError(),", copied =",copied);
return(0);
}
//--- return value of prev_calculated for next call
return(rates_total);
}

© 2000-2010, MetaQuotes Software Corp.


199 Standard Constants, Enumerations and Structures

Smoothing Methods
Many technical indicators are based on various methods of the price series smoothing. Some
standard technical indicators require specification of the smoothing type as an input parameter. For
specifying the desired type of smoothing, identifiers listed in the ENUM_MA_METHOD enumeration are
used.

ENUM_MA_METHOD

ID Description

MODE_SMA Simple averaging

MODE_EMA Exponential averaging

MODE_SMMA Smoothed averaging

MODE_LWMA Linear-weighted averaging

Example:

double ExtJaws[];
double ExtTeeth[];
double ExtLips[];
//---- handles for moving averages
int ExtJawsHandle;
int ExtTeethHandle;
int ExtLipsHandle;
//--- get MA's handles
ExtJawsHandle=iMA(NULL,0,JawsPeriod,0,MODE_SMMA,PRICE_MEDIAN);
ExtTeethHandle=iMA(NULL,0,TeethPeriod,0,MODE_SMMA,PRICE_MEDIAN);
ExtLipsHandle=iMA(NULL,0,LipsPeriod,0,MODE_SMMA,PRICE_MEDIAN);

© 2000-2010, MetaQuotes Software Corp.


200 Standard Constants, Enumerations and Structures

Indicators Lines
Some technical indicators have several buffers drawn in the chart. Numbering of indicator buffers
starts with 0. When copying indicator values using the CopyBuffer() function into an array of the
double type, for some indicators one may indicate the identifier of a copied buffer instead of its
number.

Identifiers of indicator lines permissible when copying values of iMACD(), iRVI() and iStochastic().

Constant Value Description

MAIN_LINE 0 Main line

SIGNAL_LINE 1 Signal line

Identifiers of indicator lines permissible when copying values of ADX() and ADXW().

Constant Value Description

MAIN_LINE 0 Main line

PLUSDI_LINE 1 Line +DI

MINUSDI_LINE 2 Line –DI

Identifiers of indicator lines permissible when copying values of iBands().

Constant Value Description

BASE_LINE 0 Main line

UPPER_BAND 1 Upper limit

LOWER_BAND 2 Lower limit

Identifiers of indicator lines permissible when copying values of iEnvelopes() and iFractals().

Constant Value Description

UPPER_LINE 0 Upper line

LOWER_LINE 1 Bottom line

Identifiers of indicator lines permissible when copying values of iGator()

Constant Value Description

UPPER_HISTOGRAM 0 Upper histogram

LOWER_HISTOGRAM 2 Bottom histogram

Identifiers of indicator lines permissible when copying values of iAlligator().

Constant Value Description

© 2000-2010, MetaQuotes Software Corp.


201 Standard Constants, Enumerations and Structures

GATORJAW_LINE 0 Jaw line

GATORTEETH_LINE 1 Teeth line

GATORLIPS_LINE 2 Lips line

Identifiers of indicator lines permissible when copying values of iIchimoku().

Constant Value Description

TENKANSEN_LINE 0 Tenkan-sen line

KIJUNSEN_LINE 1 Kijun-sen line

SENKOUSPANA_LINE 2 Senkou Span A line

SENKOUSPANB_LINE 3 Senkou Span B line

CHINKOUSPAN_LINE 4 Chinkou Span line

© 2000-2010, MetaQuotes Software Corp.


202 Standard Constants, Enumerations and Structures

Drawing Styles
When creating a custom indicator, you can specify one of 18 types of graphical construction (as
displayed in the main chart window or a chart subwindow), whose values are specified in the
ENUM_DRAW_TYPE enumeration.

In one custom indicator, it is permissible to use any indicator building/drawing types. Each
construction type requires specification of one to five global arrays for storing data necessary for
drawing. These data arrays must be bound with indicator buffers using the SetIndexBuffer() function.
The type of data from ENUM_INDEXBUFFER_TYPE should be specified for each buffer.

Depending on the drawing style, you may need one to four value buffers (marked as
INDICATOR_DATA). If a style admits dynamic alternation of colors (all styles contain COLOR in their
names), then you'll need one more buffer of color (indicated type INDICATOR_COLOR_INDEX). The
color buffer are always bound after value buffers corresponding to the style.

ENUM_DRAW_TYPE

ID Description Data buffers Color buffers

DRAW_NONE Not drawn 1 0

DRAW_LINE Line 1 0

DRAW_SECTION Section 1 0

DRAW_HISTOGRAM Histogram from the 1 0


zero line

DRAW_HISTOGRAM2 Histogram of the two 2 0


indicator buffers

DRAW_ARROW Drawing arrows 1 0

DRAW_ZIGZAG Style Zigzag allows 2 0


vertical section on the
bar

DRAW_FILLING Color fill between the 2 0


two levels

DRAW_BARS Display as a sequence 4 0


of bars

DRAW_CANDLES Display as a sequence 4 0


of candlesticks

DRAW_COLOR_LINE Multicolored line 1 1

DRAW_COLOR_SECTIO Multicolored section 1 1


N

DRAW_COLOR_HISTO Multicolored histogram 1 1


GRAM from the zero line

DRAW_COLOR_HISTO Multicolored histogram 2 1


GRAM2 of the two indicator

© 2000-2010, MetaQuotes Software Corp.


203 Standard Constants, Enumerations and Structures

buffers

DRAW_COLOR_ARRO Drawing multicolored 1 1


W arrows

DRAW_COLOR_ZIGZAG Multicolored ZigZag 2 1

DRAW_COLOR_BARS Multicolored bars 4 1

DRAW_COLOR_CANDL Multicolored 4 1
ES candlesticks

To refine the display of the selected drawing type identifiers listed in ENUM_PLOT_PROPERTY are
used.

For functions PlotIndexSetInteger() and PlotIndexGetInteger()

ENUM_PLOT_PROPERTY_INTEGER

ID Description Property type

PLOT_ARROW Arrow code for style uchar


DRAW_ARROW

PLOT_ARROW_SHIFT Vertical shift of arrows for int


style DRAW_ARROW

PLOT_DRAW_BEGIN Number of initial bars without int


drawing and values in the
DataWindow

PLOT_DRAW_TYPE Type of graphical construction ENUM_DRAW_TYPE

PLOT_SHOW_DATA Sign of display of construction bool


values in the DataWindow

PLOT_SHIFT Shift of indicator plotting along int


the time axis in bars

PLOT_LINE_STYLE Drawing line style ENUM_LINE_STYLE

PLOT_LINE_WIDTH The thickness of the drawing int


line

PLOT_COLOR_INDEXES The number of colors int

PLOT_LINE_COLOR The index of a buffer color modifier = index


containing the drawing color number of colors

For the function PlotIndexSetDouble()

ENUM_PLOT_PROPERTY_DOUBLE

ID Description Property type

PLOT_EMPTY_VALUE An empty value for plotting, double

© 2000-2010, MetaQuotes Software Corp.


204 Standard Constants, Enumerations and Structures

for which there is no drawing

For the function PlotIndexSetString()

ENUM_PLOT_PROPERTY_STRING

ID Description Property type

PLOT_LABEL The name of the indicator string


graphical series to display in
the DataWindow

5 styles can be used for drawing lines in custom indicators. They are valid only for the line thickness
0 or 1.

ENUM_LINE_STYLE

ID Description

STYLE_SOLID Solid line

STYLE_DASH Broken line

STYLE_DOT Dotted line

STYLE_DASHDOT Dash-dot line

STYLE_DASHDOTDOT Dash - two points

To set the line drawing style and the type of drawing, the PlotIndexSetInteger() function is used. For
the Fibonacci extensions the thickness and drawing style of levels can be indicated using the
ObjectSetInteger() function.

Example:

#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//--- indicator buffers
double MABuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- Bind the Array to the indicator buffer with index 0
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
//--- Set the line drawing
PlotIndexSetInteger(0,PLOT_DRAW_TYPE,DRAW_LINE);
//--- Set the style line
PlotIndexSetInteger(0,PLOT_LINE_STYLE,STYLE_DOT);
//--- Set line color
PlotIndexSetInteger(0,PLOT_LINE_COLOR,Red);

© 2000-2010, MetaQuotes Software Corp.


205 Standard Constants, Enumerations and Structures

//--- Set line thickness


PlotIndexSetInteger(0,PLOT_LINE_WIDTH,1);
//--- Set labels for the line
PlotIndexSetString(0,PLOT_LABEL,"Moving Average");
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
for(int i=prev_calculated;i<rates_total;i++)
{
MABuffer[i]=close[i];
}
//--- return value of prev_calculated for next call
return(rates_total);
}

© 2000-2010, MetaQuotes Software Corp.


206 Standard Constants, Enumerations and Structures

Custom Indicators Properties


The number of indicator buffers that can be used in a custom indicator is unlimited. But for each
array, which is designated as the indicator buffer using the SetIndexBuffer() function, it's necessary to
specify the data type that it will store. This may be one of the values of the ENUM_INDEXBUFFER_TYPE
enumeration.

ENUM_INDEXBUFFER_TYPE

ID Description

INDICATOR_DATA Data to draw

INDICATOR_COLOR_INDEX Color

INDICATOR_CALCULATIONS Auxiliary buffers for intermediate calculations

A custom indicator has a lot of settings to provide convenient displaying. These settings are made
through the assignment of corresponding indicator properties using functions IndicatorSetDouble(),
IndicatorSetInteger() and IndicatorSetString(). Identifiers of indicator properties are listed in the
ENUM_CUSTOMIND_PROPERTY enumeration.

ENUM_CUSTOMIND_PROPERTY_INTEGER

ID Description Property type

INDICATOR_DIGITS Accuracy of drawing of int


indicator values

INDICATOR_LEVELS Number of levels in the int


indicator window

INDICATOR_LEVELCOLOR Color of the level line color modifier =


level number

INDICATOR_LEVELSTYLE Style of the level line ENUM_LINE_STYLE modifier =


level number

INDICATOR_LEVELWIDTH Thickness of the level line int modifier =


level number

ENUM_CUSTOMIND_PROPERTY_DOUBLE

ID Description Property type

INDICATOR_MINIMUM Maximum of the indicator double


window

INDICATOR_MAXIMUM Minimum of the indicator double


window

INDICATOR_LEVELVALUE Level value double modifier =


level number

ENUM_CUSTOMIND_PROPERTY_STRING

© 2000-2010, MetaQuotes Software Corp.


207 Standard Constants, Enumerations and Structures

ID Description Property type

INDICATOR_SHORTNAME Short indicator name string

INDICATOR_LEVELTEXT Level description string modifier =


level number

Examples:

//--- indicator settings


#property indicator_separate_window
#property indicator_buffers 4
#property indicator_plots 2
#property indicator_type1 DRAW_LINE
#property indicator_type2 DRAW_LINE
#property indicator_color1 LightSeaGreen
#property indicator_color2 Red
//--- input parameters
extern int KPeriod=5;
extern int DPeriod=3;
extern int Slowing=3;
//--- indicator buffers
double MainBuffer[];
double SignalBuffer[];
double HighesBuffer[];
double LowesBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,MainBuffer,INDICATOR_DATA);
SetIndexBuffer(1,SignalBuffer,INDICATOR_DATA);
SetIndexBuffer(2,HighesBuffer,INDICATOR_CALCULATIONS);
SetIndexBuffer(3,LowesBuffer,INDICATOR_CALCULATIONS);
//--- set accuracy
IndicatorSetInteger(INDICATOR_DIGITS,2);
//--- set levels
IndicatorSetInteger(INDICATOR_LEVELS,2);
IndicatorSetDouble(INDICATOR_LEVELVALUE,0,20);
IndicatorSetDouble(INDICATOR_LEVELVALUE,1,80);
//--- set maximum and minimum for subwindow
IndicatorSetDouble(INDICATOR_MINIMUM,0);
IndicatorSetDouble(INDICATOR_MAXIMUM,100);
//--- sets first bar from what index will be drawn
PlotIndexSetInteger(0,PLOT_DRAW_BEGIN,KPeriod+Slowing-2);
PlotIndexSetInteger(1,PLOT_DRAW_BEGIN,KPeriod+Slowing+DPeriod);
//--- set style STYLE_DOT for second line
PlotIndexSetInteger(1,PLOT_LINE_STYLE,STYLE_DOT);

© 2000-2010, MetaQuotes Software Corp.


208 Standard Constants, Enumerations and Structures

//--- name for DataWindow and indicator subwindow label


IndicatorSetString(INDICATOR_SHORTNAME,"Stoch("+KPeriod+","+DPeriod+","+Slowing+")");
PlotIndexSetString(0,PLOT_LABEL,"Main");
PlotIndexSetString(1,PLOT_LABEL,"Signal");
//--- sets drawing line empty value
PlotIndexSetDouble(0,PLOT_EMPTY_VALUE,0.0);
PlotIndexSetDouble(1,PLOT_EMPTY_VALUE,0.0);
//--- initialization done
}

© 2000-2010, MetaQuotes Software Corp.


209 Standard Constants, Enumerations and Structures

Types of Technical Indicators


There are two ways to programmatically create the indicator handle for further accessing to its
values. The first way is to directly specify a function name from the list of technical indicators. The
second method using the IndicatorCreate() is to uniformly create a handle of any indicator by
assigning an identifier from the ENUM_INDICATOR enumeration. Both ways of handle creation are
equal, you can use the one that is most convenient in a particular case when writing a program in
MQL5.

When creating an indicator of type IND_CUSTOM, the type field of the first element of an array of
input parameters MqlParam must have the TYPE_STRING value of the enumeration ENUM_DATATYPE,
while the field string_value of the first element must contain the name of the custom indicator.

ENUM_INDICATOR

Identifier Indicator

IND_AC Accelerator Oscillator

IND_AD Accumulation/Distribution

IND_ADX Average Directional Index

IND_ADXW ADX by Welles Wilder

IND_ALLIGATOR Alligator

IND_AMA Adaptive Moving Average

IND_AO Awesome Oscillator

IND_ATR Average True Range

IND_BANDS Bollinger Bands

IND_BEARS Bears Power

IND_BULLS Bulls Power

IND_BWMFI Market Facilitation Index

IND_CCI Commodity Channel Index

IND_CHAIKIN Chaikin Oscillator

IND_CUSTOM Custom indicator

IND_DEMA Double Exponential Moving Average

IND_DEMARKER DeMarker

IND_ENVELOPES Envelopes

IND_FORCE Force Index

IND_FRACTALS Fractals

IND_FRAMA Fractal Adaptive Moving Average

IND_GATOR Gator Oscillator

© 2000-2010, MetaQuotes Software Corp.


210 Standard Constants, Enumerations and Structures

IND_ICHIMOKU Ichimoku Kinko Hyo

IND_MA Moving Average

IND_MACD MACD

IND_MFI Money Flow Index

IND_MOMENTUM Momentum

IND_OBV On Balance Volume

IND_OSMA OsMA

IND_RSI Relative Strength Index

IND_RVI Relative Vigor Index

IND_SAR Parabolic SAR

IND_STDDEV Standard Deviation

IND_STOCHASTIC Stochastic Oscillator

IND_TEMA Triple Exponential Moving Average

IND_TRIX Triple Exponential Moving Averages Oscillator

IND_VIDYA Variable Index Dynamic Average

IND_VOLUMES Volumes

IND_WPR Williams' Percent Range

© 2000-2010, MetaQuotes Software Corp.


211 Standard Constants, Enumerations and Structures

Data Type Identifiers


When creating an indicator handle using the IndicatorCreate() function, an array of MqlParam type
must be specified as the last parameter. Accordingly, the MqlParam structure, describing indicator,
contains a special field type. This field contains information about the data type (real, integer or
string type) that are passed by a particular element of the array. The value of this field of the
MqlParam structure may be one of ENUM_DATATYPE values.

ENUM_DATATYPE

Identifier Data type

TYPE_BOOL bool

TYPE_CHAR char

TYPE_UCHAR uchar

TYPE_SHORT short

TYPE_USHORT ushort

TYPE_COLOR color

TYPE_INT int

TYPE_UINT uint

TYPE_DATETIME datetime

TYPE_LONG long

TYPE_ULONG ulong

TYPE_FLOAT float

TYPE_DOUBLE double

TYPE_STRING string

Each element of the array describes the corresponding input parameter of a created technical
indicator, so the type and order of elements in the array must be strictly maintained in accordance
with the description.

© 2000-2010, MetaQuotes Software Corp.


212 Standard Constants, Enumerations and Structures

Environment State
Constants describing the current runtime environment of an mql5-program are divided into groups:

Client terminal properties – information about the client terminal;


Executed MQL5-program properties – mql5 program properties, which help to control its execution;
Symbol properties – obtaining information about a symbol;
Account properties – information about the current account;

© 2000-2010, MetaQuotes Software Corp.


213 Standard Constants, Enumerations and Structures

Client Terminal Properties


Information about the client terminal can be obtained by two functions: TerminalInfoInteger() and
TerminalInfoString(). For parameters, these functions accept values from
ENUM_TERMINAL_INFO_INTEGER and ENUM_TERMINAL_INFO_STRING respectively.

ENUM_TERMINAL_INFO_INTEGER

Identifier Description Type

TERMINAL_BUILD The client terminal build int


number

TERMINAL_CONNECTED Connection to a trade server bool

TERMINAL_DLLS_ALLOWED Permission to use DLL bool

TERMINAL_TRADE_ALLOWED Permission to trade bool

TERMINAL_EMAIL_ENABLED Permission to send e-mails bool


using SMTP-server and login,
specified in the terminal
settings

TERMINAL_FTP_ENABLED Permission to send reports bool


using FTP-server and login,
specified in the terminal
settings

TERMINAL_MAXBARS The maximal bars count on the int


chart

File operations can be performed only in two directories; corresponding paths can be obtained using
the request for TERMINAL_DATA_PATH and TERMINAL_COMMONDATA_PATH properties.

ENUM_TERMINAL_INFO_STRING

Identifier Description Type

TERMINAL_COMPANY Company name string

TERMINAL_NAME Terminal name string

TERMINAL_PATH Folder from which the terminal string


is started

TERMINAL_DATA_PATH Folder in which terminal data string


are stored

TERMINAL_COMMONDATA_PAT Common path for all of the string


H terminals installed on a
computer

For a better understanding of paths, stored in properties of TERMINAL_PATH,


TERMINAL_DATA_PATH and TERMINAL_COMMONDATA_PATH parameters, it is recommended to
execute the script, which will return these values for the current copy of the client terminal, installed

© 2000-2010, MetaQuotes Software Corp.


214 Standard Constants, Enumerations and Structures

on your computer

Example: Script returns information about the client terminal paths

//+------------------------------------------------------------------+
//| Check_TerminalPaths.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
Print("TERMINAL_PATH =",TerminalInfoString(TERMINAL_PATH));
Print("TERMINAL_DATA_PATH =",TerminalInfoString(TERMINAL_DATA_PATH));
Print("TERMINAL_COMMONDATA_PATH =",TerminalInfoString(TERMINAL_COMMONDATA_PATH));
}

As result of the script execution in the Experts Journal you will see a messages, like the following:

© 2000-2010, MetaQuotes Software Corp.


215 Standard Constants, Enumerations and Structures

Running MQL Program Properties


To obtain information about the currently running mql5 program, constants from
ENUM_MQL5_INFO_INTEGER and ENUM_MQL5_INFO_STRING are used.

For function MQL5InfoInteger

ENUM_MQL5_INFO_INTEGER

Identifier Description Type

MQL5_PROGRAM_TYPE Type of the mql5 program ENUM_PROGRAM_TYPE

MQL5_DLLS_ALLOWED The permission to use DLL for bool


the given executed program

MQL5_TRADE_ALLOWED The permission to trade for bool


the given executed program

MQL5_DEBUGGING The flag, that indicates the bool


debug mode

MQL5_TESTING The flag, that indicates the bool


tester process

MQL5_OPTIMIZATION The flag, that indicates the bool


optimization process

MQL5_VISUAL_MODE The flag, that indicates the bool


visual tester process

For function MQL5InfoString

ENUM_MQL5_INFO_STRING

Identifier Description Type

MQL5_PROGRAM_NAME Name of the mql5-program string


executed

MQL5_PROGRAM_PATH Path for the given executed string


program

Information about the type of the running program, values of ENUM_PROGRAM_TYPE are used.

ENUM_PROGRAM_TYPE

Identifier Description

PROGRAM_SCRIPT Script

PROGRAM_EXPERT Expert

PROGRAM_INDICATOR Indicator

© 2000-2010, MetaQuotes Software Corp.


216 Standard Constants, Enumerations and Structures

Example:

ENUM_PROGRAM_TYPE mql_program=(ENUM_PROGRAM_TYPE)MQL5InfoInteger(MQL5_PROGRAM_TYPE);
switch(mql_program)
{
case PROGRAM_SCRIPT:
{
Print(__FILE__+" is script");
break;
}
case PROGRAM_EXPERT:
{
Print(__FILE__+" is Expert Advisor");
break;
}
case PROGRAM_INDICATOR:
{
Print(__FILE__+" is custom indicator");
break;
}
default:Print("MQL5 type value is ",mql_program);
}

© 2000-2010, MetaQuotes Software Corp.


217 Standard Constants, Enumerations and Structures

Symbol properties
To obtain the current market information there are several functions: SymbolInfoInteger(),
SymbolInfoDouble() and SymbolInfoString(). The first parameter is the symbol name, the values of the
second function parameter can be one of the identifiers of ENUM_SYMBOL_INFO_INTEGER,
ENUM_SYMBOL_INFO_DOUBLE and ENUM_SYMBOL_INFO_STRING.

For function SymbolInfoInteger()

ENUM_SYMBOL_INFO_INTEGER

Identifier Description Type

SYMBOL_SELECT Symbol is selected in Market bool


Watch

SYMBOL_VOLUME Volume of the last deal long

SYMBOL_VOLUMEHIGH Maximal day volume long

SYMBOL_VOLUMELOW Minimal day volume long

SYMBOL_VOLUMEBID Volume for current Bid long

SYMBOL_VOLUMEASK Volume for current Ask long

SYMBOL_TIME Time of the last quote datetime

SYMBOL_DIGITS Digits after a decimal point int

SYMBOL_SPREAD_FLOAT Indication of a floating spread bool

SYMBOL_SPREAD Spread value in points int

SYMBOL_TICKS_BOOKDEPTH Ticks storing depth int

SYMBOL_TRADE_CALC_MODE Contract price calculation mode ENUM_SYMBOL_CALC_MODE

SYMBOL_TRADE_MODE Order execution type ENUM_SYMBOL_TRADE_MODE

SYMBOL_TRADE_STOPS_LEVEL Minimal indention in points int


from the current close price to
place Stop orders

SYMBOL_TRADE_FREEZE_LEVEL Distance to freeze trade int


operations in points

SYMBOL_TRADE_EXEMODE Deal execution mode ENUM_SYMBOL_TRADE_EXECUT


ION

SYMBOL_SWAP_MODE Swap calculation model ENUM_SYMBOL_SWAP_MODE

SYMBOL_SWAP_ROLLOVER3DA Weekday to charge 3 days ENUM_DAY_OF_WEEK


YS swap rollover

For function SymbolInfoDouble()

ENUM_SYMBOL_INFO_DOUBLE

© 2000-2010, MetaQuotes Software Corp.


218 Standard Constants, Enumerations and Structures

Identifier Description Type

SYMBOL_BID Bid - best sell offer double

SYMBOL_BIDHIGH Maximal Bid of the day double

SYMBOL_BIDLOW Minimal Bid of the day double

SYMBOL_ASK Ask - best buy offer double

SYMBOL_ASKHIGH Maximal Ask of the day double

SYMBOL_ASKLOW Minimal Ask of the day double

SYMBOL_LAST Price of the last deal double

SYMBOL_LASTHIGH Maximal Last of the day double

SYMBOL_LASTLOW Minimal Last of the day double

SYMBOL_POINT Symbol point value double

SYMBOL_TRADE_TICK_VALUE Cost of minimal price change double

SYMBOL_TRADE_TICK_SIZE Minimal price change double

SYMBOL_TRADE_CONTRACT_SI Trade contract size double


ZE

SYMBOL_VOLUME_MIN Minimal volume for a deal double

SYMBOL_VOLUME_MAX Maximal volume for a deal double

SYMBOL_VOLUME_STEP Minimal volume change step double


for deal execution

SYMBOL_SWAP_LONG Long swap value double

SYMBOL_SWAP_SHORT Short swap value double

For function SymbolInfoString()

ENUM_SYMBOL_INFO_STRING

Identifier Description Type

SYMBOL_CURRENCY_BASE Basic currency of a symbol string

SYMBOL_CURRENCY_PROFIT Profit currency string

SYMBOL_CURRENCY_MARGIN Margin currency string

SYMBOL_BANK Feeder of the current quote string

SYMBOL_DESCRIPTION Symbol description string

SYMBOL_PATH Path in the symbol tree string

ENUM_SYMBOL_CALC_MODE

Identifier Description Formula

© 2000-2010, MetaQuotes Software Corp.


219 Standard Constants, Enumerations and Structures

SYMBOL_CALC_MODE_FOREX Forex mode - calculation of Margin: Lots*Contract_Size/


profit and margin for Forex Leverage
Profit: (close_price-
open_price)*Contract_Size*Lots

SYMBOL_CALC_MODE_FUTURE Futures mode - calculation of Margin: Lots


S margin and profit for futures *InitialMargin*Percentage/100
Profit: (close_price-
open_price)*TickPrice/
TickSize*Lots

SYMBOL_CALC_MODE_CFD CFD mode - calculation of Margin: Lots


margin and profit for CFD *ContractSize*MarketPrice*Perc
entage/100
Profit: (close_price-
open_price)*Contract_Size*Lots

SYMBOL_CALC_MODE_CFDINDE CFD index mode - calculation Margin:


X of margin and profit for CFD by (Lots*ContractSize*MarketPrice
indexes )*TickPrice/TickSize
Profit: (close_price-
open_price)*Contract_Size*Lots

SYMBOL_CALC_MODE_CFDLEVE CFD Leverage mode - Margin:


RAGE calculation of margin and profit (Lots*ContractSize*MarketPrice
for CFD at leverage trading *Percentage)/Leverage
Profit: (close_price-
open_price)*Contract_Size*Lots

ENUM_SYMBOL_TRADE_MODE

Identifier Description

SYMBOL_TRADE_MODE_DISABLED Trade is disabled fro the symbol

SYMBOL_TRADE_MODE_LONGONLY Allowed only long positions

SYMBOL_TRADE_MODE_SHORTONLY Allowed only short positions

SYMBOL_TRADE_MODE_CLOSEONLY Allowed only position close operations

SYMBOL_TRADE_MODE_FULL No trade restrictions

ENUM_SYMBOL_TRADE_EXECUTION

Identifier Description

SYMBOL_TRADE_EXECUTION_REQUEST Execution by request

SYMBOL_TRADE_EXECUTION_INSTANT Instant execution

SYMBOL_TRADE_EXECUTION_MARKET Market execution

ENUM_SYMBOL_SWAP_MODE

Identifier Description

© 2000-2010, MetaQuotes Software Corp.


220 Standard Constants, Enumerations and Structures

SYMBOL_SWAP_MODE_DISABLED Swap mode disabled (no swaps)

SYMBOL_SWAP_MODE_BY_POINTS Swaps in points

SYMBOL_SWAP_MODE_BY_MONEY Swaps in money, its value is specified in the


symbol properties in the deposit currency

SYMBOL_SWAP_MODE_BY_INTEREST Swaps in yearly percents (bank mode - 360 days


in a year)

SYMBOL_SWAP_MODE_BY_MARGIN_CURRENCY Swaps in money, its value is specified in the


symbol properties in the margin currency

ENUM_DAY_OF_WEEK

Identifier Description

SUNDAY Sunday

MONDAY Monday

TUESDAY Tuesday

WEDNESDAY Wednesday

THURSDAY Thursday

FRIDAY Friday

SATURDAY Saturday

© 2000-2010, MetaQuotes Software Corp.


221 Standard Constants, Enumerations and Structures

Account Properties
To obtain information about the current account there are several functions: AccountInfoInteger(),
AccountInfoDouble() and AccountInfoString(). The function parameter values can accept values from
the corresponding ENUM_ACCOUNT_INFO enumerations.

For the function AccountInfoInteger()

ENUM_ACCOUNT_INFO_INTEGER

Identifier Description Type

ACCOUNT_LOGIN Account number long

ACCOUNT_TRADE_MODE Account trade mode ENUM_ACCOUNT_TRADE_MODE

ACCOUNT_LEVERAGE Account leverage long

ACCOUNT_MARGIN_SO_MODE Mode for setting the minimal ENUM_ACCOUNT_STOPOUT_MO


allowed margin DE

ACCOUNT_TRADE_ALLOWED Allowed trade for the current bool


account

ACCOUNT_TRADE_EXPERT Allowed trade for an Expert bool


Advisor

For the function AccountInfoDouble()

ENUM_ACCOUNT_INFO_DOUBLE

Identifier Description Type

ACCOUNT_BALANCE Account balance double

ACCOUNT_CREDIT Account credit double

ACCOUNT_PROFIT Current profit of an account double

ACCOUNT_EQUITY Account equity double

ACCOUNT_MARGIN Account margin used double

ACCOUNT_FREEMARGIN Free margin of an account double

ACCOUNT_MARGIN_LEVEL Account margin level double

ACCOUNT_MARGIN_SO_CALL Margin call level double

ACCOUNT_MARGIN_SO_SO Margin stop out level double

For functio AccountInfoString()

ENUM_ACCOUNT_INFO_STRING

Identifier Description Type

ACCOUNT_NAME Client name string

© 2000-2010, MetaQuotes Software Corp.


222 Standard Constants, Enumerations and Structures

ACCOUNT_SERVER Trade server name string

ACCOUNT_CURRENCY Account currency string

ACCOUNT_COMPANY Name of a company that serves string


the account

ENUM_ACCOUNT_TRADE_MODE

Identifier Description

ACCOUNT_TRADE_MODE_DEMO Demo account

ACCOUNT_TRADE_MODE_CONTEST Contest account

ACCOUNT_TRADE_MODE_REAL Real account

ENUM_ACCOUNT_STOPOUT_MODE

Identifier Description

ACCOUNT_STOPOUT_MODE_PERCENT Account stop out mode in percents

ACCOUNT_STOPOUT_MODE_MONEY Account stop out mode in money

© 2000-2010, MetaQuotes Software Corp.


223 Standard Constants, Enumerations and Structures

Trade Constants
Various constants used for programming trading strategies, are divided into the following groups:

Order properties – obtaining information about trade orders;


Position properties – obtaining information about current positions;
Deal properties – obtaining information about deals;
Trade operation types – description of trade operations available;
Trade orders in DOM – separation of orders according to the direction of a requested operation.

© 2000-2010, MetaQuotes Software Corp.


224 Standard Constants, Enumerations and Structures

History Database Properties


When accessing timeseries the SeriesInfoInteger() function is used for obtaining additional symbol
information. Identifier of a required property is passed as the function parameter. The identifier can
be one of values of ENUM_SERIES_INFO_INTEGER.

ENUM_SERIES_INFO_INTEGER

Identifier Description Type

SERIES_BARS_COUNT Bars count for the symbol- long


period for the current moment

SERIES_FIRSTDATE The very first date for the datetime


symbol-period for the current
moment

SERIES_SERVER_FIRSTDATE The very first date in the datetime


history of the symbol on the
server regardless of the
timeframe

SERIES_TERMINAL_FIRSTDATE The very first date in the datetime


history of the symbol in the
client terminal, regardless of
the timeframe

SERIES_SYNCRONIZED Symbol/period data bool


synchronization flag for the
current moment

© 2000-2010, MetaQuotes Software Corp.


225 Standard Constants, Enumerations and Structures

Order Properties
Requests to execute trade operations are formalized as orders. Each order has a variety of
properties for reading. Information on them can be obtained using functions OrderGet...() and
HistoryOrderGet...().

For functions OrderGetInteger() and HistoryOrderGetInteger()

ENUM_ORDER_PROPERTY_INTEGER

Identifier Description Type

ORDER_TIME_SETUP Order setup time datetime

ORDER_TYPE Order type ENUM_ORDER_TYPE

ORDER_STATE Order state ENUM_ORDER_STATE

ORDER_TIME_EXPIRATION Order expiration time datetime

ORDER_TIME_DONE Order execution or cancellation datetime


time

ORDER_TYPE_FILLING Order filling type ENUM_ORDER_TYPE_FILLING

ORDER_TYPE_TIME Order lifetime ENUM_ORDER_TYPE_TIME

ORDER_MAGIC ID of an Expert Advisor that long


has placed the order (designed
to ensure that each Expert
Advisor places its own unique
number)

ORDER_POSITION_ID Position identifier that is set long


to an order as soon as it is
executed. Each executed order
results in a deal that opens or
modifies an already existing
position. The identifier of
exactly this position is set to
the executed order at this
moment.

For functions OrderGetDouble() and HistoryOrderGetDouble()

ENUM_ORDER_PROPERTY_DOUBLE

Identifier Description Type

ORDER_VOLUME_INITIAL Order initial volume double

ORDER_VOLUME_CURRENT Order current volume double

ORDER_PRICE_OPEN Price specified in the order double

ORDER_SL Stop Loss value double

© 2000-2010, MetaQuotes Software Corp.


226 Standard Constants, Enumerations and Structures

ORDER_TP Take Profit value double

ORDER_PRICE_CURRENT The current price of the order double


symbol

ORDER_PRICE_STOPLIMIT The Limit order price for the double


StopLimit order

For functions OrderGetString() and HistoryOrderGetString()

ENUM_ORDER_PROPERTY_STRING

Identifier Description Type

ORDER_SYMBOL Symbol of the order string

ORDER_COMMENT Order comment string

When sending a trade request using the OrderSend() function, some operations require the
indication of the order type. The order type is specified in the type field of the special structure
MqlTradeRequest, and can accept values of the ENUM_ORDER_TYPE enumeration.

ENUM_ORDER_TYPE

Identifier Description

ORDER_TYPE_BUY Market Buy order

ORDER_TYPE_SELL Market Sell order

ORDER_TYPE_BUY_LIMIT Buy Limit pending order

ORDER_TYPE_SELL_LIMIT Sell Limit pending order

ORDER_TYPE_BUY_STOP Buy Stop pending order

ORDER_TYPE_SELL_STOP Sell Stop pending order

ORDER_TYPE_BUY_STOP_LIMIT Upon reaching the order price, a pending Buy


Limit order is places at the StopLimit price

ORDER_TYPE_SELL_STOP_LIMIT Upon reaching the order price, a pending Sell


Limit order is places at the StopLimit price

Each order has a status that describes its state. To obtain information, use OrderGetInteger() or
HistoryOrderGetInteger() with the ORDER_STATE modifier. Allowed values are stored in the
ENUM_ORDER_STATE enumeration.

ENUM_ORDER_STATE

Identifier Description

ORDER_STATE_STARTED Order checked, but not yet accepted by broker

© 2000-2010, MetaQuotes Software Corp.


227 Standard Constants, Enumerations and Structures

ORDER_STATE_PLACED Order accepted

ORDER_STATE_CANCELED Order canceled by client

ORDER_STATE_PARTIAL Order partially executed

ORDER_STATE_FILLED Order fully executed

ORDER_STATE_REJECTED Order rejected

ORDER_STATE_EXPIRED Order expired

When sending a trade request using the OrderSend() function, the filling policy can be set for an
order in the type_filling field of the special structure MqlTradeRequest. Values of the
ENUM_ORDER_TYPE_FILLING enumeration are allowed. To obtain the value of this property, use the
function OrderGetInteger() or HistoryOrderGetInteger() with the ORDER_TYPE_FILLING modifier.

ENUM_ORDER_TYPE_FILLING

Identifier Description

ORDER_FILLING_AON The deal can be executed exclusively with a


specified volume at the equal or better price
than the order specified price. If there is no
sufficient volume of offers on the order symbol,
the order will not be executed.

ORDER_FILLING_CANCEL An agreement to execute the deal with maximal


market volume at the equal or better price than
the order specified price. In this case an
additional order for volume unfilled will not be
placed.

ORDER_FILLING_RETURN An agreement to execute the deal with maximal


market volume at the equal or better price than
the order specified price. In this case an
additional order for volume unfilled will be
placed.

The order validity period can be set in the type_time field of the special structure MqlTradeRequest
when sending a trade request using the OrderSend() function. Values of the ENUM_ORDER_TYPE_TIME
enumeration are allowed. To obtain the value of this property use the function OrderGetInteger() or
HistoryOrderGetInteger() with the ORDER_TYPE_TIME modifier.

ENUM_ORDER_TYPE_TIME

Identifier Description

ORDER_TIME_GTC Good till cancel order

ORDER_TIME_DAY Good till current trade day order

© 2000-2010, MetaQuotes Software Corp.


228 Standard Constants, Enumerations and Structures

ORDER_TIME_SPECIFIED Good till expired order

© 2000-2010, MetaQuotes Software Corp.


229 Standard Constants, Enumerations and Structures

Position Properties
Execution of trade operations results in the opening of a position, changing of its volume and/or
direction, or its disappearance. Trade operations are conducted based on orders, sent by the
OrderSend() function in the form of trade requests. For each financial security (symbol) only one open
position is possible. A position has a set of properties available for reading by the PositionGet...()
functions.

For the function PositionGetInteger()

ENUM_POSITION_PROPERTY_INTEGER

Identifier Description Type

POSITION_TIME Position open time datetime

POSITION_TYPE Position type ENUM_POSITION_TYPE

POSITION_MAGIC Position magic number (see long


ORDER_MAGIC)

POSITION_IDENTIFIER Position identifier is a unique long


number that is assigned to
every newly opened position
and doesn't change during the
entire lifetime of the position.
Position turnover doesn't
change its identifier.

For the function PositionGetDouble()

ENUM_POSITION_PROPERTY_DOUBLE

Identifier Description Type

POSITION_VOLUME Position volume double

POSITION_PRICE_OPEN Position open price double

POSITION_SL Stop Loss level of opened double


position

POSITION_TP Take Profit level of opened double


position

POSITION_PRICE_CURRENT Current price of the position double


symbol

POSITION_COMMISSION Commission double

POSITION_SWAP Cumulative swap double

POSITION_PROFIT Current profit double

For the function PositionGetString()

© 2000-2010, MetaQuotes Software Corp.


230 Standard Constants, Enumerations and Structures

ENUM_POSITION_PROPERTY_STRING

Identifier Description Type

POSITION_SYMBOL Symbol of the position string

POSITION_COMMENT Position comment string

Direction of an open position (buy or sell) is defined by the value from the ENUM_POSITION_TYPE
enumeration. In order to obtain the type of an open position use the PositionGetInteger() function
with the POSITION_TYPE modifier.

ENUM_POSITION_TYPE

Identifier Description

POSITION_TYPE_BUY Buy

POSITION_TYPE_SELL Sell

© 2000-2010, MetaQuotes Software Corp.


231 Standard Constants, Enumerations and Structures

Deal Properties
A deal is the reflection of the fact of a trade operation execution based on an order that contains a
trade request. Each trade is described by properties that allow to obtain information about it. In order
to read values of properties, functions of the HistoryDealGet...() type are used, that return values
from corresponding enumerations.

For the function HistoryDealGetInteger()

ENUM_DEAL_PROPERTY_INTEGER

Identifier Description Type

DEAL_ORDER Deal order number long

DEAL_TIME Deal time datetime

DEAL_TYPE Deal type ENUM_DEAL_TYPE

DEAL_ENTRY Deal entry - entry in, entry out, ENUM_DEAL_ENTRY


reverse

DEAL_MAGIC Deal magic number (see long


ORDER_MAGIC)

DEAL_POSITION_ID Identifier of a position, in the long


opening, modification or
change of which this deal took
part. Each position has a
unique identifier that is
assigned to all deals executed
for the symbol during the
entire lifetime of the position.

For the function HistoryDealGetDouble()

ENUM_DEAL_PROPERTY_DOUBLE

Identifier Description Type

DEAL_VOLUME Deal volume double

DEAL_PRICE Deal price double

DEAL_COMMISSION Deal commission double

DEAL_SWAP Cumulative swap on close double

DEAL_PROFIT Deal profit double

For the function HistoryDealGetString()

ENUM_DEAL_PROPERTY_STRING

Identifier Description Type

© 2000-2010, MetaQuotes Software Corp.


232 Standard Constants, Enumerations and Structures

DEAL_SYMBOL Deal symbol string

DEAL_COMMENT Deal comment string

Each deal is characterized by a type, allowed values are enumerated in ENUM_DEAL_TYPE. In order
to obtain information about the deal type, use the HistoryDealGetInteger() function with the
DEAL_TYPE modifier.

ENUM_DEAL_TYPE

Identifier Description

DEAL_TYPE_BUY Buy

DEAL_TYPE_SELL Sell

DEAL_TYPE_BALANCE Balance

DEAL_TYPE_CREDIT Credit

DEAL_TYPE_CHARGE Additional charge

DEAL_TYPE_CORRECTION Correction

Deals differ not only in their types set in ENUM_DEAL_TYPE, but also in the way they change
positions. This can be a simple position opening, or accumulation of a previously opened position
(market entering), position closing by an opposite deal of a corresponding volume (market exiting), or
position reversing, if the opposite-direction deal covers the volume of the previously opened position.

All these situations are described by values from the ENUM_DEAL_ENTRY enumeration. In order to
receive this information about a deal, use the HistoryDealGetInteger() function with the DEAL_ENTRY
modifier.

ENUM_DEAL_ENTRY

Identifier Description

DEAL_ENTRY_IN Entry in

DEAL_ENTRY_OUT Entry out

DEAL_ENTRY_INOUT Reverse

DEAL_ENTRY_STATE Status record

© 2000-2010, MetaQuotes Software Corp.


233 Standard Constants, Enumerations and Structures

Trade Operation Types


Trading is done by sending orders to open positions using the OrderSend() function, as well as to
place, modify or delete pending orders. Each trade order refers to the type of the requested
operation. Trading operations are described in the ENUM_TRADE_REQUEST_ACTIONS enumeration.

ENUM_TRADE_REQUEST_ACTIONS

Identifier Description

TRADE_ACTION_DEAL Place a trade order for an immediate execution


with the specified parameters (market order)

TRADE_ACTION_PENDING Place a trade order for the execution under


specified conditions (pending order)

TRADE_ACTION_SLTP Modify Stop Loss and Take Profit values of an


opened position

TRADE_ACTION_MODIFY Modify the parameters of the order placed


previously

TRADE_ACTION_REMOVE Delete the pending order placed previously

© 2000-2010, MetaQuotes Software Corp.


234 Standard Constants, Enumerations and Structures

Trade Orders in Depth Of Market


For equity securities, the Depth of Market window is available, where you can see the current Buy
and Sell orders. Desired direction of a trade operation, required amount and requested price are
specified for each order.

To obtain information about the current state of the DOM by MQL5 means, the MarketBookGet()
function is used, which places the DOM "screen shot" into the MqlBookInfo array of structures. Each
element of the array in the type field contains information about the direction of the order - the value
of the ENUM_BOOK_TYPE enumeration.

ENUM_BOOK_TYPE

Identifier Description

BOOK_TYPE_BUY Buy order (Bid)

BOOK_TYPE_SELL Sell order (Offer)

See also

Structures and classes, Structure of the DOM, Trade operation types, Market Info

© 2000-2010, MetaQuotes Software Corp.


235 Standard Constants, Enumerations and Structures

Named Constants
All constants used in MQL5 can be divided into the following groups:

Predefined macrosubstitutions – values are substituted during compilation;


Mathematical constants – values of some mathematical expressions;
Numerical type constants – some of the simple type restrictions;
Uninitialization reason codes – description of uninitialization reasons;
Checking Object Pointer – enumeration of types of pointers returned by the CheckPointer() function;
Other constants – all other constants.

© 2000-2010, MetaQuotes Software Corp.


236 Standard Constants, Enumerations and Structures

Predefined Macrosubstitutions
To simplify the debugging process and obtain information about operation of a mql5-program, there
are special macro constant, values of which are set at the moment of compilation. The easiest way to
use these constants is outputting values by the Print() function, as it's shown in the example.

Constant Description

__LINE__ String number in the source code, in which the


macro is located

__FILE__ Name of the current compiled file

__FUNCTION__ Name of the function, in whose body the macro


is located

__MQ5BUILD__ Compiler build number

Example:

#property copyright "Copyright © 2009, MetaQuotes Software Corp."


#property link "http://www.metaquotes.net"
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- an example of information output at Expert Advisor initialization
Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__);
//--- set the interval between the timer events
EventSetTimer(5);
//---
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- an example of information output at Expert Advisor deinitialization
Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__);
//---
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- information output at tick receipt
Print(" __MQ5BUILD__ =",__MQ5BUILD__," __FILE__ =",__FILE__);

© 2000-2010, MetaQuotes Software Corp.


237 Standard Constants, Enumerations and Structures

Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__);


test1(__FUNCTION__);
test2();
//---
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void test1(string par)
{
//--- information output inside the function
Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__," par=",par);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void test2()
{
//--- information output inside the function
Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__);
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
void OnTimer()
{
//---
Print(" __FUNCTION__ =",__FUNCTION__," __LINE__ =",__LINE__);
test1(__FUNCTION__);
}
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


238 Standard Constants, Enumerations and Structures

Mathematical Constants
Special constants containing values are reserved for some mathematical expressions. These
constants can be used in any place of the program instead of calculating their values using
mathematical functions.

Constant Description Value

M_E e 2.71828182845904523536

M_LOG2E log2(e) 1.44269504088896340736

M_LOG10E log10(e) 0.434294481903251827651

M_LN2 ln(2) 0.693147180559945309417

M_LN10 ln(10) 2.30258509299404568402

M_PI pi 3.14159265358979323846

M_PI_2 pi/2 1.57079632679489661923

M_PI_4 pi/4 0.785398163397448309616

M_1_PI 1/pi 0.318309886183790671538

M_2_PI 2/pi 0.636619772367581343076

M_2_SQRTPI 2/sqrt(pi) 1.12837916709551257390

M_SQRT2 sqrt(2) 1.41421356237309504880

M_SQRT1_2 1/sqrt(2) 0.707106781186547524401

Example:

//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- print the values of constants
Print("M_E =",DoubleToString(M_E,16));
Print("M_LOG2E =",DoubleToString(M_LOG2E,16));
Print("M_LOG10E =",DoubleToString(M_LOG10E,16));
Print("M_LN2 =",DoubleToString(M_LN2,16));
Print("M_LN10 =",DoubleToString(M_LN10,16));
Print("M_PI =",DoubleToString(M_PI,16));
Print("M_PI_2 =",DoubleToString(M_PI_2,16));
Print("M_PI_4 =",DoubleToString(M_PI_4,16));
Print("M_1_PI =",DoubleToString(M_1_PI,16));
Print("M_2_PI =",DoubleToString(M_2_PI,16));
Print("M_2_SQRTPI =",DoubleToString(M_2_SQRTPI,16));
Print("M_SQRT2 =",DoubleToString(M_SQRT2,16));
Print("M_SQRT1_2 =",DoubleToString(M_SQRT1_2,16));

© 2000-2010, MetaQuotes Software Corp.


239 Standard Constants, Enumerations and Structures

© 2000-2010, MetaQuotes Software Corp.


240 Standard Constants, Enumerations and Structures

Numerical Type Constants


Each simple numerical type is intended for a certain type of tasks and allows optimizing the
operation of a mql5-program when used correctly. For a better code readability and correct handling of
calculation results, there are constants which allow to receive information about restrictions set to a
certain type of simple data.

Constant Description Value

CHAR_MIN Minimal value, which can be -128


represented by char type

CHAR_MAX Maximal value, which can be 127


represented by char type

UCHAR_MAX Maximal value, which can be 255


represented by uchar type

SHORT_MIN Minimal value, which can be -32768


represented by short type

SHORT_MAX Maximal value, which can be 32767


represented by short type

USHORT_MAX Maximal value, which can be 65535


represented by ushort type

INT_MIN Minimal value, which can be -2147483648


represented by int type

INT_MAX Maximal value, which can be 2147483647


represented by int type

UINT_MAX Maximal value, which can be 4294967295


represented by uint type

LONG_MIN Minimal value, which can be -9223372036854775808


represented by long type

LONG_MAX Maximal value, which can be 9223372036854775807


represented by long type

ULONG_MAX Maximal value, which can be 18446744073709551615


represented by ulong type

DBL_MIN Minimal positive value, which 2.2250738585072014e-308


can be represented by double
type

DBL_MAX Maximal value, which can be 1.7976931348623158e+308


represented by double type

DBL_EPSILON Minimal value, which satisfies 2.2204460492503131e-016


the condition:
1.0+DBL_EPSILON != 1.0 (for
double type)

DBL_DIG Number of significant decimal 15

© 2000-2010, MetaQuotes Software Corp.


241 Standard Constants, Enumerations and Structures

digits for double type

DBL_MANT_DIG Bits count in a mantissa for 53


double type

DBL_MAX_10_EXP Maximal decimal value of 308


exponent degree for double
type

DBL_MAX_EXP Maximal binary value of 1024


exponent degree for double
type

DBL_MIN_10_EXP Minimal decimal value of (-307)


exponent degree for double
type

DBL_MIN_EXP Minimal binary value of (-1021)


exponent degree for double
type

FLT_MIN Minimal positive value, which 1.175494351e-38


can be represented by float
type

FLT_MAX Maximal value, which can be 3.402823466e+38


represented by float type

FLT_EPSILON Minimal value, which satisfies 1.192092896e–07


the condition:
1.0+DBL_EPSILON != 1.0 (for
float type)

FLT_DIG Number of significant decimal 6


digits for float type

FLT_MANT_DIG Bits count in a mantissa for 24


float type

FLT_MAX_10_EXP Maximal decimal value of 38


exponent degree for float type

FLT_MAX_EXP Maximal binary value of 128


exponent degree for float type

FLT_MIN_10_EXP Minimal decimal value of -37


exponent degree for float type

FLT_MIN_EXP Minimal binary value of (-125)


exponent degree for float type

Example:

void OnStart()
{
//--- print the constant values
printf("CHAR_MIN = %d",CHAR_MIN);

© 2000-2010, MetaQuotes Software Corp.


242 Standard Constants, Enumerations and Structures

printf("CHAR_MAX = %d",CHAR_MAX);
printf("UCHAR_MAX = %d",UCHAR_MAX);
printf("SHORT_MIN = %d",SHORT_MIN);
printf("SHORT_MAX = %d",SHORT_MAX);
printf("USHORT_MAX = %d",USHORT_MAX);
printf("INT_MIN = %d",INT_MIN);
printf("INT_MAX = %d",INT_MAX);
printf("UINT_MAX = %u",UINT_MAX);
printf("LONG_MIN = %I64d",LONG_MIN);
printf("LONG_MAX = %I64d",LONG_MAX);
printf("ULONG_MAX = %I64u",ULONG_MAX);
printf("EMPTY_VALUE = %.16e",EMPTY_VALUE);
printf("DBL_MIN = %.16e",DBL_MIN);
printf("DBL_MAX = %.16e",DBL_MAX);
printf("DBL_EPSILON = %.16e",DBL_EPSILON);
printf("DBL_DIG = %d",DBL_DIG);
printf("DBL_MANT_DIG = %d",DBL_MANT_DIG);
printf("DBL_MAX_10_EXP = %d",DBL_MAX_10_EXP);
printf("DBL_MAX_EXP = %d",DBL_MAX_EXP);
printf("DBL_MIN_10_EXP = %d",DBL_MIN_10_EXP);
printf("DBL_MIN_EXP = %d",DBL_MIN_EXP);
printf("FLT_MIN = %.8e",FLT_MIN);
printf("FLT_MAX = %.8e",FLT_MAX);
printf("FLT_EPSILON = %.8e",FLT_EPSILON);
}

© 2000-2010, MetaQuotes Software Corp.


243 Standard Constants, Enumerations and Structures

Uninitalization Reason Codes


Uninitalization reason codes are returned by the UninitializeReason() function. The possible values
are the following:

Constant Value Description

REASON_PROGRAM 0 Expert Advisor terminated its


operation by calling the
ExpertRemove() function

REASON_REMOVE 1 Program has been deleted


from the chart

REASON_RECOMPILE 2 Program has been recompiled

REASON_CHARTCHANGE 3 Symbol or chart period has


been changed

REASON_CHARTCLOSE 4 Chart has been closed

REASON_PARAMETERS 5 Input parameters have been


changed by a user

REASON_ACCOUNT 6 A new account has been


activated

REASON_TEMPLATE 7 A new template has been


applied

REASON_INITFAILED 8 This value means that OnInit()


handler has returned a nonzero
value.

The uninitialization reason code is also passed as a parameter of the predetermined function
OnDeinit(const int reason).

Example:

input int par=7;


//+------------------------------------------------------------------+
//| get text description |
//+------------------------------------------------------------------+
string getUnitReasonText(int reasonCode)
{
string text="";
//---
switch(reasonCode)
{
case REASON_ACCOUNT:
text="Account was changed";break;
case REASON_CHARTCHANGE:
text="Symbol or timeframe was changed";break;
case REASON_CHARTCLOSE:

© 2000-2010, MetaQuotes Software Corp.


244 Standard Constants, Enumerations and Structures

text="Chart was closed";break;


case REASON_PARAMETERS:
text="Input-parameter was changed";break;
case REASON_RECOMPILE:
text="Program "+__FILE__+" was recompiled";break;
case REASON_REMOVE:
text="Program "+__FILE__+" was removed from chart";break;
case REASON_TEMPLATE:
text="New template was applied to chart";break;
default:text="Another reason";
}
//---
return text;
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//--- The first way to get the uninitalization reason code
Print(__FUNCTION__,"_Uninitalization reason code =",reason);
//--- The second way to get the uninitalization reason code
Print(__FUNCTION__,"_UninitReason =",getUnitReasonText(_UninitReason));
}

© 2000-2010, MetaQuotes Software Corp.


245 Standard Constants, Enumerations and Structures

Checking Object Pointer


The CheckPointer() function is used for checking the type of the object pointer. The function
returns a value of the ENUM_POINTER_TYPE enumeration. If an incorrect pointer is used, the program
execution will be immediately terminated.

Objects created by the new() operator are of POINTER_DYNAMIC type. The delete() operator can and
should be used only for such pointers.

All other pointers are of POINTER_AUTOMATIC type, which means that this object has been created
automatically by the mql5 program environment. Such objects are deleted automatically after being
used.

ENUM_POINTER_TYPE

Constant Description

POINTER_INVALID Incorrect pointer

POINTER_DYNAMIC Pointer of the object created by the new()


operator

POINTER_AUTOMATIC Pointer of any objects created automatically


(not using new())

See also
Runtime errors, Object Delete Operator delete, CheckPointer

© 2000-2010, MetaQuotes Software Corp.


246 Standard Constants, Enumerations and Structures

Other Constants
The CLR_NONE constant is used to outline the absence of color, it means that the graphical object
or graphical series of an indicator will not be plotted. This constant was not included into the Web-
color constants list, but it can be applied everywhere where the color arguments are required.

The INVALID_HANDLE constant can be used for checking file handles (see FileOpen() and
FileFindFirst()).

Constant Description Value

CHARTS_MAX The maximum possible 100


number of simultaneously
open charts in the terminal

CLR_NONE Absence of color -1

EMPTY_VALUE Empty value in an indicator DBL_MAX


buffer

INVALID_HANDLE Incorrect handle -1

IS_DEBUG_MODE Flag that a mq5-program true in debug mode, otherwise


operates in debug mode false

NULL Zero for any types 0

WHOLE_ARRAY Means the number of items -1


remaining until the end of the
array, i.e., the entire array
will be processed

WRONG_VALUE The constant can be implicitly -1


cast to any enumeration type

The EMPTY_VALUE constant usually corresponds to the values of indicators that are not shown inn
the chart. For example, for built-in indicator Standard Deviation with a period of 20, the line for the
first 19 bars in the history is not shown in the chart. If you create a handle of this indicator with the
iStdDev() function and copy it to an array of indicator values for these bars through CopyBuffer(), then
these values will be equal to EMPTY_VALUE.

You can choose to specify for a custom indicator your own empty value of the indicator, when the
indicator shouldn't be drawn in the chart. Use the PlotIndexSetDouble() function with the
PLOT_EMPTY_VALUE modifier.

The NULL constant can be assigned to a variable of any simple type or to an object structure or
class pointer. The NULL assignment for a string variable means the full deinitialization of this
variable.

The WRONG_VALUE constant is intended for cases, when it is necessary to return value of an
enumeration, and this must be a wrong value. For example, when we need to inform that a return
value is a value from this enumeration. Let's consider as an example some function CheckLineStyle(),
which returns the line style for an object, specified by its name. If at style check by ObjectGetInteger
() the result is true, a value from ENUM_LINE_STYLE is returned; otherwise WRONG_VALUE is
returned.

© 2000-2010, MetaQuotes Software Corp.


247 Standard Constants, Enumerations and Structures

void OnStart()
{
if(CheckLineStyle("MyChartObject")==WRONG_VALUE)
printf("Error line style getting.");
}
//+------------------------------------------------------------------+
//| returns the line style for an object specified by its name |
//+------------------------------------------------------------------+
ENUM_LINE_STYLE CheckLineStyle(string name)
{
long style;
//---
if(ObjectGetInteger(0,name,OBJPROP_STYLE,0,style))
return((ENUM_LINE_STYLE)style);
else
return(WRONG_VALUE);
}

The WHOLE_ARRAY constant is intended intended for functions that require specifying the number
of elements in processed arrays:

ArrayCopy();
ArrayMinimum();
ArrayMaximum();
FileReadArray();
FileWriteArray().
If you want to specify, that all the array values from a specified position till the end must be
processed, you should specify just the WHOLE_ARRAY value.

The IS_DEBUG_MODE constant can be useful when you need to slightly change the operation of a
mql5 program in the debugging mode. For example, in debug mode you may need to display additional
debugging information in the terminal log or create additional graphical objects in a chart.

The following example creates a Label object and sets its description and color depending on the
script running mode. In order to run a script in the debug mode from MetaEditor, press F5. If you run
the script from the browser window in the terminal, then the color and text of the object Label will be
different.

Example:

//+------------------------------------------------------------------+
//| Check_DEBUG_MODE.mq5 |
//| Copyright © 2009, MetaQuotes Software Corp. |
//| http://www.metaquotes.net |
//+------------------------------------------------------------------+
#property copyright "Copyright © 2009, MetaQuotes Software Corp."
#property link "http://www.metaquotes.net"
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


248 Standard Constants, Enumerations and Structures

//| Script program start function |


//+------------------------------------------------------------------+
void OnStart()
{
//---
string label_name="invisible_label";
if(ObjectFind(0,label_name)<0)
{
Print("Object",label_name,"not found. Error code =",GetLastError());
//--- create Label
ObjectCreate(0,label_name,OBJ_LABEL,0,0,0);
//--- set X coordinate
ObjectSetInteger(0,label_name,OBJPROP_XDISTANCE,200);
//--- set Y coordinate
ObjectSetInteger(0,label_name,OBJPROP_YDISTANCE,300);
ResetLastError();
if(IS_DEBUG_MODE) // debug mode
{
//--- show message about the script execution mode
ObjectSetString(0,label_name,OBJPROP_TEXT,"DEBUG MODE");
//--- set text color to red
if(!ObjectSetInteger(0,label_name,OBJPROP_COLOR,Red))
Print("Unable to set the color. Error",GetLastError());
}
else // operation mode
{
ObjectSetString(0,label_name,OBJPROP_TEXT,"RELEASE MODE");
//--- set text color to invisible
if(!ObjectSetInteger(0,label_name,OBJPROP_COLOR,CLR_NONE))
Print("Unable to set the color. Error",GetLastError());
}
ChartRedraw();
DebugBreak(); // here termination will occur, if we are in debug mode
}
}

See also
DebugBreak, Executed MQL program properties

© 2000-2010, MetaQuotes Software Corp.


249 Standard Constants, Enumerations and Structures

Data Structures
MQL5 Language offers 5 predefined structures:

MqlDateTime is intended for working with date and time;


MqlParam can send input parameters when creating a handle of the indicator using the
IndicatorCreate() function;
MqlRates is intended for manipulating the historical data, it contains information about the price,
volume and spread;
MqlBookInfo is intended for obtaining information about the Depth of Market;
MqlTradeRequest is used for creating a trade request for trade operations;
MqlTradeResult contains a trade server reply to a trade request, sent by OrderSend() function;
MqlTick is designed for fast retrieval of the most requested information about current prices.

© 2000-2010, MetaQuotes Software Corp.


250 Standard Constants, Enumerations and Structures

MqlDateTime
The date type structure contains eight fields of the int type:
struct MqlDateTime
{
int year; // Year
int mon; // Month
int day; // Day
int hour; // Hour
int min; // Minutes
int sec; // Seconds
int day_of_week; // Day of week (0-sunday, 1-monday)
int day_of_year; // Day number of the year (for example, the 1st of February is the 32nd day of
};

Note

The day number of the year day_of_year for the leap year, since March, will differ from a number of
the corresponding day for a non-leap year.

Example:

void OnStart()
{
//---
datetime date1=D'2008.03.01';
datetime date2=D'2009.03.01';

MqlDateTime str1,str2;
TimeToStruct(date1,str1);
TimeToStruct(date2,str2);
printf("%02d.%02d.%4d, day of year = %d",str1.day,str1.mon,
str1.year,str1.day_of_year);
printf("%02d.%02d.%4d, day of year = %d",str2.day,str2.mon,
str2.year,str2.day_of_year);
}
/* Result:
01.03.2008, day of year = 60
01.03.2009, day of year = 59
*/

See also

TimeToStruct, Structures and Classes

© 2000-2010, MetaQuotes Software Corp.


251 Standard Constants, Enumerations and Structures

The Structure of Input Parameters of Indicators (MqlParam)


The MqlParam structure has been specially designed to provide input parameters when creating the
handle of a technical indicator using the IndicatorCreate() function.
struct MqlParam
{
ENUM_DATATYPE type; // type of the input parameter, value of ENUM_DATATYPE
long integer_value; // field to store an integer type
double double_value; // field to store a double type
string string_value; // field to store a string type
};

All input parameters of an indicator are transmitted in the form of an array of the MqlParam type,
the type field of each element of this array specifies the type of data transmitted by the element. The
indicator values must be first placed in the appropriate fields for each element (in integer_value, in
double_value or string_value) depending on what value of ENUM_DATATYPE enumeration is specified
in the type field.

If the IND_CUSTOM value is passed third as the indicator type to the IndicatorCreate() function, the
first element of the array of input parameters must have the type field with the value of TYPE_STRING
from the ENUM_DATATYPE enumeration, and the string_value field must contain the name of the
custom indicator.

© 2000-2010, MetaQuotes Software Corp.


252 Standard Constants, Enumerations and Structures

MqlRates
This structure stores information about the prices, volumes and spread.
struct MqlRates
{
datetime time; // Period start time
double open; // Open price
double high; // The highest price of the period
double low; // The lowest price of the period
double close; // Close price
long tick_volume; // Tick volume
int spread; // Spread
long volume; // Trade volume
};

Example:

void OnStart()
{
MqlRates rates[];
int copied=CopyRates(NULL,0,0,100,rates);
if(copied<=0)
Print("Error copying price data",GetLastError());
else Print("Copied",ArraySize(rates),"bars");
}

See also

CopyRates, Access to timeseries

© 2000-2010, MetaQuotes Software Corp.


253 Standard Constants, Enumerations and Structures

MqlBookInfo
It provides information about the market depth data.
struct MqlBookInfo
{
ENUM_BOOK_TYPE type; // Order type from ENUM_BOOK_TYPE enumeration
double price; // Price
long volume; // Volume
};

Note

The DOM is available only for some symbols. To use the MqlBookInfo structure, it is sufficient to
declare a variable of such a type, so it is not necessary to specify and describe it specially.

Example:

MqlBookInfo priceArray[];
bool getBook=MarketBookGet(NULL,priceArray);
if(getBook)
{
int size=ArraySize(priceArray);
Print("MarketBookInfo about ",Symbol());
}
else
{
Print("Failed to receive DOM for the symbol ",Symbol());
}

See also

MarketBookAdd, MarketBookRelease, MarketBookGet, Trade Orders in DOM, Data Types

© 2000-2010, MetaQuotes Software Corp.


254 Standard Constants, Enumerations and Structures

The Trade Request Structure (MqlTradeRequest)


Interaction between the client terminal and a trade server for executing the order placing operation,
is performed by using trade requests. The trade request is represented by the special predefined
structure of MqlTradeRequest type, which contain all the fields necessary to perform trade deals. The
request processing result is represented by the structure of MqlTradeResult type.

struct MqlTradeRequest
{
ENUM_TRADE_REQUEST_ACTIONS action; // Trade operation type
ulong magic; // Expert Advisor ID (magic number)
ulong order; // Order ticket
string symbol; // Trade symbol
double volume; // Requested volume for a deal in lots
double price; // Price
double stoplimit; // StopLimit level of the order
double sl; // Stop Loss level of the order
double tp; // Take Profit level of the order
ulong deviation; // Maximal possible deviation from the requested p
ENUM_ORDER_TYPE type; // Order type
ENUM_ORDER_TYPE_FILLING type_filling; // Order execution type
ENUM_ORDER_TYPE_TIME type_time; // Order execution time
datetime expiration; // Order expiration time (for the orders of ORDER_
string comment; // Order comment
};

Fields description

Field Description

action Trade operation type. Can be one of the


ENUM_TRADE_REQUEST_ACTIONS enumeration
values.

magic Expert Advisor ID. It allows organizing


analytical processing of trade orders. Each
Expert Advisor can set its own unique ID when
sending a trade request.

order Order ticket. It is used for modifying pending


orders.

symbol Symbol of the order. It is not necessary for


order modification and position close
operations.

volume Requested order volume in lots. Note that the


real volume of a deal will depend on the order
execution type.

price Price, reaching which the order must be


executed. Market orders of symbols, whose
execution type is "Market Execution" (
SYMBOL_TRADE_EXECUTION_MARKET), of

© 2000-2010, MetaQuotes Software Corp.


255 Standard Constants, Enumerations and Structures

TRADE_ACTION_DEAL type, do not require


specification of price.

stoplimit The price value, at which the StopLimit pending


order will be placed, when price reaches the
price value (this condition is obligatory). Until
then the pending order is not placed).

sl Stop Loss price in case of the unfavorable price


movement

tp Take Profit price in the case of the favorable


price movement

deviation The maximal price deviation, specified in


points

type Order type. Can be one of the


ENUM_ORDER_TYPE enumeration values.

type_filling Order execution type. Can be one of the


enumeration ENUM_ORDER_TYPE_FILLING
values.

type_time Order execution type. Can be one of the


enumeration ENUM_ORDER_TYPE_TIME values.

expiration Order expiration time (for orders of


ORDER_TIME_SPECIFIED type)

comment Order comment

For sending orders to perform trade operations it is necessary to use the OrderSend() function. For
each trade operation it is necessary to specify obligatory fields; optional fields also may be filled.
There are seven possible cases to send a trade order:

Request Execution

This is a trade order to open a position in the Request Execution mode (trade upon current prices
request). It requires to specify the following 9 fields:
action
symbol
volume
price
sl
tp
deviation
type
type_filling

Also it is possible to specify the "magic" and "comment" field values.

Instant Execution

This is a trade order to open a position in the Instant Execution mode (trade by flow prices). It

© 2000-2010, MetaQuotes Software Corp.


256 Standard Constants, Enumerations and Structures

requires specification of the following 9 fields:


action
symbol
volume
price
sl
tp
deviation
type
type_filling

Also it is possible to specify the "magic" and "comment" field values.

Market Execution

This is a trade order to open a position in the Market Execution mode. It requires to specify the
following 5 fields:
action
symbol
volume
type
type_filling

Also it is possible to specify the "magic" and "comment" field values.

SL & TP Modification

Trade order to modify the StopLoss and/or TakeProfit price levels. It requires to specify the
following 5 fields:
action
symbol
sl
tp
deviation

Pending Order

Trade order to place a pending order. It requires to specify the following 11 fields:
action
symbol
volume
price
stoplimit
sl
tp
type
type_filling
type_time
expiration

© 2000-2010, MetaQuotes Software Corp.


257 Standard Constants, Enumerations and Structures

Also it is possible to specify the "magic" and "comment" field values.

Modify Pending Order

Trade order to modify the prices of a pending order. It requires to specify the following 7 fields:
action
order
price
sl
tp
type_time
expiration

Delete Pending Order

Trade order to delete a pending order. It requires to specify the following 2 fields:
action
order

See also

Structures and Classes, Trade Functions, Order Properties

© 2000-2010, MetaQuotes Software Corp.


258 Standard Constants, Enumerations and Structures

Structure of a Trade Request Result (MqlTradeResult)


As result of a trade request, a trade server returns data about the trade request processing result
as a special predefined structure of MqlTradeResult type.

struct MqlTradeResult
{
uint retcode; // Operation return code
ulong deal; // Deal ticket, if it is performed
ulong order; // Order ticket, if it is placed
double volume; // Deal volume, confirmed by broker
double price; // Deal price, confirmed by broker
double bid; // Current Bid price
double ask; // Current Ask price
string comment; // Broker comment to operation (by default it is filled by the operatio
};

Fields description

Field Description

retcode Return code of a trade server

deal Deal ticket, if a deal has been performed. It is


available for a trade operation of
TRADE_ACTION_DEAL type

order Order ticket, if a ticket has been placed. It is


available for a trade operation of
TRADE_ACTION_PENDING type

volume Deal volume, confirmed by broker. It depends


on the order filling type

price Deal price, confirmed by broker. It dependens


on the deviation field of the trade request and/
or on the trade operation

bid The current market Bid price (requote price)

ask The current market Ask price (requote price)

comment The broker comment to operation (by default it


is filled by the operation description)

The trade operation result is returned to a variable of the MqlTradeResult type, which is passed as
the second parameter to OrderSend() to perform a trade operations.

Example:

© 2000-2010, MetaQuotes Software Corp.


259 Standard Constants, Enumerations and Structures

//+------------------------------------------------------------------+
//| Sending a trade request with the result processing |
//+------------------------------------------------------------------+
bool MyOrderSend(MqlTradeRequest request,MqlTradeResult result)
{
//--- reset the last error code to zero
ResetLastError();
//--- send request
bool success=OrderSend(request,result);
//--- if the result fails - try to find out why
if(!success)
{
int answer=result.retcode;
Print("TradeLog:Trade request failed. Error =",GetLastError());
switch(answer)
{
//--- requote
case 10004:
{
Print("TRADE_RETCODE_REQUOTE");
Print("request.price =",request.price," result.ask =",
result.ask," result.bid =",result.bid);
break;
}
//--- order is not accepted by the server
case 10006:
{
Print("TRADE_RETCODE_REJECT");
Print("request.price =",request.price," result.ask =",
result.ask," result.bid =",result.bid);
break;
}
//--- invalid price
case 10015:
{
Print("TRADE_RETCODE_INVALID_PRICE");
Print("request.price =",request.price," result.ask =",
result.ask," result.bid =",result.bid);
break;
}
//--- invalid SL and/or TP
case 10016:
{
Print("TRADE_RETCODE_INVALID_STOPS");
Print("request.sl =",request.sl," request.tp =",request.tp);
Print("result.ask =",result.ask," result.bid =",result.bid);
break;
}
//--- invalid volume
case 10014:
{
Print("TRADE_RETCODE_INVALID_VOLUME");
Print("request.volume =",request.volume," result.volume =",
result.volume);
break;
}
//--- not enough money for a trade operation
case 10019:
{
Print("TRADE_RETCODE_NO_MONEY");
Print("request.volume =",request.volume," result.volume =",

© 2000-2010, MetaQuotes Software Corp.


260 Standard Constants, Enumerations and Structures

result.volume," result.comment =",result.comment);


break;
}
//--- some other reason, output the server response code
default:
{
Print("Other answer =",answer);
}
}
//--- notify about the unsuccessful result of the trade request by returning false
return(false);
}
//--- OrderSend () returns true - repeat the answer
return(true);
}

© 2000-2010, MetaQuotes Software Corp.


261 Standard Constants, Enumerations and Structures

Structure for Returning Current Prices (MqlTick)


This is a structure for storing the latest prices of the symbol. It is designed for fast retrieval of the
most requested information about current prices.
struct MqlTick
{
datetime time; // Time of the last prices update
double bid; // Current Bid price
double ask; // Current Ask price
double last; // Price of the last deal (Last)
ulong volume; // Volume for the current Last price
};

The variable of the MqlTick type allows obtaining values of Ask, Bid, Last and Volume within a
single call of the SymbolInfoTick() function.

Example:

void OnTick()
{
MqlTick last_tick;
//---
if(SymbolInfoTick(Symbol(),last_tick))
{
Print(last_tick.time,": Bid =",last_tick.bid,
" Ask =",last_tick.ask," Volume =",last_tick.volume);
}
else Print("SymbolInfoTick() failed, error =",GetLastError());
//---
}

See also

Structures and Classes

© 2000-2010, MetaQuotes Software Corp.


262 Standard Constants, Enumerations and Structures

Codes of Errors and Warnings


This section contains the following descriptions:

Return codes of the trade server – analyzing results of the trade request sent by function OrderSend
();
Compiler warnings – codes of warning messages that appear at compilation (not errors);
Compilation errors – codes of error messages at an unsuccessful attempt to compile;
Runtime errors – error codes in the performance of mql5-programs, which can be obtained using the
GetLastErtror() function.

© 2000-2010, MetaQuotes Software Corp.


263 Standard Constants, Enumerations and Structures

Return Codes of the Trade Server

Code Constant Description

10004 TRADE_RETCODE_REQUOTE Requote

10006 TRADE_RETCODE_REJECT Request rejected

10007 TRADE_RETCODE_CANCEL Request canceled by trader

10008 TRADE_RETCODE_PLACED Order placed

10009 TRADE_RETCODE_DONE Request is completed

10010 TRADE_RETCODE_DONE_PARTI Request is partially completed


AL

10011 TRADE_RETCODE_ERROR Request processing error

10012 TRADE_RETCODE_TIMEOUT Request canceled by timeout

10013 TRADE_RETCODE_INVALID Invalid request

10014 TRADE_RETCODE_INVALID_VOL Invalid volume in the request


UME

10015 TRADE_RETCODE_INVALID_PRI Invalid price in the request


CE

10016 TRADE_RETCODE_INVALID_STO Invalid stops in the request


PS

10017 TRADE_RETCODE_TRADE_DISA Trade is disabled


BLED

10018 TRADE_RETCODE_MARKET_CL Market is closed


OSED

10019 TRADE_RETCODE_NO_MONEY There is not enough money to


fulfill the request

10020 TRADE_RETCODE_PRICE_CHAN Prices changed


GED

10021 TRADE_RETCODE_PRICE_OFF There are no quotes to process


the request

10022 TRADE_RETCODE_INVALID_EXP Invalid order expiration date of


IRATION in the request

10023 TRADE_RETCODE_ORDER_CHA Order state changed


NGED

10024 TRADE_RETCODE_TOO_MANY_ Too frequent requests


REQUESTS

10025 TRADE_RETCODE_NO_CHANGE No changes in request


S

© 2000-2010, MetaQuotes Software Corp.


264 Standard Constants, Enumerations and Structures

10026 TRADE_RETCODE_SERVER_DIS Autotrading disabled by server


ABLES_AT

10027 TRADE_RETCODE_CLIENT_DISA Autotrading disabled by client


BLES_AT terminal

10028 TRADE_RETCODE_LOCKED Request locked for processing

10029 TRADE_RETCODE_FROZEN Order or position frozen

© 2000-2010, MetaQuotes Software Corp.


265 Standard Constants, Enumerations and Structures

Compiler Warnings
Compiler warnings are shown for informational purposes only and are not error messages.

Code Description

21 Incomplete record of a date in the datetime


string

22 Wrong number in the datetime string for the


date. Requirements:
Year 1970 <= X <= 3000
Month 0 <X <= 12
Day 0 <X <= 31/30/28 (29 )....

23 Wrong number of datetime string for time.


Requirements:
Hour 0 <= X <24
Minute 0 <= X <60

24 Invalid color in RGB format: one of RGB


components is less than 0 or greater than 255

25 Unknown character of the escape sequences.


Known: \ n \ r \ t \ \ \ "\ '\ X \ x

29 Enumeration already defined (duplication) -


members will be added to the first definition

30 Overriding macro

32 Constructor must be of void type

33 Destructor must be of void type

34 Constant does not fit in the range of integers


(X> _UI64_MAX | | X <_I64_MIN) and will be
converted to the double type

35 Too long HEX - more than 16 significant


characters (senior nibbles are cut)

36 No nibbles in HEX string "0x"

37 No function - nothing to be performed

41 Function has no body, and is not called

43 Possible loss of data at typecasting. Example:


int x = (double) z;

44 Loss of accuracy (of data) when converting a


constant. Example: int x = M_PI

45 Difference between the signs of operands in the


operations of comparison. Example: (char) c1>
(uchar) c2

© 2000-2010, MetaQuotes Software Corp.


266 Standard Constants, Enumerations and Structures

46 Problems with function importing - declaration


of #import is required or import of functions is
closed

47 Too large description - extra characters will not


be included in the executable file

48 The number of indicator buffers declared is less


than required

49 No color to plot a graphical series in the


indicator

50 No graphical series to draw the indicator

51 'OnStart' handler function not found in the


script

52 'OnStart' handler function is defined with wrong


parameters

53 'OnStart' function can be defined only in a script

54 'OnInit' function is defined with wrong


parameters

55 'OnInit' function is not used in scripts

56 'OnDeinit' function is defined with wrong


parameters

57 'OnDeinit' function is not used in scripts

58 Two 'OnCalculate' functions are defined.


OnCalculate () at one price array will be used

© 2000-2010, MetaQuotes Software Corp.


267 Standard Constants, Enumerations and Structures

Compilation Errors
MetaEdtior 5 shows error messages about the program errors detected by the built-in compiler
during compilation. The list of these errors is given below in table. To compile a source code into an
executable one, press F7. Programs that contain errors cannot be compiled until the errors identified
by the compiler are eliminated.

Code Description

100 File reading error

101 Error of *. EX5 file opening to write it for


saving

103 Not enough free memory to complete


compilation

104 Empty syntactic unit unrecognized by compiler

105 Incorrect file name in #include

106 Error accessing a file in #include (probably the


file does not exist)

108 Inappropriate name for #define

109 Unknown command of preprocessor (valid


#include, #define, #property, #import)

110 Symbol unknown to compiler

111 Function not implemented (description is


present, but no body)

112 Double quote (") omitted

113 Opening angle bracket (<) or double quote (")


omitted

114 Single quote (') omitted

115 Closing angle bracket ">" omitted

116 Type not specified in declaration

117 No return operator or return is found not in all


branches of the implementation

118 Opening bracket of call parameters was


expected

119 Error writing EX5

120 Invalid access to an array

121 The function is not of void type and the return


operator must return a value

122 Incorrect declaration of the destructor

© 2000-2010, MetaQuotes Software Corp.


268 Standard Constants, Enumerations and Structures

123 Colon ":" is missing

124 Variable is already declared

125 Variable with such identifier already declared

126 Variable name is too long (> 250 characters)

127 Structure with such identifier already defined

128 Structure is not defined

129 Structure member with the same name already


defined

130 No such structure member

131 Breached pairing of brackets

132 Opening parenthesis "(" expected

133 Unbalanced braces (no "}")

134 Difficult to compile (too much branching,


internal stack levels is overfilled)

135 Error of file opening for reading

136 Not enough memory to download the source file


into memory

137 Variable is expected

138 Reference cannot be initialized

140 Assignment expected (appears at declaration)

141 Opening brace "{" expected

143 Use of "void" type is unacceptable

144 No pair for ")" or "]", i.e. "(or" [ " is absent

145 No pair for "(or" [ ", i.e. ") "or"] " is absent

146 Incorrect array size

147 Too many parameters (> 64)

149 This token is not expected here

150 Invalid use of operation (invalid operands)

151 Expression of void type not allowed

152 Operator is expected

153 Misuse of break

154 Semicolon ";" expected

155 Comma "," expected

157 Expression is expected

© 2000-2010, MetaQuotes Software Corp.


269 Standard Constants, Enumerations and Structures

158 "non HEX character" found in HEX or too long


number (number of digits> 511)

159 String-constant has more than 65534 characters

160 Function definition is unacceptable here

161 Unexpected end of program

163 Function with this name is already defined and


has another return type

164 Function with this name is already defined and


has a different set of parameters

165 Function with this name is already defined and


implemented

166 Function overload for this call was not found

167 Function with a return value of void type cannot


return a value

168 Function is not defined

170 Value is expected

171 In case expression only integer constants are


valid

172 The value of case in this switch is already used

173 Integer is expected

174 In #import expression file name is expected

175 Expressions are not allowed on global level

176 Omitted parenthesis ")" before ";"

177 To the left of equality sign a variable is


expected

178 The result of expression is not used

179 Declaring of variables is not allowed in case

180 Implicit conversion from a string to a number

181 Implicit conversion of a number to a string

182 Ambiguous call of an overloaded function


(several overloads fit)

183 Illegal else without proper if

184 Invalid case or default without a switch

185 Inappropriate use of ellipsis

186 The initializing sequence has more elements


than the initialized variable

© 2000-2010, MetaQuotes Software Corp.


270 Standard Constants, Enumerations and Structures

187 A constant for case expected

188 A constant expression required

189 A constant variable can not be changed

190 Closing bracket or a comma is expected


(declaring array member)

192 Enumeration cannot have access modifiers


(const, extern, static)

193 Enumeration member already declared with a


different value

194 There is a variable defined with the same name

195 There is a structure defined with the same


name

196 Name of enumeration member expected

197 Integer expression expected

198 Division by zero in constant expression

199 Wrong number of parameters in the function

200 Parameter by reference must be a variable

201 Variable of the same type to pass by reference


expected

202 A constant variable cannot be passed by a non-


constant reference

203 Requires a positive integer constant

204 Failed to access protected class member

205 Import already defined in another way

208 Executable file not created

209 'OnCalculate' entry point not found for the


indicator

210 The continue operation can be used only inside


a loop

211 Error accessing private (closed) class member

213 Method of structure or class is not declared

214 Error accessing private (closed) class method

216 Copying of structures with objects is not


allowed

218 Index out of array range

219 Array initialization in structure or class

© 2000-2010, MetaQuotes Software Corp.


271 Standard Constants, Enumerations and Structures

declaration not allowed

220 Class constructor cannot have parameters

221 Class destructor can not have parameters

222 Class method or structure with the same name


and parameters have already been declared

223 Operand expected

224 Class method or structure with the same name


exists, but with different parameters
(declaration!=implementation)

225 Imported function is not described

227 Ambiguous call of the overloaded function


(exact match of parameters for several
overloads)

228 Variable name expected

229 A reference cannot be declared in this place

230 Already used as the enumeration name

232 Class or structure expected

235 Cannot call 'delete' operator to delete the array

236 Operator ' while' expected

237 Operator 'delete' must have a pointer

238 There is 'default' for this 'switch' already

239 Syntax error

240 Escape-sequence can occur only in strings


(starts with '\')

241 Array required - square bracket '[' does not


apply to an array, or non arrays are passed as
array parameters

242 Can not be initialized through the initialization


sequence

243 Import is not defined

244 Optimizer error on the syntactic tree

245 Declared too many structures (try to simplify


the program)

246 Conversion of the parameter is not allowed

247 Incorrect use of the 'delete' operator

248 It's not allowed to declare a pointer to a

© 2000-2010, MetaQuotes Software Corp.


272 Standard Constants, Enumerations and Structures

reference

249 It's not allowed to declare a reference to a


reference

250 It's not allowed to declare a pointer to a pointer

251 Structure declaration in the list of parameter is


not allowed

252 Invalid operation of typecasting

253 A pointer can be declared only for a class or


structure

255 Forward-definition is not supported

256 Undeclared identifier

257 Executable code optimizer error

258 Executable code generation error

259 Too large volume of local variables (> 512Kb) of


the function, reduce the number

260 Invalid expression for the 'switch' operator

261 Pool of string constants overfilled, simplify


program

262 Cannot convert to enumeration

263 Do not use 'virtual' for data (members of a class


or structure)

264 Cannot call protected method of class

265 Overridden virtual functions returns a different


type

266 Class cannot be inherited from a structure

267 Structure cannot be inherited from a class

268 Constructor cannot be virtual (virtual specifier


is not allowed)

269 Structure cannot have virtual methods

270 Function must have a body

271 Overloading of system functions (terminal


functions) is prohibited

272 Const specifier is invalid for functions that are


not members of a class or structure

273 Not allowed to use const for data (members of


a class or structure)

© 2000-2010, MetaQuotes Software Corp.


273 Standard Constants, Enumerations and Structures

274 Not allowed to change class members in


constant method

275 Not allowed to declare more than 64 input


parameters (input-variables)

276 Inappropriate initialization sequence

277 Missed default value for the parameter


(specific declaration of default parameters)

278 Overriding the default parameter (different


values in declaration and implementation)

279 Not allowed to call non-constant method for a


constant object

280 An object is necessary for accessing members


(a point for a non class/structure is set)

281 The name of an already declared structure


cannot be used in declaration

282 Structure name cannot be used as the name of


a class member

283 Incorrect type or combination of parameters for


the 'OnCalculate' entry point

284 Unauthorized conversion (at closed inheritance)

285 Structures and arrays cannot be used as input


variables

286 Const specifier is not valid for constructor/


destructor

287 Incorrect string expression for a datetime

288 Unknown property (#property)

289 Incorrect value of a property

290 Invalid index for a property in #property

291 Call parameter omitted - <func (x,)>

293 Object must be passed by reference

294 Array must be passed by reference

295 Function was declared as exportable

296 Function was not declared as exportable

297 It is prohibited to export imported function

298 Imported function cannot have this parameter


(prohibited to pass a pointer, class or structure
containing a dynamic array, pointer, class,

© 2000-2010, MetaQuotes Software Corp.


274 Standard Constants, Enumerations and Structures

etc.)

299 Must be a class

300 #import was not closed

301 Initialize sequence expected

302 Type missmatch

303 Extern variable is already initialized

304 No exported function or entry point found

© 2000-2010, MetaQuotes Software Corp.


275 Standard Constants, Enumerations and Structures

Runtime Errors
GetLastError() is the function that returns the last error code that is stored in the predefined
variable _LastError. This value can be reset to zero by the ResetLastError() function.

Constant Code Description

ERR_INTERNAL_ERROR 4001 Unexpected internal error

ERR_WRONG_INTERNAL_PARA 4002 Wrong parameter in the inner


METER call of the client terminal
function

ERR_INVALID_PARAMETER 4003 Wrong parameter when calling


the system function

ERR_NOT_ENOUGH_MEMORY 4004 Not enough memory to


perform the system function

ERR_STRUCT_WITHOBJECTS_ 4005 The structure contains objects


ORCLASS of strings and/or dynamic
arrays and/or structure of
such objects and/or classes

ERR_INVALID_ARRAY 4006 Array of a wrong type, wrong


size, or a damaged object of a
dynamic array

ERR_ARRAY_RESIZE_ERROR 4007 Not enough memory for the


relocation of an array, or an
attempt to change the size of
a static array

ERR_STRING_RESIZE_ERROR 4008 Not enough memory for the


relocation of string

ERR_NOTINITIALIZED_STRING 4009 Not initialized string

ERR_INVALID_DATETIME 4010 Invalid date and/or time

ERR_ARRAY_BAD_SIZE 4011 Requested array size exceeds


2 GB

ERR_INVALID_POINTER 4012 Wrong pointer

ERR_INVALID_POINTER_TYPE 4013 Wrong type of pointer

ERR_FUNCTION_NOT_ALLOWE 4014 System function is not allowed


D to call

Charts

ERR_CHART_WRONG_ID 4101 Wrong chart ID

ERR_CHART_NO_REPLY 4102 Chart does not respond

ERR_CHART_NOT_FOUND 4103 Chart not found

© 2000-2010, MetaQuotes Software Corp.


276 Standard Constants, Enumerations and Structures

ERR_CHART_NO_EXPERT 4104 No Expert Advisor in the chart


that could handle the event

ERR_CHART_CANNOT_OPEN 4105 Chart opening error

ERR_CHART_CANNOT_CHANG 4106 Failed to change chart symbol


E and period

ERR_CHART_WRONG_TIMER_ 4107 Wrong parameter for timer


PARAMETER

ERR_CHART_CANNOT_CREATE 4108 Failed to create timer


_TIMER

ERR_CHART_WRONG_PROPER 4109 Wrong chart property ID


TY

ERR_CHART_SCREENSHOT_FA 4110 Error creating screenshots


ILED

ERR_CHART_NAVIGATE_FAILE 4111 Error navigating through chart


D

ERR_CHART_TEMPLATE_FAILE 4112 Error applying template


D

ERR_CHART_WINDOW_NOT_F 4113 Subwindow containing the


OUND indicator was not found

Graphical Objects

ERR_OBJECT_ERROR 4201 Error working with a graphical


object

ERR_OBJECT_NOT_FOUND 4202 Graphical object was not found

ERR_OBJECT_WRONG_PROPER 4203 Wrong ID of a graphical object


TY property

ERR_OBJECT_GETDATE_FAILE 4204 Unable to get date


D corresponding to the value

ERR_OBJECT_GETVALUE_FAIL 4205 Unable to get value


ED corresponding to the date

MarketInfo

ERR_MARKET_UNKNOWN_SYM 4301 Unknown symbol


BOL

ERR_MARKET_SELECT_ERROR 4302 Symbol is not selected in


MarketWatch

ERR_MARKET_WRONG_PROPE 4303 Wrong identifier of a symbol


RTY property

ERR_MARKET_LASTTIME_UNK 4304 Time of the last tick is not


NOWN known (no ticks)

History Access

© 2000-2010, MetaQuotes Software Corp.


277 Standard Constants, Enumerations and Structures

ERR_HISTORY_NOT_FOUND 4401 Requested history not found

ERR_HISTORY_WRONG_PROPE 4402 Wrong ID of the history


RTY property

Global_Variables

ERR_GLOBALVARIABLE_NOT_F 4501 Global variable of the client


OUND terminal is not found

ERR_GLOBALVARIABLE_EXISTS 4502 Global variable of the client


terminal with the same name
already exists

ERR_MAIL_SEND_FAILED 4510 Email sending failed

ERR_PLAY_SOUND_FAILED 4511 Sound playing failed

ERR_MQL5_WRONG_PROPERT 4512 Wrong identifier of the


Y program property

ERR_TERMINAL_WRONG_PROP 4513 Wrong identifier of the


ERTY terminal property

ERR_FTP_SEND_FAILED 4514 File sending via ftp failed

Custom Indicator Buffers

ERR_BUFFERS_NO_MEMORY 4601 Not enough memory for the


distribution of indicator
buffers

ERR_BUFFERS_WRONG_INDEX 4602 Wrong indicator buffer index

Custom Indicator Properties

ERR_CUSTOM_WRONG_PROPE 4603 Wrong ID of the custom


RTY indicator property

Account

ERR_ACCOUNT_WRONG_PROP 4701 Wrong account property ID


ERTY

ERR_TRADE_WRONG_PROPER 4751 Wrong trade property ID


TY

ERR_TRADE_DISABLED 4752 Trading by Expert Advisors


prohibited

ERR_TRADE_POSITION_NOT_F 4753 Position not found


OUND

ERR_TRADE_ORDER_NOT_FOU 4754 Order not found


ND

ERR_TRADE_DEAL_NOT_FOUN 4755 Deal not found


D

ERR_TRADE_SEND_FAILED 4756 Trade request sending failed

© 2000-2010, MetaQuotes Software Corp.


278 Standard Constants, Enumerations and Structures

ERR_TRADE_SELECT_TIMEOUT 4757 Timeout exceeded when


selecting (searching) specified
data

Indicators

ERR_INDICATOR_UNKNOWN_S 4801 Unknown symbol


YMBOL

ERR_INDICATOR_CANNOT_CRE 4802 Indicator cannot be created


ATE

ERR_INDICATOR_NO_MEMORY 4803 Not enough memory to add the


indicator

ERR_INDICATOR_CANNOT_APP 4804 The indicator cannot be


LY applied to another indicator

ERR_INDICATOR_CANNOT_AD 4805 Error applying an indicator to


D chart

ERR_INDICATOR_DATA_NOT_F 4806 Requested data not found


OUND

ERR_INDICATOR_WRONG_IND 4807 Wrong index of the requested


EX indicator buffer

ERR_INDICATOR_WRONG_PAR 4808 Wrong number of parameters


AMETERS when creating an indicator

ERR_INDICATOR_PARAMETERS 4809 No parameters when creating


_MISSING an indicator

ERR_INDICATOR_CUSTOM_NA 4810 The first parameter in the


ME array must be the name of the
custom indicator

ERR_INDICATOR_PARAMETER_ 4811 Invalid parameter type in the


TYPE array when creating an
indicator

Depth of Market

ERR_BOOKS_CANNOT_ADD 4901 Depth Of Market can not be


added

ERR_BOOKS_CANNOT_DELETE 4902 Depth Of Market can not be


removed

ERR_BOOKS_CANNOT_GET 4903 The data from Depth Of


Market can not be obtained

ERR_BOOKS_CANNOT_SUBSCRI 4904 Error in subscribing to receive


BE new data from Depth Of
Market

File Operations

ERR_TOO_MANY_FILES 5001 More than 64 files cannot be

© 2000-2010, MetaQuotes Software Corp.


279 Standard Constants, Enumerations and Structures

opened at the same time

ERR_WRONG_FILENAME 5002 Invalid file name

ERR_TOO_LONG_FILENAME 5003 Too long file name

ERR_CANNOT_OPEN_FILE 5004 File opening error

ERR_FILE_CACHEBUFFER_ERR 5005 Not enough memory for cache


OR to read

ERR_CANNOT_DELETE_FILE 5006 File deleting error

ERR_INVALID_FILEHANDLE 5007 A file with this handle was


closed, or was not opening at
all

ERR_WRONG_FILEHANDLE 5008 Wrong file handle

ERR_FILE_NOTTOWRITE 5009 The file must be opened for


writing

ERR_FILE_NOTTOREAD 5010 The file must be opened for


reading

ERR_FILE_NOTBIN 5011 The file must be opened as a


binary one

ERR_FILE_NOTTXT 5012 The file must be opened as a


text

ERR_FILE_NOTTXTORCSV 5013 The file must be opened as a


text or CSV

ERR_FILE_NOTCSV 5014 The file must be opened as


CSV

ERR_FILE_READERROR 5015 File reading error

ERR_FILE_BINSTRINGSIZE 5016 String size must be specified,


because the file is opened as
binary

ERR_INCOMPATIBLE_FILE 5017 A text file must be for string


arrays, for other arrays -
binary

ERR_FILE_IS_DIRECTORY 5018 This is not a file, this is a


directory

ERR_FILE_NOT_EXIST 5019 File does not exist

ERR_FILE_CANNOT_REWRITE 5020 File can not be rewritten

ERR_WRONG_DIRECTORYNAM 5021 Wrong directory name


E

ERR_DIRECTORY_NOT_EXIST 5022 Directory does not exist

ERR_FILE_ISNOT_DIRECTORY 5023 This is a file, not a directory

© 2000-2010, MetaQuotes Software Corp.


280 Standard Constants, Enumerations and Structures

ERR_CANNOT_DELETE_DIRECT 5024 The directory cannot be


ORY removed

String Casting

ERR_NO_STRING_DATE 5030 No date in the string

ERR_WRONG_STRING_DATE 5031 Wrong date in the string

ERR_WRONG_STRING_TIME 5032 Wrong time in the string

ERR_STRING_TIME_ERROR 5033 Error converting string to date

ERR_STRING_OUT_OF_MEMOR 5034 Not enough memory for the


Y string

ERR_STRING_SMALL_LEN 5035 The string length is less than


expected

ERR_STRING_TOO_BIGNUMBE 5036 Too large number, more than


R ULONG_MAX

ERR_WRONG_FORMATSTRING 5037 Invalid format string

ERR_TOO_MANY_FORMATTER 5038 Amount of format specifiers


S more than the parameters

ERR_TOO_MANY_PARAMETERS 5039 Amount of parameters more


than the format specifiers

ERR_WRONG_STRING_PARAM 5040 Damaged parameter of string


ETER type

ERR_STRINGPOS_OUTOFRANG 5041 Position outside the string


E

ERR_STRING_ZEROADDED 5042 0 added to the string end, a


useless operation

ERR_STRING_UNKNOWNTYPE 5043 Unknown data type when


converting to a string

ERR_WRONG_STRING_OBJECT 5044 Damaged string object

Operations with Arrays

ERR_INCOMPATIBLE_ARRAYS 5050 Copying incompatible arrays.


String array can be copied only
to a string array, and a
numeric array - in numeric
array only

ERR_SMALL_ASSERIES_ARRAY 5051 The receiving array is declared


as AS_SERIES, and it is of
insufficient size

ERR_SMALL_ARRAY 5052 Too small array, the starting


position is outside the array

ERR_ZEROSIZE_ARRAY 5053 An array of zero length

© 2000-2010, MetaQuotes Software Corp.


281 Standard Constants, Enumerations and Structures

ERR_NUMBER_ARRAYS_ONLY 5054 Must be a numeric array

ERR_ONEDIM_ARRAYS_ONLY 5055 Must be a one-dimensional


array

ERR_SERIES_ARRAY 5056 Timeseries cannot be used

ERR_DOUBLE_ARRAY_ONLY 5057 Must be an array of type


double

ERR_FLOAT_ARRAY_ONLY 5058 Must be an array of type float

ERR_LONG_ARRAY_ONLY 5059 Must be an array of type long

ERR_INT_ARRAY_ONLY 5060 Must be an array of type int

ERR_SHORT_ARRAY_ONLY 5061 Must be an array of type short

ERR_CHAR_ARRAY_ONLY 5062 Must be an array of type char

User-Defined Errors

ERR_USER_ERROR_FIRST 65536 User defined errors start with


this code

© 2000-2010, MetaQuotes Software Corp.


282 Standard Constants, Enumerations and Structures

Input and Output Constants


Constants:

File opening flags


Positioning inside a file
Code page usage
MessageBox

© 2000-2010, MetaQuotes Software Corp.


283 Standard Constants, Enumerations and Structures

File Opening Flags


File opening flag values specify the file access mode. Flags are defined as follows:

Identifier Value Description

FILE_READ 1 File is opened for reading. Flag


is used in FileOpen()

FILE_WRITE 2 File is opened for writing. Flag


is used in FileOpen()

FILE_BIN 4 Binary read/write mode


(without string to string
conversion). Flag is used in
FileOpen()

FILE_CSV 8 CSV file (all its elements are


converted to strings of the
appropriate type, unicode or
ansi, and separated by
separator). Flag is used in
FileOpen()

FILE_TXT 16 Simple text file (the same as


csv file, but without taking into
account the separators). Flag is
used in FileOpen()

FILE_ANSI 32 Strings of ANSI type (one byte


symbols). Flag is used in
FileOpen()

FILE_UNICODE 64 Strings of UNICODE type (two


byte symbols). Flag is used in
FileOpen()

FILE_SHARE_READ 128 Shared access for reading from


several programs. Flag is used
in FileOpen()

FILE_SHARE_WRITE 256 Shared access for writing from


several programs. Flag is used
in FileOpen()

FILE_REWRITE 512 Possibility for the file rewrite


using functions FileCopy() and
FileMove(). The file should
exist or should be opened for
writing, otherwise the file will
not be opened.

FILE_COMMON 4096 The file path in the common


folder of all client terminals.
Flag is used in FileOpen(),
FileCopy(), FileMove() and in

© 2000-2010, MetaQuotes Software Corp.


284 Standard Constants, Enumerations and Structures

FileIsExist() functions.

See also
File Functions

© 2000-2010, MetaQuotes Software Corp.


285 Standard Constants, Enumerations and Structures

Positioning Inside a File


Most of file functions are associated with data read/write operations. At the same time, using the
FileSeek() you can specify the position of a file pointer to a position inside the file, from which the
next read or write operation will be performed. The ENUM_FILE_POSITION enumeration contains valid
pointer positions, relative to which you can specify the shift in bytes for the next operation.

ENUM_FILE_POSITION

Identifier Description

SEEK_SET File beginning

SEEK_CUR Current position of a file pointer

SEEK_END File end

See also
FileIsEnding, FileIsLineEnding

© 2000-2010, MetaQuotes Software Corp.


286 Standard Constants, Enumerations and Structures

Using a Codepage in String Conversion Operations


When converting string variables into arrays of char type and back, the encoding that by default
corresponds to the current ANSI of Windows operating system (CP_ACP) is used in MQL5. If you want
to specify a different type of encoding, it can be set through an additional parameters for the
functions CharArrayToString(), StringToCharArray() and FileOpen().

The table lists the built-in constants for some of the most popular code pages. Not mentioned code
pages can be specified by a code corresponding to the page.

Built-in Constants of Codepages

Constant Value Description

CP_ACP 0 The current Windows ANSI


code page.

CP_OEMCP 1 The current system OEM code


page.

CP_MACCP 2 The current system Macintosh


code page.
Note: This value is mostly
used in earlier created
program codes and is of no
use now, since modern
Macintosh computers use
Unicode for encoding.

CP_THREAD_ACP 3 The Windows ANSI code page


for the current thread.

CP_SYMBOL 42 Symbol code page

CP_UTF7 65000 UTF-7 code page.

CP_UTF8 65001 UTF-8 code page.

© 2000-2010, MetaQuotes Software Corp.


287 Standard Constants, Enumerations and Structures

Constants of the MessageBox Dialog Window


This section contains return codes of the MessageBox() function. If a message window has a Cancel
button, the function returns IDCANCEL, in case if the ESC key or the Cancel button is pressed. If there
is no Cancel button in the message window, the pressing of ESC does not give any effect.

Constant Value Description

IDOK 1 "OK" button has been pressed

IDCANCEL 2 "Cancel" button has been


pressed

IDABORT 3 "Abort" button has been


pressed

IDRETRY 4 "Retry" button has been


pressed

IDIGNORE 5 "Ignore" button has been


pressed

IDYES 6 "Yes" button has been pressed

IDNO 7 "No" button has been pressed

IDTRYAGAIN 10 "Try Again" button has been


pressed

IDCONTINUE 11 "Continue" button has been


pressed

The main flags of the MessageBox() function define contents and behavior of the dialog window.
This value can be a combination of the following flag groups:

Constant Value Description

MB_OK 0x00000000 Message window contains only


one button: OK. Default

MB_OKCANCEL 0x00000001 Message window contains two


buttons: OK and Cancel

MB_ABORTRETRYIGNORE 0x00000002 Message window contains


three buttons: Abort, Retry
and Ignore

MB_YESNOCANCEL 0x00000003 Message window contains


three buttons: Yes, No and
Cancel

MB_YESNO 0x00000004 Message window contains two


buttons: Yes and No

© 2000-2010, MetaQuotes Software Corp.


288 Standard Constants, Enumerations and Structures

MB_RETRYCANCEL 0x00000005 Message window contains two


buttons: Retry and Cancel

MB_CANCELTRYCONTINUE 0x00000006 Message window contains


three buttons: Cancel, Try
Again, Continue

To display an icon in the message window it is necessary to specify additional flags:

Constant Value Description

MB_ICONSTOP, 0x00000010 The STOP sign icon


MB_ICONERROR,
MB_ICONHAND

MB_ICONQUESTION 0x00000020 The question sign icon

MB_ICONEXCLAMATION, 0x00000030 The exclamation/warning sign


MB_ICONWARNING icon

MB_ICONINFORMATION, 0x00000040 The encircled i sign


MB_ICONASTERISK

Default buttons are defined by the following flags:

Constant Value Description

MB_DEFBUTTON1 0x00000000 The first button


MB_DEFBUTTON1 - is default,
if the other buttons
MB_DEFBUTTON2,
MB_DEFBUTTON3, or
MB_DEFBUTTON4 are not
specified

MB_DEFBUTTON2 0x00000100 The second button is default

MB_DEFBUTTON3 0x00000200 The third button is default

MB_DEFBUTTON4 0x00000300 The fourth button is default

© 2000-2010, MetaQuotes Software Corp.


289 MQL5 programs

MQL5 Programs
For the mql5-program to operate, it must be compiled (Compile button or F7 key). Compilation
should pass without errors (some warnings are possible; they should be analyzed). AT this process, an
executable file with the same name and with EX5 extension must be created in the corresponding
directory, terminal_dir\MQL5\Experts, terminal_dir\MQL5\indicators or terminal_dir\MQL5\scripts.
This file can be run.

Operating features of mql5 programs are described in he following sections:

Program running – order of calling predefined event-handlers;


Client terminal events – description of events, which can be processed in programs
Call of imported functions – description order, allowed parameters, search details and call
agreement for imported functions;
Runtime errors – obtaining information about runtime and critical errors.

Expert Advisors, custom indicators and scripts are attached to one of opened charts by Drag'n'Drop
method from the Navigator window.

For an expert Advisor to stop operating, it should be removed from a chart by selecting "Expert
Advisors - Remove" in chart context menu. Operation of Expert Advisors is also affected by the state
of the button "Enable/disable Expert Advisors".

In order to stop a custom indicator, it should be removed from a chart.

Custom indicators and Expert Advisors work until they are explicitly removed from a chart;
information about attached Expert Advisors and Indicators is saved between client terminal starts.

Scripts are executed once and are deleted automatically upon operation completion or change of the
current chart state, or upon client terminal shutdown. After the restart of the client terminal scripts
are not started, because the information about them is not saved.

Maximum one Expert Advisor, one script and unlimited number of indicators can operate in one
chart.

© 2000-2010, MetaQuotes Software Corp.


290 MQL5 programs

Program Running
Right after a program is attached to a chart, it is uploaded to the client terminal memory, as well as
global variable are initialized. If some global variable of the class type has a constructor, this
constructor will be called during initialization of global variables.

After that the program is waiting for an event from the client terminal. Each mql5-program should
has at least one event-handler, otherwise the loaded program will not be executed. Event handlers
have predefined names, parameters and return types.

Type Function name Parameters Application Comment

int OnInit none Expert Advisors Init event


and indicators handler. It allows
to use the void
return type.

void OnDeinit const int reason Expert Advisors Deinit event


and indicators handler.

void OnStart none scripts Start event


handler.

int OnCalculate const int indicators Calculate event


rates_total, handler for all
const int prices.
prev_calculated,
const datetime
&Time[],
const double
&Open[],
const double
&High[],
const double
&Low[],
const double
&Close[],
const long
&TickVolume[],
const long
&Volume[],
const int
&Spread[]

int OnCalculate const int indicators Calculate event


rates_total, handler on the
const int single data
prev_calculated, array.
const int begin, Indicator cannot
const double have two event
&price[] handlers
simultaneously.

© 2000-2010, MetaQuotes Software Corp.


291 MQL5 programs

In this case the


only one event
handler will work
on the data
array.

void OnTick none Expert Advisors NewTick event


handler. While
the event of a
new tick receipt
is being
processed, no
other events of
this type are
received.

void OnTimer none Expert Advisors Timer event


and indicators handler.

void OnTrade none Expert Advisors Trade event


handler.

void OnChartEvent const int id, Expert Advisors ChartEvent event


const long and indicators handler.
&lparam,
const double
&dparam,
const string
&sparam

void OnBookEvent const string Expert Advisors BookEvent event


&symbol_name handler.

Client terminal adds appearing events to the events queue. So events are processed one after
another in accordance to the order they were received. There is an exception for the NewTick event.
If the queue already has such an event or this event is being processed, the new NewTick event is not
enqueued.

Queue of events is limited in size. At queue overflow, old events are removed without being
processed in order to allow the receipt of new events. Therefore, it is recommended to write efficient
event handlers, and it is not recommended to use infinite loops (there is an exception of scripts,
which handle the Start event only).

Events are enqueued for Expert Advisors only if the operation of Expert Advisors is enabled in the

the client terminal.

Libraries do not handle any events.

Loading and Unloading of Indicators

Indicators are loaded in the following cases:

an indicator is attached to a chart;

© 2000-2010, MetaQuotes Software Corp.


292 MQL5 programs

terminal start (if the indicator was attached to the chart prior to the shutdown of the terminal);
loading of a template (if the indicator attached to a chart is specified in the template);
change of a profile (if the indicator is attached to one of the profile charts);
change of a symbol and/or timeframe of a chart, to which the indicator is attached;
after the successful recompilation of an indicator, if the indicator was attached to a chart;
change of input parameters of the indicator.

Indicators are unloaded in the following cases:

when detaching an indicator from a chart;


terminal shutdown (if the indicator was attached to a chart);
loading of a template, if an indicator is attached to a chart;
closing of a chart, to which the indicator was attached;
change of a profile, if the indicator is attached to one of charts of the changed profile;
change of a symbol and/or timeframe of a chart, to which the indicator is attached;
change of input parameters of the indicator.

Loading and Unloading of Expert Advisors

Expert Advisors are loaded in the following cases:

when attaching an Expert Advisor to a chart;


terminal start (if the Expert Advisor was attached to the chart prior to the shutdown of the
terminal);
loading of a template (if the Expert Advisor attached to the chart is specified in the template);
change of a profile (if the Expert Advisor is attached to the one of the profile charts).

Expert Advisors are unloaded in the following cases:


when detaching an expert Advisor from a chart;
if a new Expert Advisor is attached to a chart, if another Expert Advisor has been attached already,
this Expert Advisor is unloaded.
terminal shutdown (if the Expert Advisor was attached to a chart);
loading of a template, if an Expert Advisor is attached to the chart;
close of a chart, to which the Expert Advisor is attached.
change of a profile, if the Expert Advisor is attached to one of charts of the changed profile.
In case the symbol or timeframe of a chart, to which the Expert Advisor is attached, changes,
Expert Advisors are not loaded or unloaded. In this case client terminal subsequently calls OnDeinit
() handlers on the old symbol/timeframe and OnInit() on the new symbol/timeframe (if they are such),
values of global variables and static variables are not reset. All events, which have been received for
the Expert Advisor before the initialization is completed (OnInit() function) are skipped.
Expert Advisors are not loaded or unloaded when account is changed.

Loading and Unloading of Scripts

© 2000-2010, MetaQuotes Software Corp.


293 MQL5 programs

Scripts are loaded immediately after they are attached to a chart and unloaded immediately after
they complete their operation. OnInit() and OnDeinit() are not called for scripts.

When a program is unloaded (deleted from a chart) the client terminal performs deinitialization of
global variables and deletes the events queue. In this case deinitialization means reset of all the
string-type variables, deallocation of dynamical array objects and call of their destructors if they are
available.

For a better understanding of the Expert Advisor operation we recommend to compile the code of
the following Expert Advisor and perform actions of load/unload, template change, symbol change,
timeframe change etc:

Example:

//+------------------------------------------------------------------+
//| TestExpert.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"

class CTestClass
{
public:
CTestClass() { Print("CTestClass constructor"); }
~CTestClass() { Print("CTestClass destructor"); }
};
CTestClass global;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//---
Print("Initialisation");
//---
return(0);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
Print("Deinitialisation with reason",reason);
}
//+------------------------------------------------------------------+
//| Expert tick function |

© 2000-2010, MetaQuotes Software Corp.


294 MQL5 programs

//+------------------------------------------------------------------+
void OnTick()
{
//---

}
//+------------------------------------------------------------------+

See also

Client terminal events, Event handlers

© 2000-2010, MetaQuotes Software Corp.


295 MQL5 programs

Client Terminal Events


Init

Immediately after the client terminal loads a program (an Expert Advisor or custom indicator) and
starts the process of initialization of global variables, the Init event will be sent, which will be
processed by OnInit() event handler, if there is such. This event is also generated after a security
and/or chart timeframe is changed, after a program is recompiled in MetaEditor, after input
parameters are changed from the setup window of an Expert Advisor or a custom indicator. An Expert
Advisor is also initialized after the account is changed. The Init event is not generated for scripts.

Deinit

Before global variables are deinitialized and the program (Expert Advisor or custom indicator) is
unloaded, the client terminal sends the Deinit event to the program. Deinit is also generated when the
client terminal is closed, when a chart is closed, right before the security and/or timeframe is
changed, at a successful program re-compilation, when input parameters are changed, and when
account is changed.

The deinitialization reason can be obtained from the parameter, passed to the OnDeinit() function.
The OnDeinit() function run is restricted to 2.5 seconds. If during this time the function hasn't been
completed, then it is forcibly terminated. The Deinit event is not generated for scripts.

Start

The Start event is a special event for script activation after it is loaded. This event is processed by
OnStart handler. The Start event is not send to Expert Advisors or custom indicators.

NewTick

The NewTick event is generated if there are new quotes, it is processed by OnTick() of Expert
Advisors attached. In case when OnTick function for the previous quote is being processed when a
new quote is received, the new quote will be ignored by an Expert Advisor, because the corresponding
event will not enqueued.

All new quotes that are received while the program is running are ignored until the OnTick() is
completed. After that the function will run only after a new quote is received. The NewTick event is
not generated if use of Expert Advisors in the client terminal is not allowed (Button "Enable/Disable
Expert Advisors").

However, disabling of Expert Advisors by pressing the specified button does not interrupt the
execution of the OnTick() function. OnTick() is not started when the window of Expert Advisor
properties is open. The window of properties cannot be opened when the Expert Advisor is runnung.

Calculate

The Calculate event is generated only for indicators right after the Init event is sent and at any
change of price data. It is processed by the OnCalculate function.

Timer

© 2000-2010, MetaQuotes Software Corp.


296 MQL5 programs

The Timer event is periodically generated by the client terminal for the Expert Advisor that has
activated the timer by the EventSetTimer function. Usually, this function is called by OnInit. Timer
event processing is performed by the OnTimer function. After the operation of the Expert Advisor is
completed, it is necessary to destroy the timer using the EventKillTimer function, which is usually
called in the OnDeinit function.

Trade

The Trade event is generated when a trade operation is completed on a trade server. The Trade
event is handled by the OnTrade() function for the following trade operations:

sending, modifying or removing of a pending order;


cancellation of a pending order with not enough of money or expiration;
activation of a pending order;
opening, adding or closing a position (or part of the position);
modifying of the open position (change stops – Stop Loss and/or Take Profit).

ChartEvent

The ChartEvent event is generated by the client terminal when a user is working with a chart:

keyboard press, when the chart window is focused;


graphical object created;
graphical object deleted;
mouse press on the graphical object of the chart;
move of the graphical object using the mouse
end of text editing in LabelEdit.

Also there is a custom event ChartEvent, which can be sent to an Expert Advisor by any mql5-
program by using the EventChartCustom function. The event is processed by the OnChartEvent
function.

BookEvent

The BookEvent event is generated by the client terminal after the Depth Of Market is changed; it is
processed by the OnBookEvent function. To start generation of BookEvent for the specified symbol, it
is necessary to subscribe the symbol to this event by using the MarketBookAdd function.

To unsubscribe from BookEvent for a specified symbol, it is necessary to call the MarketBookRelease
function. The BookEvent event is a broadcasting-type event - it means that it is sufficient to
subscribe just one Expert Advisor for this event, and all other Expert Advisors that have the
OnBookEvent event, will receive it. That's why it is necessary to analyse the symbol name, which is
passed to a handler as a parameter.

See also
Event handlers, Program running

© 2000-2010, MetaQuotes Software Corp.


297 MQL5 programs

Call of Imported Functions


To import functions during the execution of a mql5-program, the client terminal uses early binding.
This means that if a program has call of an imported function, the corresponding module (ex5 or dll) is
loaded during the program load. MQL5 and DLL libraries are executed in the thread of a calling
module.

It is not recommended to use the fully specified name of the module to be loaded like Drive:
\Directory\FileName.Ext. The MQL5 libraries are loaded from the terminal_dir\MQL5\Libraries folder.
If the library hasn't been found, then the client terminal performs an attempt to load it from
terminal_dir\experts folder.

The system libraries (DLL) are loaded by the operating system rules. If the library is already loaded
(for example, another Expert Advisor, and even from another client terminal, running in parallel),
then it uses requests to the library already loaded. Otherwise, it performs a search in the following
sequence:
1. Directory of terminal_dir\Libraries.
2. Directory, from which a client terminal is started terminal_dir.
3. The current directory.
4. The system directory windows_dir\SYSTEM32
5. Directory where the operating system is installed windows_dir.
6. Directories, listed in the PATH system environment variable.

If the DLL library uses another DLL in its work, the first one cannot be loaded in case when there is
no second DLL.

Unlike system libraries, custom user libraries (MQL5) are loaded for each module separately
irrespective of whether the called library has been loaded by any other module. For example, the
caller.ex5 module calls the functions from the library lib1.ex5 and lib2.ex5. In its turn, the library lib1.
ex5 calls the functions from the library lib2.ex5. In this case one copy of library lib1.ex5 and two
copies of library lib2.ex5 will be loaded, despite of the fact that all calls are initiated from caller.ex5.

Functions imported DLL into a mql5-program must ensure the Windows API calls agreement. To
ensure such an agreement, in the source text of programs written in C or C++, use the keyword
__stdcall, which is specific to the Microsoft(r) compilers. This agreement is characterized by the
following:

caller (in our case it is a mq5-program) should "see" a prototype of a function called (imported
from the DLL), in order to properly combine parameters to a stack;

caller (in our case it is a mql5-program) puts parameters to the stack in a reverse order, from
right to left - in this order an imported function reads parameters passed to it;

parameters are passed by value, except those explicitly passed by reference (in our case lines)

an imported function cleans the stack independently by reading parameters passed to it.

When describing the prototype of an imported function, default parameters can be used.

If the corresponding library is unable to load, or there is a prohibition on the DLL use, or the
imported function is not found - the Expert Advisor stops its operation with the appropriate message

© 2000-2010, MetaQuotes Software Corp.


298 MQL5 programs

"Expert Advisor stopped" in the Journal (log file). In this case the Expert Advisor will not run until it is
reinitialized. An Expert Advisor can be reinitialized as a result of recompilation or after the table of
its properties is opened and OK is pressed.

Passing Parameters
All parameters of simple types are passed by values unless it is explicitly indicated that they are
passed by reference. When a string is passed, the address of the buffer of the copied string is passed;
if a string is passed by reference, the address of the buffer of this string without copying it is passed
to the function imported from DLL.

Structures that contain dynamic arrays, strings, classes, other complex structures, as well as static
or dynamic arrays of the enumerated objects, can't be passed as a parameter to an imported function.

When passing an array to DLL, the address of the beginning of the data buffer is always passed
(irrespective of the AS_SERIES flag). A function inside a DLL knows nothing about the AS_SERIES flag,
the passed array is a static array of an undefined length; an additional parameter should be used for
specifying the array size.

© 2000-2010, MetaQuotes Software Corp.


299 MQL5 programs

Runtime Errors
The executing subsystem of the client terminal has an opportunity to save the error code in case
any occurs during a mql5-program run. There is a a predefined variable _LastError for each executable
mql5 program.

Before starting the OnInit function, the _LastError variable is reset. In case an erroneous situations
occurs during calculations or in the process of internal function calls, the _LastError variable accepts a
corresponding error code. The value stored in this variable can be obtained by using the GetLastError
() function.

There are several critical errors, appearing which a program is terminated immediately :

division by zero;
going beyond array ranges;
using an incorrect object pointer;

© 2000-2010, MetaQuotes Software Corp.


300 Predefined Variables

The predefined Variables


For each executable mql5-program a set of predefined variables is supported, which reflect the
state of the current price chart by the moment a mql5-program (Expert Advisor, script or custom
indicator) is started.

Values of predefined variables are set by the client terminal before a mql5-program is started.
Predefined variables are constant and cannot be changed from a mql5-program. As exception, there is
a special variable _LastError, which can be reset to 0 by the ResetLastError function.

Variable Value

_Digits Number of decimal places

_Point Size of the current symbol point in the quote


currency

_LastError The last error code

_Period Timeframe of the current chart

_StopFlag Program stop flag

_Symbol Symbol name of the current chart

_UninitReason Uninitialization reason code

© 2000-2010, MetaQuotes Software Corp.


301 Predefined Variables

int _Digits
The _Digits variable stores number of digits after a decimal point, which defines the price accuracy
of the symbol of the current chart.

You may also use the Digits() function.

© 2000-2010, MetaQuotes Software Corp.


302 Predefined Variables

double _Point
The _Point variable contains the point size of the current symbol in the quote currency.

You may also use the Point() function.

© 2000-2010, MetaQuotes Software Corp.


303 Predefined Variables

int _LastError
The _LastError variable contains code of the last error, that occurred during the mql5-program run.
Its value can be reset to zero by ResetLastError().

To obtain the code of the last error, you may also use the GetLastError() function.

© 2000-2010, MetaQuotes Software Corp.


304 Predefined Variables

int _Period
The _Period variable contains the value of the timeframe of the current chart.

Also you may use the Period() function.

See also

PeriodSeconds, Chart timeframes, Date and Time, Visibility of objects

© 2000-2010, MetaQuotes Software Corp.


305 Predefined Variables

bool _StopFlag
The _StopFlag variable contains the flag of the mql5-program stop. When the client terminal is
trying to stop the program, it sets the _StopFlag variable to true.

To check the state of the _StopFlag you may also use the IsStopped function.

© 2000-2010, MetaQuotes Software Corp.


306 Predefined Variables

string _Symbol
The _Symbol variable contains the symbol name of the current chart.

You may also use the Symbol() function.

© 2000-2010, MetaQuotes Software Corp.


307 Predefined Variables

int _UninitReason
The _UninitReason variable contains the code of the program uninitialization reason.

Usually, this code is obtained by UninitializeReason()the function.

© 2000-2010, MetaQuotes Software Corp.


308 Common Functions

Common Functions
General-purpose functions not included into any specialized group are listed here.

Function Action

Alert Displays a message in a separate window

CheckPointer Returns the type of the object pointer

Comment Outputs a comment in the left top corner of the


chart

DebugBreak Program breakpoint in debugging

ExpertRemove Stops expert advisor and unloads it from the


chart

GetPointer Returns the object pointer

GetTickCount Returns the number of milliseconds that have


elapsed since the system was started

MessageBox Creates, displays a message box and manages


it

PeriodSeconds Returns the number of seconds in the period

PlaySound Plays a sound file

Print Displays a message in the log

PrintFormat Formats and prints the sets of symbols and


values in a log file in accordance with a preset
format

ResetLastError Sets the value of a predetermined variable


_LastError to zero

SendFTP Sends a file at the address specified in the


settings window of the "Publisher" tab

SendMail Sends an email at the address specified in the


settings window of the "Mailbox" tab

Sleep Suspends execution of the current Expert


Advisor or script within a specified interval

TerminalClose Commands the terminal to complete operation

ZeroMemory Resets a variable passed to it by reference. The


variable can be of any type, except for classes
and structures that have constructors.

© 2000-2010, MetaQuotes Software Corp.


309 Common Functions

Alert
Displays a message in a separate window.

void  Alert(
argument, // first value
...  // other values
);

Parameters
argument
[in] Any values, separated by commas. To separate the information output in several lines you
can use the line feed character "\n" or "\r\n". The number of parameters can not exceed 64.

Return Value

No return value.

Note

Arrays can't be passed to the Alert() function. Arrays should be output elementwise. Data of the
double type are output with 8 digits after the decimal point, data of the float type are displayed
with 5 digits after the decimal point. To derive the real numbers with a different precision or in a
scientific format, use DoubleToString().

Data of bool the type are output as "true" or "false" strings. Dates are output as YYYY.MM.DD HH:
MI:SS. To display a date in another format use TimeToString(). Data of the color type are output
either as an R,G,B string or as a color name, if the color is present in a color set.

When output, all parameters are separated by a space.

© 2000-2010, MetaQuotes Software Corp.


310 Common Functions

CheckPointer
The function returns the type of the object pointer.

ENUM_POINTER_TYPE  CheckPointer(
object* anyobject  // object pointer
);

Parameters
anyobject
[in] Object pointer.

Return value

Returns a value from the ENUM_POINTER_TYPE enumeration.

Note

An attempt to call an incorrect pointer results in the critical termination of a program. That's why
it's necessary to call the CheckPointer function before using a pointer. A pointer can be incorrect in
the following cases:

the pointer is equal to NULL;

the object has been deleted using the delete operator.

This function can be used for checking pointer validity. A non-zero value warranties that the pointer
can be used for accessing.

Example:

//+------------------------------------------------------------------+
//| delete list by deleting its elements |
//+------------------------------------------------------------------+
void CMyList::Destroy()
{
//--- service pointer for working in the loop
CItem* item;
//--- go through loop and try to delete dynamic pointers
while(CheckPointer(m_items)!=POINTER_INVALID)
{
item=m_items;
m_items=m_items.Next();
if(CheckPointer(item)==POINTER_DYNAMIC)
{
Print("Dynamyc object",item.Identifier(),"to be deleted");
delete (item);
}
else Print("Non-dynamic object",item.Identifier(),"cannot be deleted");
}
//---
}

© 2000-2010, MetaQuotes Software Corp.


311 Common Functions

See also

Object Pointers, Checking the Object Pointer, Object Delete Operator delete

© 2000-2010, MetaQuotes Software Corp.


312 Common Functions

Comment
This function outputs a comment defined by a user in the top left corner of a chart.

void  Comment(
argument, // first value
...  // next values
);

Parameters
...
[in] Any values, separated by commas. To delimit output information into several lines, a line
break symbol "\n" or "\r\n" is used. Number of parameters cannot exceed 64. Total length of the
input comment (including invisible symbols) cannot exceed 2045 characters (excess symbols will be
cut out during output).

Return Value

No return value

Note

Arrays can't be passed to the Comment() function.Arrays must be entered element-by-element.

Data of double type are shown with the accuracy of up to 16 digits after a decimal point, and can be
output either in traditional or in scientific format, depending on what entry will be more compact.
Data of float type are output with 5 digits after a decimal point. To output real numbers with
another accuracy or in a predefined format, use the DoubleToString() function.

Data of bool type are output as "true" or "false" lines. Dates are shown as YYYY.MM.DD HH:MI:SS.
To show data in another format, use TimeToString(). Data of color type are returned either as R,G,
B line or as a color name, if this color is present in the color set.

During input all parameters are space separated.

The Comment function can't be called from a custom indicator, because a custom indicator can't
access chart, to which it is attached.

Example:

void OnTick()
{
//---
double Ask,Bid;
int Spread;
Ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
Bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
Spread=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD);
//--- Output values in three lines
Comment(StringFormat("Show prices\nAsk = %G\nBid = %G\nSpread = %d",Ask,Bid,Spread));
}

See also

© 2000-2010, MetaQuotes Software Corp.


313 Common Functions

ChartSetString, ChartGetString

© 2000-2010, MetaQuotes Software Corp.


314 Common Functions

DebugBreak
It is a program breakpoint in debugging.

void  DebugBreak();

Return Value

No return value.

Note

Execution of an mql5 program is broken only if a program is started in a debugging mode. The
function can be used for viewing values fo variables and/or for further step-by-step execution.

© 2000-2010, MetaQuotes Software Corp.


315 Common Functions

ExpertRemove
The function stops an Expert Advisor and unloads it from a chart.

void  ExpertRemove();

Returned value

No return value.

Note

The Expert Advisor is not stopped immediately as you call ExpertRemove(); just a flag to stop the
EA operation is set. That is, any next event won't be processed, OnDeinit() will be called and the
Expert Advisor will be unloaded and removed from the chart.

Example:

//+------------------------------------------------------------------+
//| Test_ExpertRemove.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"
input int ticks_to_close=20;// number of ticks before EA unload
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
Print(TimeCurrent(),":" ,__FUNCTION__,"reason code =",reason);
//--- "clear" comment
Comment("");
//---
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
static int tick_counter=0;
//---
tick_counter++;
Comment("\nBefore unloading expert advisor",__FILE__,"left",
(ticks_to_close-tick_counter),"ticks");
//--- before
if(tick_counter>=ticks_to_close)
{

© 2000-2010, MetaQuotes Software Corp.


316 Common Functions

ExpertRemove();
Print(TimeCurrent(),":",__FUNCTION__," expert advisor will be unloaded");
}
Print("tick_counter =",tick_counter);
//---
}
//+------------------------------------------------------------------+

See also

Programs running, Client terminal events

© 2000-2010, MetaQuotes Software Corp.


317 Common Functions

GetPointer
The function returns the object pointer.

void*  GetPointer(
any_class anyobject  // object of any class
);

Parameters
anyobject
[in] Object of any class.

Return Value

The function returns the object pointer.

Note

Only class objects have pointers. Instances of structures and simple-type variables can't have
pointers. The class object not created using the new() operator, but, e.g., automatically created in
the array of objects, still has a pointer. But this pointer will be of the automatic type
POINTER_AUTOMATIC, therefore the delete() operator can't be applied to it. Aside from that, the
type pointer doesn't differ from dynamic pointers of the POINTER_AUTOMATIC type.

Since variables of structure types and simple types do not have pointers, it's prohibited to apply the
GetPointer() function to them. It's also prohibited to pass the pointer as a function argument. In all
these cases the compiler will notify of an error.

An attempt to call an incorrect pointer causes the critical termination of a program. That's why the
CheckPointer() function should be called prior to using a pointer. A pointer can be incorrect in the
following cases:

the pointer is equal to NULL;

the object has been deleted using the delete operator.

This function can be used to check the validity of a pointer. A non-zero value guarantees, that the
pointer can be used for accessing.

Example:

//+------------------------------------------------------------------+
//| Check_GetPointer.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"

//+------------------------------------------------------------------+
//| class implementing the list element |
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


318 Common Functions

class CItem
{
int m_id;
string m_comment;
CItem* m_next;
public:
CItem() { m_id=0; m_comment=NULL; m_next=NULL; }
~CItem() { Print("Destructor of",m_id,
(CheckPointer(GetPointer(this))==POINTER_DYNAMIC)?
"dynamic":"non-dynamic"); }
void Initialize(int id,string comm) { m_id=id; m_comment=comm; }
void PrintMe() { Print(__FUNCTION__,":",m_id,m_comment); }
int Identifier() { return(m_id); }
CItem* Next() {return(m_next); }
void Next(CItem *item) { m_next=item; }
};
//+------------------------------------------------------------------+
//| simplest class of the list |
//+------------------------------------------------------------------+
class CMyList
{
CItem* m_items;
public:
CMyList() { m_items=NULL; }
~CMyList() { Destroy(); }
bool InsertToBegin(CItem* item);
void Destroy();
};
//+------------------------------------------------------------------+
//| inserting list element at the beginning |
//+------------------------------------------------------------------+
bool CMyList::InsertToBegin(CItem* item)
{
if(CheckPointer(item)==POINTER_INVALID) return(false);
//---
item.Next(m_items);
m_items=item;
//---
return(true);
}
//+------------------------------------------------------------------+
//| deleting the list by deleting elements |
//+------------------------------------------------------------------+
void CMyList::Destroy()
{
//--- service pointer to work in a loop
CItem* item;
//--- go through the loop and try to delete dynamic pointers

© 2000-2010, MetaQuotes Software Corp.


319 Common Functions

while(CheckPointer(m_items)!=POINTER_INVALID)
{
item=m_items;
m_items=m_items.Next();
if(CheckPointer(item)==POINTER_DYNAMIC)
{
Print("Dynamyc object",item.Identifier(),"to be deleted");
delete (item);
}
else Print("Non-dynamic object",item.Identifier(),"cannot be deleted");
}
//---
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
CMyList list;
CItem items[10];
CItem* item;
//--- create and add into the list a dynamic object pointer
item=new CItem;
if(item!=NULL)
{
item.Initialize(100,"dynamic");
item.PrintMe();
list.InsertToBegin(item);
}
//--- add automatic pointers into the list
for(int i=0; i<10; i++)
{
items[i].Initialize(i,"automatic");
items[i].PrintMe();
item=GetPointer(items[i]);
if(CheckPointer(item)!=POINTER_INVALID)
list.InsertToBegin(item);
}
//--- add one more dynamic object pointer at the list beginning
item=new CItem;
if(item!=NULL)
{
item.Initialize(200,"dynamic");
item.PrintMe();
list.InsertToBegin(item);
}
//--- delete all the list elements
list.Destroy();

© 2000-2010, MetaQuotes Software Corp.


320 Common Functions

//--- all the list elements will be deleted after the script is over
//--- see the Experts tab in the terminal
}

See also
Object Pointers, Checking the Object Pointer, Object Delete Operator delete

© 2000-2010, MetaQuotes Software Corp.


321 Common Functions

GetTickCount
The GetTickCount() function returns the number of milliseconds that elapsed since the system start.

uint  GetTickCount();

Return Value

Value of uint type.

Note

Counter is limited by the restrictions of the system timer. Time is stored as an unsigned integer, so
it's overfilled every 49.7 if a computer works uninterruptedly.

© 2000-2010, MetaQuotes Software Corp.


322 Common Functions

MessageBox
It creates and shows a message box and manages it. A message box contains a message and header,
any combination of predefined signs and command buttons.

int  MessageBox(
string  text,  // message text
string  caption=NULL,  // box header
int  flags=0  // defines set of buttons in the box
);

Parameters
text
[in] Text, containing message to output.

caption=NULL
[in] Optional text to be displayed in the box header. If the parameter is empty, Expert Advisor
name is shown in the box header.

flags=0
[in] Optional flags defining appearance and behavior of a message box. Flags can be a
combination of a special group of flags.

Return Value

If the function is successfully performed, the returned value is one of values of MessageBox() return
codes.

Note

The function can't be called from custom indicators, because indicators are executed in the
interface thread and shouldn't slow down it.

© 2000-2010, MetaQuotes Software Corp.


323 Common Functions

PeriodSeconds
This function returns number of seconds in a period.

int  PeriodSeconds(
ENUM_TIMEFRAMES  period=PERIOD_CURRENT  // chart period
);

Parameters
period=PERIOD_CURRENT
[in] Value of a chart period from the enumeration ENUM_TIMEFRAMES. If the parameter isn't
specified, it returns the number of seconds of the current chart period, at which the program
runs.

Return Value

Number of seconds in a selected period.

See also

_Period, Chart timeframes, Date and Time, Visibility of objects

© 2000-2010, MetaQuotes Software Corp.


324 Common Functions

PlaySound
It plays a sound file.

bool  PlaySound(
string  filename  // file name
);

Parameters
filename
[in] Path to a sound file.

Return Value

true – if the file is found, otherwise - false.

Note

The file must be located in terminal_directory\Sounds ot its sub-directory. Only WAV files are
played.

© 2000-2010, MetaQuotes Software Corp.


325 Common Functions

Print
It enters a message in the Expert advisor log. parameters can be of any type..

void  Print(
argument, // first value
...  // next values
);

Parameters
...
[in] Any values separated by commas. Number of parameters can't exceed 64.

Note

Arrays cannot be passed to the Print() function. Arrays must be input element-by-element.

Data of double type are shown with the accuracy of up to 16 digits after a decimal point, and can be
output either in traditional or in scientific format, depending on what entry will be more compact.
Data of float type are output with 5 digits after a decimal point. To output real numbers with
another accuracy or in a predefined format, use the DoubleToString() function.

Data of bool type are output as "true" or "false" lines. Dates are shown as YYYY.MM.DD HH:MI:SS.
To show data in another format, use TimeToString(). Data of color type are returned either as R,G,
B line or as a color name, if this color is present in the color set.

When shown, all parameters are space separated.

Example:

Print("Time of the last received quote ",TimeCurrent());

See also

PrintFormat, StringFormat

© 2000-2010, MetaQuotes Software Corp.


326 Common Functions

PrintFormat
It formats and enters sets of symbols and values in the Expert Advisor log in accordance with a preset
format.

void  PrintFormat(
string format_string, // format line
...  // values of simple types
);

Parameters
format_string
[in] A format line consists of simple symbols, and if the format line is followed by arguments, it
also contains format specifications.

...
[in] Any values of simple types separated by commas. Total number of parameters can't exceed
64 including the format line.

Note

Instead of PrintFormat() you can use printf().

If the format line is followed by parameters, this line must contain format specifications that
denote output format of these parameters. Specification of format always starts with the percent
sign (%).

A format line is read from left to right. When the first format specification is met (if there is any),
the value of the first parameter after the format line is transformed and output according to the
preset specification. The second format specification calls transformation and output of the second
parameter, and so on till the format line end. If there are more parameters than format
specifications, these additional parameters are ignored.

The format specification has the following form:

%[flags][width][.precision][{h | l | ll | I32 | I64}]type

Each field of the format specification is either a simple symbol, or a number denoting a simple
format option. The simplest format specification contains only the percent sign (%) and a symbol
defining the type of the output parameter (for example, %s). If you need to output the percent sign
in the format line, use the format specification %%.

flags

Flag Description Default Behavior

– (minus) Left justification within the Right justification


set width

+ (plus) Output of the + or - sign for The sign is shown only of the
values of sign types value is negative

© 2000-2010, MetaQuotes Software Corp.


327 Common Functions

0 (zero) Zeroes are added before an Nothing is added


output value within the preset
width. If 0 flag is specified
with an integer format (i, u,
x, X, o, d) and accuracy
specification is set (for
example, %04.d), then 0 is
ignored.

space A space is shown before an Spaces aren't inserted


output value, if it is a sign
and positive value

# If used together with the Nothing is added


format o, x or X, then before
the output value 0, 0x or 0X
is added respectively.

If used together with the Decimal point is shown only if


format e, E, a or A, value is there is a non-zero fractional
always shown with a decimal part.
point.

If used together with the Decimal point is shown only if


format g or G, flag defines there is a non-zero fractional
presence of a decimal point in part. Leading zeroes are cut
the output value and prevents off.
the cutting off of leading
zeroes.
Flag # is ignored when used
together with formats c, d, i,
u, s.

width
A non-negative decimal number that sets the minimal number of output symbols of the formatted
value. If the number of output symbols is less than the set width, the corresponding number of
spaces is added from the left or right depending on the alignment (flag –). If there is flag zero (0),
the corresponding number of zeroes is added before the output value. If the number of output
values is larger than the the preset width, the output value is never cut off.

If an asterisk (*) is specified as width, value of int type must be indicated in the corresponding
place of the list of passed parameters. It will be used for specifying width of the output value.

precision
A non-negative decimal number that sets the output accuracy - number of digits after a decimal
point. As distinct from width specification, accuracy specification can cut off the part of fractional
type with or without rounding.

The use of accuracy specification is different for different format types.

© 2000-2010, MetaQuotes Software Corp.


328 Common Functions

Types Description Default Behavior

a, A Accuracy specification sets Default accuracy – 6.


the number of digits after a
decimal point.

c, C Not used

d, i, u, o, x, X Sets minimal number of Default accuracy – 1.


output digits. If number of
digits in a corresponding
parameter is less than this
accuracy, zeroes are added to
the left of the output value.
The output value isn't cut off,
if the number of output digits
is larger than th specified
accuracy.

e, E, f Sets number of output digits Default accuracy – 6. If set


after a decimal point. The accuracy is 0 or decimal part is
last digit is rounded off. absent, the decimal point is
not shown.

g, G Sets maximal number of 6 meaningful numbers are


meaningful numbers. output.

s, S Sets number of output The whole line is output.


symbols of a line. If the line
length exceeds the accuracy,
the line is cut off.

h | l | ll | I32 | I64

Specification of data sizes, passed as a parameter.

Parameter Type Used Prefix Joint Specifier of Type

int l (lower case L) d, i, o, x, or X

uint l (lower case L) o, u, x, or X

long ll (two lower case L) d, i, o, x, or X

short h d, i, o, x, or X

ushort h o, u, x, or X

int I32 d, i, o, x, or X

uint I32 o, u, x, or X

long I64 d, i, o, x, or X

ulong I64 o, u, x, or X

© 2000-2010, MetaQuotes Software Corp.


329 Common Functions

type

Type specifier is the only obligatory field for formatted output.

Symbol Type Output Format

c int Symbol of short type


(Unicode)

C int Symbol of char type (ANSI)

d int Sign decimal integer

i int Sign decimal integer

o int Unsigned octal integer

u int Unsigned decimal integer

x int Unsigned hexadecimal


integer, using "abcdef"

X int Unsigned hexadecimal


integer, using "ABCDEF"

e double A real value in the format [-]


d.dddde[sign] ddd, where d -
one decimal digit, dddd - one
or more decimal digits, ddd -
a three-digit number that
determines the size of the
exponent, sign - plus or
minus

E double Similar to the format of e,


except that the sign of
exponent is output by upper
case letter (E instead of e)

f double A real value in the format [-]


dddd.dddd, where dddd - one
or more decimal digits.
Number of displayed digits
before the decimal point
depends on the size of
number value. Number of
digits after the decimal point
depends on the required
accuracy.

g double A real value output in f or e


format depending on what
output is more compact.

G double A real value output in F or E


format depending on what

© 2000-2010, MetaQuotes Software Corp.


330 Common Functions

output is more compact.

a double A real number in format [−]


0xh.hhhh p±dd, where h.hhhh
– mantissa in the form of
hexadecimal digits, using
"abcdef", dd - One or more
digits of exponent. Number of
decimal places is determined
by the accuracy specification

A double A real number in format [−]


0xh.hhhh P±dd, where h.hhhh
– mantissa in the form of
hexadecimal digits, using
"ABSDEF", dd - One or more
digits of exponent. Number of
decimal places is determined
by the accuracy specification

s string Line output

Instead of PrintFormat() you can use printf().

Example:

PrintFormat("Output DBL_MAX in a compact scientific form %e",DBL_MAX);


printf("Output double %.15e",DBL_MAX);
printf("Output double %15e",DBL_MAX);
printf("Output double %15.10e",DBL_MAX);
printf("Output double %15.10f",DBL_MAX);

printf("Output DBL_MAX %e",10);


printf("Output double %d",DBL_MAX);
printf("Output DBL_MAX %s",10);
printf("Output double %s",DBL_MAX);

See also
StringFormat, DoubleToString, Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


331 Common Functions

ResetLastError
Sets the value of the predefined variable _LastError into zero.

void  ResetLastError();

Return Value

No return value.

Note

It should be noted that the GetLastError() function doesn't zero _LastError variable. Usually
ResetLastError() is called befor function call, after which error appearance is checked.

© 2000-2010, MetaQuotes Software Corp.


332 Common Functions

SetUserError
Sets the predefined variable _LastError into the value equal to ERR_USER_ERROR_FIRST + user_error

void  SetUserError(
ushort user_error, // error number
);

Parameters
user_error
[in] Error number set by a user.

Return Value

No return value.

Note

After an error has been set using the SetUserError(user_error) function, GetLastError() returns
value equal to ERR_USER_ERROR_FIRST + user_error.

Example:

void OnStart()
{
//--- set error number 65537=(ERR_USER_ERROR_FIRST +1)
SetUserError(1);
//--- get last error code
Print("GetLastError =",GetLastError());
/*
Result
GetLastError = 65537
*/
}

© 2000-2010, MetaQuotes Software Corp.


333 Common Functions

SendFTP
Sends a file at the address, specified in the setting window of the "Publisher" tab.

bool  SendFTP(
string  filename,  // file to send by ftp
string  ftp_path=NULL  // file to upload on ftp server
);

Parameters
filename
[in] Name of sent file.

ftp_path=NULL
[in] FTP catalog. If a directory is not specified, directory described in settings is usesd.

Return Value

In case of failure returns 'false'.

Note

Sent file must be located in the folder terminal_directory\MQL5\files or its subfolders. Sending isn't
performed if FTP address and/or access password are not specified in settings.

© 2000-2010, MetaQuotes Software Corp.


334 Common Functions

SendMail
Sends an email at the address specified in the settings window of the "Mailbox" tab.

bool  SendMail(
string  subject,  // header
string  some_text  // email text
);

Parameters
subject
[in] Email header.

some_text
[in] Email body.

Return Value

true – if an email is put into the send queue, otherwise - false.

Note

Sending can be prohibited in settings, email address can be not specified. For the error information
call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


335 Common Functions

Sleep
The function suspends execution of the current Expert Advisor or script within a specified interval.

void  Sleep(
int  milliseconds  // interval
);

Parameters
milliseconds
[in] Delay interval in milliseconds.

Return Value

No return value.

Note

The Sleep() function can't be called for custom indicators, because indicators are executed in the
interface thread and must not slow down it. The function has the built-in check of EA halt flag every
0.1 seconds.

© 2000-2010, MetaQuotes Software Corp.


336 Common Functions

TerminalClose
The function commands the terminal to complete operation.

bool  TerminalClose(
int ret_code  // closing code of the client terminal
);

Parameters
ret_code
[in] Return code, returned by the process of the client terminal at the operation completion.

Return Value

The function returns true on success, otherwise - false.

Note

The TerminalClose() function does not stop the terminal immediately, it just commands the
terminal to complete its operation.

The code of an Expert Advisor that called TerminalClose() must have all arrangements for the
immediate completion (e.g. all previously opened files must be closed in the normal mode). Call of
this function must be followed by the return operator.

The ret_code parameter allows indicating the necessary return code for analyzing reasons of the
program termination of the terminal operation when starting it from the command prompt.

Example:

//--- input parameters


input int tiks_before=500; // number of ticks till termination
input int pips_to_go=15; // distance in pips
input int seconds_st=50; // number of seconds given to the Expert Advisor
//--- globals
datetime launch_time;
int tick_counter=0;
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
Print(__FUNCTION__," reason code =",reason);
Comment("");
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
static double first_bid=0.0;

© 2000-2010, MetaQuotes Software Corp.


337 Common Functions

MqlTick tick;
double distance;
//---
SymbolInfoTick(_Symbol,tick);
tick_counter++;
if(first_bid==0.0)
{
launch_time=tick.time;
first_bid=tick.bid;
Print("first_bid =",first_bid);
return;
}
//--- price distance in pips
distance=(tick.bid-first_bid)/_Point;
//--- show a notification to track the EA operation
string comm="From the moment of start:\r\n\x25CF elapsed seconds: "+
IntegerToString(tick.time-launch_time)+" ;"+
"\r\n\x25CF ticks received: "+(string)tick_counter+" ;"+
"\r\n\x25CF price went in points: "+StringFormat("%G",distance);
Comment(comm);
//--- section for checking condition to close the terminal
if(tick_counter>=tiks_before)
TerminalClose(0); // exit by tick counter
if(distance>pips_to_go)
TerminalClose(1); // go up by the number of pips equal to pips_to_go
if(distance<-pips_to_go)
TerminalClose(-1); // go down by the number of pips equal to pips_to_go
if(tick.time-launch_time>seconds_st)
TerminalClose(100); // termination by timeout
//---
}

See also
Program running, Execution errors, Reasons for deinitialization

© 2000-2010, MetaQuotes Software Corp.


338 Common Functions

ZeroMemory
The function resets a variable passed to it by reference.

void  ZeroMemory(
void & variable  // reset variable
);

Parameters
variable
[in] [out] Variable passed by reference, you want to reset (initialize by zero values).

Return Value

No return value.

Note

If the function parameter is a string, the call will be equivalent to indicating NULL as its value.
For simple types and their arrays, as well as for structures/classes consisting of such types, this is a
simple reset.
For objects containing strings and dynamic arrays, ZeroMemory() is called for each element.
For any arrays not protected by the const modifier, this is the zeroing of all elements.
For arrays of complex objects, ZeroMemory() is called for each element.

ZeroMemory() can't be applied to classes with protected members or inheritance.

© 2000-2010, MetaQuotes Software Corp.


339 Array Functions

Group of Functions for Working with Arrays


Arrays are allowed to be maximum four-dimensional. Each dimension is indexed from 0 to
dimension_size-1. In a particular case of a one-dimensional array of 50 elements, calling of the first
element will appear as array[0], of the last one - as array[49].

Function Action

ArrayBsearch Returns index of the firs found element in the


first array dimension

ArrayCopy Copies one array into another

ArrayFree Frees up buffer of any dynamic array and sets


the size of the zero dimension in 0.

ArrayGetAsSeries Checks direction of array indexing

ArrayInitialize Sets all elements of a numeric array into a


single value

ArrayIsSeries Checks whether an array is a timeseries

ArrayIsDynamic Checks whether an array is dynamic

ArrayMaximum Search for an element with the maximal value

ArrayMinimum Search for an element with the minimal value

ArrayRange Returns the number of elements in the


specified dimension of the array

ArrayResize Sets the new size in the first dimension of the


array

ArraySetAsSeries Sets the direction of array indexing

ArraySize Returns the number of elements in the array

ArraySort Sorting of numeric arrays by the first dimension

© 2000-2010, MetaQuotes Software Corp.


340 Array Functions

ArrayBsearch
The function searches for a specified value in a one-dimension numeric array.

For searching in an array of double type

int  ArrayBsearch(
double   array[],  // array for search
double  searched_value  // what is searched for
);

For searching in an array of float type

int  ArrayBsearch(
float   array[],  // array for search
float  searched_value  // what is searched for
);

For searching in an array of long type

int  ArrayBsearch(
long   array[],  // array for search
long  searched_value  // what is searched for
);

For searching in an array of int type

int  ArrayBsearch(
int   array[],  // array for search
int  searched_value  // what is searched for
);

For searching in an array of short type

int  ArrayBsearch(
short   array[],  // array for search
short  searched_value  // what is searched for
);

For searching in an array of char type

int  ArrayBsearch(
char   array[],  // array for search
char  searched_value  // what is searched for
);

Parameters
array[]
[in] Numeric array for search.

searched_value
[in] Value for search.

© 2000-2010, MetaQuotes Software Corp.


341 Array Functions

Return Value

The function returns index of a found element. If the wanted value isn't found, the function returns
the index of an element nearest in value.

Note

Binary search processes only sorted arrays. To sort numeric arrays use the ArraySort() function.

© 2000-2010, MetaQuotes Software Corp.


342 Array Functions

ArrayCopy
It copies an array into another one.

int  ArrayCopy(
void  dst_array[],  // destination array
void  src_array[],  // source array
int  dst_start=0,  // index starting from which write into destination array
int  src_start=0,  // first index of a destination array
int  cnt=WHOLE_ARRAY // number of elements
);

Parameters
dst_array[]
[out] Destination array

src_array[]
[in] Source array

dst_start=0
[in] Starting index fro the destination array. By default, start index is 0.

src_start=0
[in] Starting index for the source array. By default, start index is 0.

cnt=-1
[in] Number of elements that should be copied. By default, the whole array is copied
(cnt=WHOLE_ARRAY).

Return Value

It returns the number of copied elements.

Note

If cnt<0 or cnt>src_size-src_start, all the remaining array part is copied. Arrays are copied from left
to right. For series arrays, the starting position is correctly defined adjusted for copying from left
to right. If an array is copied to itself, the result is undefined.

If arrays are of different types, during copying it tries to transform each element of a source array
into the type of the destination array. A string array can be copied into a string array only. Array of
classes and structures containing objects that require initialization aren't copied. An array of
structures can be copied into an array of the same type only.

© 2000-2010, MetaQuotes Software Corp.


343 Array Functions

ArrayFree
It frees up a buffer of any dynamic array and sets the size of the zero dimension to 0.

void  ArrayFree(
void  array[]  // array
);

Parameters
array[]
[in] Dynamic array.

Return Value

No return value.

© 2000-2010, MetaQuotes Software Corp.


344 Array Functions

ArrayGetAsSeries
It checks direction of an array index.

bool  ArrayGetAsSeries(
void  array  // array for checking
);

Parameters
array
[in] Checked array.

Return Value

Returns true, if the specified array has the AS_SERIES flag set, i.e. access to the array is performed
back to front as in timeseries. A timeseries differs from a usual array in that the indexing of
timeseries elements is performed from its end to beginning (from the newest data to old).

Note

To check whether an array belongs to timeseries, use the ArrayIsSeries() function. Arrays of price
data passed as input parameters into the OnCalculate() function do not obligatorily have the
indexing direction the same as in timeseries. The necessary indexing direction can be set using the
ArraySetAsSeries() function.

See also
Access to timeseries, ArraySetAsSeries

© 2000-2010, MetaQuotes Software Corp.


345 Array Functions

ArrayInitialize
The function initializes a numeric array by a preset value.

void  ArrayInitialize(
double  array[],  // initialized array
double  value  // value that will be set
);

Parameters
array[]
[out] Numeric array that should be initialized.

value
[in] New value that should be set to all array elements.

Return Value

Returns the number of initialized elements.

Note

The ArrayResize() function allows to set size of an array with a reserve for further expansion
without the physical relocation of memory. It is implemented for the better performance, because
the operations of memory relocation are reasonably slow.

Initialization of the array using ArrayInitialize(array, init_val) doesn't mean the initialization with
the same value of reserve elements allocated for this array. At further expanding of the array using
the ArrayResize() function, the elements will be added at the end of the array, their values will be
undefined and in most cases will not be equal to init_value.

Example:

void OnStart()
{
//--- dynamic array
double array[];
//--- let's set the array size for 100 elements and reserve a buffer for another 10 elements
ArrayResize(array,100,10);
//--- initialize the array elements with EMPTY_VALUE=DBL_MAX value
ArrayInitialize(array,EMPTY_VALUE);
Print("Values of 10 last elements after initialization");
for(int i=90;i<100;i++) printf("array[%d]=%G",i,array[i]);
//--- expand the array by 5 elements
ArrayResize(array,105);
Print("Values of 10 last elements after ArrayResize(array,105)");
//--- values of 5 last elements are obtained from reserve buffer
for(int i=95;i<105;i++) printf("array[%d]=%G",i,array[i]);
}

© 2000-2010, MetaQuotes Software Corp.


346 Array Functions

ArrayIsDynamic
The function checks whether an array is dynamic.

bool  ArrayIsDynamic(
void  array[]  // checked array
);

Parameters
array[]
[in] Checked array.

Return Value

It returns true if the selected array is dynamic, otherwise it returns false.

See also
Access to timeseries and indicators

© 2000-2010, MetaQuotes Software Corp.


347 Array Functions

ArrayIsSeries
The function checks whether an array is a timeseries.

bool  ArrayIsSeries(
void  array[]  // checked array
);

Parameters
array[]
[in] Checked array.

Return Value

It returns true, if a checked array is an array timeseries, otherwise it returns false. Arrays passed
as a parameter to the OnCalculate() function must be checked for the order of accessing the array
elements by ArrayGetAsSeries().

Example:

#property indicator_chart_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Label1"
#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double Label1Buffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Label1Buffer,INDICATOR_DATA);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],

© 2000-2010, MetaQuotes Software Corp.


348 Array Functions

const long &tick_volume[],


const long &volume[],
const int &spread[])
{
//---
if(ArrayIsSeries(open))
{
Print("open[] is timeseries");
}
else
{
{
Print("open[] is not timeseries!!!");
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}

See also
Access to timeseries and indicators

© 2000-2010, MetaQuotes Software Corp.


349 Array Functions

ArrayMaximum
The function searches a maximal element in a one-dimension numeric array.

int  ArrayMaximum(
double  array[],  // array for search
int  start=0  // index to start checking with
int  count=WHOLE_ARRAY,  // number of checked elements
);

Parameters
array[]
[in] A numeric array, in which search is made.

start=0
[in] Index to start checking with.

count=WHOLE_ARRAY
[in] Number of elements for search. By default, searches in the entire array (cnt=WHOLE_ARRAY
).

Return Value

The function returns an index of a found element taking into account the array serial. In case of
failure it returns -1.

© 2000-2010, MetaQuotes Software Corp.


350 Array Functions

ArrayMinimum
The function searches a minimal element in a one-dimension numeric array.

int  ArrayMinimum(
double  array[],  // array for search
int  start=0  // index to start checking with
int  count=WHOLE_ARRAY,  // number of checked elements
);

Parameters
array[]
[in] A numeric array, in which search is made.

start=0
[in] Index to start checking with.

count=WHOLE_ARRAY
[in] Number of elements for search. By default, searches in the entire array (cnt=WHOLE_ARRAY
).

Return Value

The function returns an index of a found element taking into account the array serial. In case of
failure it returns -1.

© 2000-2010, MetaQuotes Software Corp.


351 Array Functions

ArrayRange
The function returns the number of elements in a selected array dimension.

int  ArrayRange(
void  array[],  // array for check
int  rank_index  // number of dimension
);

Parameters
array[]
[in] Checked array.

rank_index
[in] Index of dimension.

Return Value

Number of elements in a selected array dimension.

Note

Since indexes are zero-based, the size of dimension is 1 greater than the largest index.

© 2000-2010, MetaQuotes Software Corp.


352 Array Functions

ArrayResize
The function sets a new size for the first dimension

int  ArrayResize(
void  array[],  // array passed by reference
int  new_size,  // new array size
int  allocated_size=0  // reserve size value (excess)
);

Parameters
array[]
[out] Array for changing sizes.

new_size
[in] New size for the first dimension.

allocated_size=0
[in] Distributed size to get reserve.

Return Value

If executed successfully, it returns count of all elements contained in the array after resizing,
otherwise, returns -1, and array is not resized.

Note

During memory allocation the allocated_size parameter is taken into account. If this parameter is
specified, it sets the size of additional memory for the array. Re-calls of ArrayResize do not result
in physical re-allocation of memory, only the first array dimension is resized within the reserved
memory.

The function can be applied only to dynamic arrays.

See also
ArrayInitialize

© 2000-2010, MetaQuotes Software Corp.


353 Array Functions

ArraySetAsSeries
The function sets the AS_SERIES flag to a selected object of a dynamic array, and elements will be
indexed like in timeseries.

bool  ArraySetAsSeries(
void  array[],  // array by reference
bool  set  // true denotes reverse order of indexing
);

Parameters
array[]
[in][out] Numeric array to set.

set
[in] Array indexing direction.

Note

The AS_SERIES flag can't be set for multi-dimensional arrays or static arrays (arrays, whose size in
square brackets is preset already on the compilation stage). Indexing in timeseries differs from a
common array in that the elements of timeseries are indexed from the end toeards the beginning
(from the newest to oldest data).

Example: Indicator that shows bar number

//+------------------------------------------------------------------+
//| BarNumber.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"
#property indicator_chart_window

© 2000-2010, MetaQuotes Software Corp.


354 Array Functions

#property indicator_buffers 1
#property indicator_plots 1
//---- plot Numeration
#property indicator_label1 "Numeration"
#property indicator_type1 DRAW_LINE
#property indicator_color1 CLR_NONE
//--- indicator buffers
double NumerationBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,NumerationBuffer,INDICATOR_DATA);
//--- set indexing for the buffer like in timeseries
ArraySetAsSeries(NumerationBuffer,true);
//--- set accuracy of showing in DataWindow
IndicatorSetInteger(INDICATOR_DIGITS,0);
//--- how the name of the indicator arry is displayed in DataWindow
PlotIndexSetString(0,PLOT_LABEL,"Bar #");
//---
return(0);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- we'll store the time of the current zero bar opening
static datetime currentBarTimeOpen=0;
//--- revert access to array time[] - do it like in timeseries
ArraySetAsSeries(time,true);
//--- If time of zero bar differs from the stored one
if(currentBarTimeOpen!=time[0])
{
//--- enumerate all bars fromthe current to the chart depth
for(int i=rates_total-1;i>=0;i--) NumerationBuffer[i]=i;
currentBarTimeOpen=time[0];

© 2000-2010, MetaQuotes Software Corp.


355 Array Functions

}
//--- return value of prev_calculated for next call
return(rates_total);
}

See also
Access to timeseries, ArrayGetAsSeries

© 2000-2010, MetaQuotes Software Corp.


356 Array Functions

ArraySize
The function returns the number of elements of a selected array.

int  ArraySize(
void  array[]  // checked array
);

Parameters
array[]
[in] Array of any type.

Return Value

Value of int type.

Note

For a one-dimensional array, the value to be returned by the ArraySize is equal to that of
ArrayRange(array,0).

© 2000-2010, MetaQuotes Software Corp.


357 Array Functions

ArraySort
The function sorts numeric arrays in ascending order from left to right.

bool  ArraySort(
number&  array[]  // array for sorting
);

Parameters
array[]
[in][out] Numeric array for sorting.

Note

An array marked by the AS_SERIES flag is sorted in descending order.

© 2000-2010, MetaQuotes Software Corp.


358 Conversion Functions

Conversion Functions
This is a group of functions that provide conversion of data from one format into another.

The NormalizeDouble() function must be specially noted as it provides the necessary accuracy of the
price presentation. In trading operations, no unnormalized prices may be used if their accuracy even a
digit exceeds that required by the trade server.

Function Action

CharToString Converting a symbol code into a one-character


string

DoubleToString Converting a numeric value to a text line with a


specified accuracy

NormalizeDouble Rounding of a floating point number to a


specified accuracy

StringToDouble Converting a string containing a symbol


representation of number into number of
double type

StringToInteger Converting a string containing a symbol


representation of number into number of int
type

StringToTime Converting a string containing time or date in


"yyyy.mm.dd [hh:mi]" format into datetime
type

TimeToString Converting a value containing time in seconds


elapsed since 01.01.1970 into a string of "yyyy.
mm.dd hh:mi" format

IntegerToString Converting int into a string of preset length

ShortToString Converting symbol code (unicode) into one-


symbol string

ShortArrayToString Copying array part into a string

StringToShortArray Symbol-wise copying a string to a selected part


of array of ushort type

CharArrayToString Converting symbol code (ansi) into one-symbol


array

StringToCharArray Symbol-wise copying a string converted from


Unicode to ANSI, to a selected place of array of
uchar type

ColorToString Converting color value into string as "R,G,B"

StringToColor Converting "R,G,B" string or string with color


name into color type value

© 2000-2010, MetaQuotes Software Corp.


359 Conversion Functions

StringFormat Converting number into string according to


preset format

© 2000-2010, MetaQuotes Software Corp.


360 Conversion Functions

CharToString
Converting a symbol code into a one-character string.
string  CharToString(
int  char_code  // numeric code of symbol
);

Parameters
char_code
[in] Code of Unicode symbol.

Return Value

String with a Unicode symbol.

© 2000-2010, MetaQuotes Software Corp.


361 Conversion Functions

CharArrayToString
It copies and converts part of array of uchar type into a returned string.

string  CharArrayToString(
uchar  array[],  // array
int  start=0,  // starting position in the array
int  count=-1  // number of sumbols
uint  codepage=CP_ACP  // code page
);

Parameters
array[]
[in] Array of uchar type.

start=0
[in] Position from which copying starts. by default 0 is used.

count=-1
[in] Number of array elements for copying. Defines the length of a resulting string. Default value
is -1, which means copying up to the array end, or till terminal 0.

codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.

Return Value

String.

© 2000-2010, MetaQuotes Software Corp.


362 Conversion Functions

ColorToString
It converts color value into string of "R,G,B" form.

string  ColorToString(
color  color_value,  // color value
bool  color_name  // show color name or not
);

Parameters
color_value
[in] Color value in color type variable.

color_name
[in] Sign of the necessity to return color name, if color name is identical to one of predefined
color constants.

Return Value

String presentation of color as "R,G,B", where R, G and B are decimal constants from 0 to 255
converted into a string. If the color_name=true parameter is set, it will try to convert color value
into color name.

Example:

string clr=ColorToString(C'0,255,0'); // green color


Print(clr);

clr=ColorToString(C'0,255,0',true); // get color constant


Print(clr);

© 2000-2010, MetaQuotes Software Corp.


363 Conversion Functions

DoubleToString
Converting numeric value into text string.

string  DoubleToString(
double  value,  // number
int  digits=8  // number of digits after decimal point
);

Parameters
value
[in] Value with a floating point.

digits
[in] Accuracy format. If the digits value is in the range between 0 and 16, a string presentation of
a number with the specified number of digits after the point will be obtained. If the digits value is
in the range between -1 and -16, a string representation of a number in the scientific format with
the specified number of digits after the decimal point will be obtained. In all other cases the string
value will contain 8 digits after the decimal point.

Return Value

String containing a symbol representation of a number with the specified accuracy.

Example:

Print("DoubleToString(120.0+M_PI) : ",DoubleToString(120.0+M_PI));
Print("DoubleToString(120.0+M_PI,16) : ",DoubleToString(120.0+M_PI,16));
Print("DoubleToString(120.0+M_PI,-16) : ",DoubleToString(120.0+M_PI,-16));
Print("DoubleToString(120.0+M_PI,-1) : ",DoubleToString(120.0+M_PI,-1));
Print("DoubleToString(120.0+M_PI,-20) : ",DoubleToString(120.0+M_PI,-20));

See also
NormalizeDouble, StringToDouble

© 2000-2010, MetaQuotes Software Corp.


364 Conversion Functions

IntegerToString
This function converting value of integer type into a string of a specified length and returns the
obtained string.

string  IntegerToString(
long  number,  // number
int  str_len=0,  // length of result string
ushort  fill_symbol=' '  // filler
);

Parameters
number
[in] Number for conversion.

str_len=0
[in] String length. If the resulting string length is larger than the specified one, the string is not
cut off. If it is smaller, filler symbols will be added to the left.

fill_symbol=' '
[in] Filler symbol. By default it is a space.

Return Value

String.

© 2000-2010, MetaQuotes Software Corp.


365 Conversion Functions

ShortToString
It converts the symbol code (unicode) into one-symbol string and returns resulting string.

string  ShortToString(
ushort  symbol_code  // symbol
);

Parameters
symbol_code
[in] Symbol code. Instead of a symbol code you can use literal string containing a symbol or a
literal string with 2-byte hexadecimal code corresponding to the symbol from the Unicode table.

Return Value

String.

© 2000-2010, MetaQuotes Software Corp.


366 Conversion Functions

ShortArrayToString
It copies part of array into a returned string.

string  ShortArrayToString(
ushort  array[],  // array
int  start=0,  // starting position in the array
int  count=-1  // number of symbols
);

Parameters
array[]
[in] Array of ushort type (analog of wchar_t type).

start=0
[in] Position, from which copying starts, Default - 0.

count=-1
[in] Number of array elements to copy. Defines the length of a resulting string. Default value is -
1, which means copying up to the array end, or till terminal 0.

Return Value

String.

© 2000-2010, MetaQuotes Software Corp.


367 Conversion Functions

TimeToString
Converting a value containing time in seconds elapsed since 01.01.1970 into a string of "yyyy.mm.dd
hh:mi" format.

string  TimeToString(
datetime  value,  // number
int  mode=TIME_DATE|TIME_MINUTES  // output format
);

Parameters
value
[in] Time in seconds from 00:00 1970/01/01.

mode=TIME_DATE|TIME_MINUTES
[in] Additional data input mode. Can be one or combined flag: TIME_DATE gets result as "yyyy.
mm.dd", TIME_MINUTES gets result as "hh:mi", TIME_SECONDS gets results as "hh:mi:ss".

© 2000-2010, MetaQuotes Software Corp.


368 Conversion Functions

NormalizeDouble
Rounding floating point number to a specified accuracy.

double  NormalizeDouble(
double  value,  // normalized number
int  digits  // number of digits after decimal point
);

Parameters
value
[in] Value with a floating point.

digits
[in] Accuracy format, number of digits after point (0-8).

Return Value

Value of double type with preset accuracy.

Note

Calculated values of StopLoss, TakeProfit, and values of open prices for pending orders must be
normalized with the accuracy, the value of which can be obtained by Digits().

Example:

double pi=M_PI;
Print("pi=",DoubleToString(pi,16));

double pi_3=NormalizeDouble(M_PI,3);
Print("NormalizeDouble(pi,3)=",DoubleToString(pi_3,16))
;
double pi_8=NormalizeDouble(M_PI,8);
Print("NormalizeDouble(pi,8)=",DoubleToString(pi_8,16));

double pi_0=NormalizeDouble(M_PI,0);
Print("NormalizeDouble(pi,0)=",DoubleToString(pi_0,16));
/*
Result:
pi= 3.1415926535897931
NormalizeDouble(pi,3)= 3.1419999999999999
NormalizeDouble(pi,8)= 3.1415926499999998
NormalizeDouble(pi,0)= 3.0000000000000000
*/

See also
DoubleToString, Real types (double, float), Reduction of types,

© 2000-2010, MetaQuotes Software Corp.


369 Conversion Functions

StringToCharArray
Symbol-wise copies a string converted from Unicode to ANSI, to a selected place of array of uchar
type. It returns the number of copied elements.

int  StringToCharArray(
string  text_string,  // source string
uchar& array[],  // array
int  start=0,  // starting position in the array
int  count=-1  // number of symbols
uint  codepage=CP_ACP  // code page
);

Parameters
text_string
[in] String to copy.

array[]
[out] Array of uchar type.

start=0
[in] Position from which copying starts. Default - 0.

count=-1
[in] Number of array elements to copy. Defines length of a resulting string. Default value is -1,
which means copying up to the array end, or till terminal 0. Terminal 0 will also be copied to the
recipient array, in this case the size of a dynamic array can be increased if necessary to the size
of the string. If the size of the dynamic array exceeds the length of the line, the size of the array
will not be reduced.

codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.

Return Value

Number of copied elements.

© 2000-2010, MetaQuotes Software Corp.


370 Conversion Functions

StringToColor
Converting "R,G,B" string or string with color name into color type value.

color  StringToColor(
string  color_string  // string representation of color
);

Parameters
color_string
[in] String representation of a color of "R,G,B" type or name of one of predefined Web-colors.

Return Value

Color value.

Example:

color str_color=StringToColor("0,127,0");
Print(str_color);
Print((string)str_color);
//--- change color a little
str_color=StringToColor("0,128,0");
Print(str_color);
Print((string)str_color);

© 2000-2010, MetaQuotes Software Corp.


371 Conversion Functions

StringToDouble
The function converts string containing a symbol representation of number into number of double
type.

double  StringToDouble(
string  value  // string
);

Parameters
value
[in] String containing a symbol representation of a number.

Return Value

Value of double type.

© 2000-2010, MetaQuotes Software Corp.


372 Conversion Functions

StringToInteger
The function converts string containing a symbol representation of number into number of int
(integer) type.

long  StringToInteger(
string  value  // string
);

Parameters
value
[in] String containing a number.

Return Value

Value of int type.

© 2000-2010, MetaQuotes Software Corp.


373 Conversion Functions

StringToShortArray
The function symbol-wise copies a string into a specified place of an array of ushort type. It returns
the number of copied elements.

int  StringToShortArray(
string  text_string,  // source string
ushort& array[],  // array
int  start=0,  // starting position in the array
int  count=-1  // number of symbols
);

Parameters
text_string
[in] String to copy

array[]
[out] Array of ushort type (analog of wchar_t type).

start=0
[in] Position, from which copying starts. Default - 0.

count=-1
[in] Number of array elements to copy. Defines length of a resulting string. Default value is -1,
which means copying up to the array end, or till terminal 0.Terminal 0 will also be copied to the
recipient array, in this case the size of a dynamic array can be increased if necessary to the size
of the string. If the size of the dynamic array exceeds the length of the line, the size of the array
will not be reduced.

Return Value

Number of copied elements.

© 2000-2010, MetaQuotes Software Corp.


374 Conversion Functions

StringToTime
The function converts a string containing time or date in "yyyy.mm.dd [hh:mi]" format into datetime
type.

datetime  StringToTime(
string  value  // date string
);

Parameters
value
[in] String in " yyyy.mm.dd hh:mi " format.

Return Value

Value of datetime type containing total number of seconds that elapsed since 01.01.1970.

© 2000-2010, MetaQuotes Software Corp.


375 Conversion Functions

StringFormat
The function formats obtained parameters and returns a string.

string  StringFormat(
string  format,  // string with format description
...  ...  // parameters
);

Parameters
format
[in] String containing method of formatting. Formatting rules are the same as for the
PrintFormat function.

...
[in] Parameters, separated by a comma.

Return Value

String.

See also
PrintFormat, DoubleToString,ColorToString, TimeToString

© 2000-2010, MetaQuotes Software Corp.


376 Math Functions

Mathematical Functions
A set of mathematical and trigonometric functions.

Function Action

MathAbs Returns absolute value (modulus) of the


specified numeric value

MathArccos Returns the arc cosine of x in radians

MathArcsin Returns the arc sine of x in radians

MathArctan Returns the arc tangent of x in radians

MathCeil Returns integer numeric value closest from


above

MathCos Returns the cosine of a number

MathExp Returns exponent of a number

MathFloor Returns integer numeric value closest from


below

MathLog Returns natural logarithm

MathMax Returns the maximal value of the two numeric


values

MathMin Returns the minimal value of the two numeric


values

MathMod Returns the real remainder after the division of


two numbers

MathPow Raises the base to the specified power

MathRand Returns a pseudorandom value within the range


of 0 to 32767

MathRound Rounds of a value to the nearest integer

MathSin Returns the sine of a number

MathSqrt Returns a square root

MathSrand Sets the starting point for generating a series


of pseudorandom integers

MathTan Returns the tangent of a number

MathIsValidNumber Checks the correctness of a real number

© 2000-2010, MetaQuotes Software Corp.


377 Math Functions

MathAbs
The function returns the absolute value (modulus) of the specified numeric value.

double  MathAbs(
double  value  // numeric value
);

Parameters
value
[in] Numeric value.

Return Value

Value of double type more than or equal to zero.

Note

Instead the MathAbs() function you can use fabs().

© 2000-2010, MetaQuotes Software Corp.


378 Math Functions

MathArccos
The function returns the arccosine of x within the range 0 to in radians.

double  MathArccos(
double  val // -1<val<1
);

Parameters
val
[in] The val value between -1 and 1, the arc cosine of which is to be calculated.

Return Value

Arc cosine of a number in radians. If val is less than -1 or more than 1, the function returns NaN
(indeterminate value).

Note

Instead of the MathArccos() function you can use acos().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


379 Math Functions

MathArcsin
The function the arc sine of x within the range of - /2 to /2 radians.

double  MathArcsin(
double  val  // -1<value<1
);

Parameters
val
[in] The val value between -1 and 1, the arc sine of which is to be calculated.

Return Value

Arc sine of the val number in radians within the range of - /2 to /2 radians. If val is less than -1
or more than 1, the function returns NaN (indeterminate value).

Note

Instead of the MathArcsin() function you can use asin().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


380 Math Functions

MathArctan
The function returns the arc tangent of x. If x is equal to 0, the function returns 0.

double  MathArctan(
double  value  // tangent
);

Parameters
value
[in] A number representing a tangent.

Return Value

MathArctan returns a value within the range of - /2 to /2 radians.

Note

Instead of the MathArctan() function you can use atan().

© 2000-2010, MetaQuotes Software Corp.


381 Math Functions

MathCeil
The function returns integer numeric value closest from above.

double  MathCeil(
double  val  // number
);

Parameters
val
[in] Numeric value.

Return Value

Numeric value representing the smallest integer that exceeds or equals to val.

Note

instead of the MathCeil() function you can use ceil().

© 2000-2010, MetaQuotes Software Corp.


382 Math Functions

MathCos
The function returns the cosine of an angle.

double  MathCos(
double  value  // number
);

Parameters
value
[in] Angle in radians.

Return Value

Value of double type within the range of -1 to 1.

Note

Instead of MathCos() you can use cos().

© 2000-2010, MetaQuotes Software Corp.


383 Math Functions

MathExp
The function returns the value of e raised to the power of d.

double  MathExp(
double  value  // power for the number e
);

Parameters
value
[in] A number specifying the power.

Return Value

A number of double type. At overflow, the function returns INF (infinity), in case of order loss
MathExp returns 0.

Note

Instead of MathExp() you can use exp().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


384 Math Functions

MathFloor
The function returns integer numeric value closest from below.

double  MathFloor(
double  val // number
);

Parameters
val
[in] Numeric value.

Return Value

A numeric value representing the largest integer that is less than or equal to val.

Note

Instead of MathFloor() you can use floor().

© 2000-2010, MetaQuotes Software Corp.


385 Math Functions

MathLog
The function returns a natural logarithm.

double  MathLog(
double  val  // value to take the logarithm
);

Parameters
val
[in] Value logarithm of which is to be found.

Return Value

The natural logarithm of val in case of success. If val is negative, the function returns NaN
(undetermined value). If val is equal to 0, the function returns INF (infinity).

Note

Instead of MathLog() you can use log().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


386 Math Functions

MathLog
Returns the logarithm of a number by base 10.

double  MathLog10(
double  val  // number to take logarithm
);

Parameters
val
[in] Numeric value the common logarithm of which is to be calculated.

Return Value

The common logarithm in case of success. If val is negative, the function returns NaN
(undetermined value). If val is equal to 0, the function returns INF (infinity).

Note

Instead of MathLog10() you can use log10().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


387 Math Functions

MathMax
The function returns the maximal value of two values.

double  MathMax(
double  value1,  // first value
double  value2  // second value
);

Parameters
value1
[in] First numeric value.

value2
[in] Second numeric value.

Return Value

The largest of the two values.

Note

Instead of MathMax() you can use fmax(). Functions fmax(), fmin(), MathMax(), MathMin() can
work with integer types without typecasting them to the type of double.

If parameters of different types are passed into a function, the parameter of the minor type is
automatically cast to the major type. The type of the return value corresponds to the major type.

If data of the same type are passed, no casting is performed.

© 2000-2010, MetaQuotes Software Corp.


388 Math Functions

MathMin
The function returns the minimal value of two values.

double  MathMin(
double  value1,  // first value
double  value2  // second value
);

Parameters
value1
[in] First numeric value.

value2
[in] Second numeric value.

Return Value

The smallest of the two values.

Note

Instead of MathMin() you can use fmin(). Functions fmax(), fmin(), MathMax(), MathMin() can work
with integer types without typecasting them to the type of double.

If parameters of different types are passed into a function, the parameter of the minor type is
automatically cast to the major type. The type of the return value corresponds to the major type.

If data of the same type are passed, no casting is performed.

© 2000-2010, MetaQuotes Software Corp.


389 Math Functions

MathMod
The function returns the real remainder of division of two numbers.

double  MathMod(
double  value,  // divident value
double  value2  // divisor value
);

Parameters
value
[in] Dividend value.

value2
[in] Divisor value.

Return Value

The MathMod function calsulates the real value of f of val / y such that val = i * y + f , where i is an
integer, f has the same sign as val, and the absolute value of f is less than the absolute value of y.

Note

Instead of MathMod() you can use fmod().

© 2000-2010, MetaQuotes Software Corp.


390 Math Functions

MathPow
The function raises a base to a specified power.

double  MathPow(
double  base,  // base
double  exponent  // exponent value
);

Parameters
base
[in] Base.

exponent
[in] Exponent value.

Return Value

Value of base raised to the specified power.

Note

Instead of MathPow() you can use pow().

© 2000-2010, MetaQuotes Software Corp.


391 Math Functions

MathRand
Returns a pseudorandom integer within the range of 0 to 32767.

int  MathRand();

Return Value

Integer value within the range of 0 to 32767.

Note

Before the first call of the function, it's necessary to call MathSrand to set the generator of
pseudorandom numbers to the initial state.

Note

Instead of MathRand() you can use rand().

© 2000-2010, MetaQuotes Software Corp.


392 Math Functions

MathRound
The function returns a value rounded off to the nearest integer of the specified numeric value.

double  MathRound(
double  value  // value to be rounded
);

Parameters
value
[in] Numeric value before rounding.

Return Value

Value rounded till to the nearest integer.

Note

Instead of MathRound() you can use round().

© 2000-2010, MetaQuotes Software Corp.


393 Math Functions

MathSin
Returns the sine of a specified angle.

double  MathSin(
double  value  // argument in radians
);

Parameters
value
[in] Angle in radians.

Return Value

Sine of an angle measured in radians. Returns value within the range of -1 to 1.

Note

Instead of MathSin() you can use sin().

© 2000-2010, MetaQuotes Software Corp.


394 Math Functions

MathSqrt
Returns the square root of a number.

double  MathSqrt(
double  value  // positive number
);

Parameters
value
[in] Positive numeric value.

Return Value

Square root of value. Of value is negative, MathSqrt returns NaN (indeterminate value).

Note

Instead of MathSqrt() you can use sqrt().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


395 Math Functions

MathSrand
Sets the starting point for generating a series of pseudorandom integers.

void  MathSrand(
int  seed  // initializing number
);

Parameters
seed
[in] Starting number for the row of random numbers.

Return Value

No return value.

Note

To re-initialize the generator (i.e. set generator into previous initial state), it's necessary to use
value 1 as the initializing parameter. Any other value for the initial number sets the generator to
the random starting point.

MathRand returns pseudorandom numbers that are generated in succession. Calling MathRand
before any call to MathSrand generates the same sequence as calling MathSrand with parameter 1.

Instead of MathSrand() you can use srand().

© 2000-2010, MetaQuotes Software Corp.


396 Math Functions

MathTan
The function returns a tangent of a number.

double  MathTan(
double  rad  // argument in radians
);

Parameters
rad
[in] Angle in radians.

Return Value

Tangent of rad. If rad is greater than or equal to 263, or less than or equal to -263, a loss of
significance in the result occurs, in which case the function returns an indefinite.

Note

Instead of MathTan() you can use tan().

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


397 Math Functions

MathIsValidNumber
It checks the correctness of a real number.

bool  MathIsValidNumber(
double  number  // number to check
);

Parameters
number
[in] Checked numeric value.

Return Value

It returns true, if the checked value is an acceptable real number. If the checked value is a plus or
minus infinity, or "not a number" (NaN), the function returns false.

Example:

double abnormal=MathArcsin(2.0);
if(!MathIsValidNumber(abnormal)) Print("Attention! MathArcsin(2.0) =",abnormal);

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


398 String Functions

String Functions
This is a group of functions intended for working with data of the string type.

Function Action

StringAdd Adds a string at the place of indicated substring

StringBufferLen Returns the size of buffer distributed for the


string

StringConcatenate Forms a string of parameters passed

StringFill Fills out a specified string by selected symbols

StringFind Search for a substring in a string

StringGetCharacter Returns the value of a number located in the


specified string position

StringInit Initializes string by specified symbols and


provides the specified string length

StringLen Returns the number of symbols in a string

StringSetCharacter Returns a copy of a string with a changed value


of a symbol in a specified position

StringSubstr Extracts a substring from a text string starting


from a specified position

StringToLower Transforms all symbols of a selected string to


lowercase by location

StringToUpper Transforms all symbols of a selected string into


capitals by location

StringTrimLeft Cuts line feed characters, spaces and tabs in


the left part of the string

StringTrimRight Cuts line feed characters, spaces and tabs in


the right part of the string

© 2000-2010, MetaQuotes Software Corp.


399 String Functions

StringAdd
The function adds a substring to the end of a string.

bool  StringAdd(
string&  string_var, // string, to which we add
string  add_substring  // string, which is added
);

Parameters
string_var
[in][out] String, to which another one is added.

add_substring
[in] String that is added ti the end of a source string.

Return Value

In case of success returns true, otherwise false. In order to get an error code, the GetLastError()
function should be called.

Note

The StringAdd() add functions is faster and memory saving, as compared to binding strings using
addition operations.

Example:

void OnStart()
{
string a="a",b="b",c;
//--- first method
int start=GetTickCount(),stop;
long i;
for(i=0;i<length;i++)
{
c=a+b;
}
stop=GetTickCount();
Print("time for 'c=a+b'=",(stop-start),"milliseconds, i =",i);

//--- second method


start=GetTickCount();
for(i=0;i<length;i++)
{
StringAdd(a,b);
}
stop=GetTickCount();
Print("time for 'StringAdd(a,b)'=",(stop-start),"milliseconds, i =",i);

//--- third method

© 2000-2010, MetaQuotes Software Corp.


400 String Functions

start=GetTickCount();
a="a"; // re-initialize variable a
for(i=0;i<length;i++)
{
int k=StringConcatenate(c,a,b);
}
stop=GetTickCount();
Print("time for 'StringConcatenate(c,a,b)'=",(stop-start),"milliseconds, i =",i);
}

See also
StringConcatenate

© 2000-2010, MetaQuotes Software Corp.


401 String Functions

StringBufferLen
The function returns the size of buffer distributed for the string.

int  StringBufferLen(
string  string_var  // string
)

Parameters
string_var
[in] String.

Return Value

The value 0 means that the string is constant and buffer size can't be changed. -1 means that the
string belongs to the client terminal, and modification of the buffer contents can have
indeterminate results.

Note

Minimal buffer size is equal to 16.

Example:

void OnStart()
{
long length=1000;
string a="a",b="b";
//---
long i;
Print("before: StringBufferLen(a) =",StringBufferLen(a),
" StringLen(a) =",StringLen(a));
for(i=0;i<length;i++)
{
StringAdd(a,b);
}
Print("after: StringBufferLen(a) =",StringBufferLen(a),
" StringLen(a) =",StringLen(a));
}

See also
StringAdd, StringInit, StringLen, StringFill

© 2000-2010, MetaQuotes Software Corp.


402 String Functions

StringConcatenate
The function forms a string of passed parameters and returns the size of the formed string.
Parameters can be of any type. Number of parameters can't be less than 2 or more than 64.

int  StringConcatenate(
string&  string_var,  // string to form
void argument1 // first parameter of any simple type
void argument2  // second parameter of any simple type
... // next parameter of any simple type
);

Parameters
string_var
[in][out] String that will be formed as a result of concatenation.

argumentN
[in] Any comma separated values. From 2 to 63 parameters of any simple type.

Return Value

Returns the string length, formed by concatenation of parameters transformed into string type.
Parameters are transformed into strings according to the sane rules as in Print() and Comment(). As
distinct from Print, in the resulting string concatenated parameters are not separated by a space.

Note

StringConcatenate() is faster and memory saving, as compared to binding strings using addition
operations, because they don't use temporary variables of string type.

See also

StringAdd

© 2000-2010, MetaQuotes Software Corp.


403 String Functions

StringFill
It fills out a selected string by specified symbols.

bool  StringFill(
string&  string_var,  // string to fill
short  character  // symbol that will fill the string
);

Parameters
string_var
[in][out] String, that will be filled out by the selected symbol.

character
[in] Symbol, by which the string will be filled out.

Return Value

In case of success returns true, otherwise - false. To get the error code call GetLastError().

Note

Filling out a string at place means that symbols are inserted directly to the string without
transitional operations of new string creation or copying. This allows to save the operation time.

Example:

void OnStart()
{
string str;
StringInit(str,20,'_');
Print("str =",str);
StringFill(str,0);
Print("str =",str,": StringBufferLen(str) =", StringBufferLen(str));
}
// Result
// str = ____________________
// str = : StringBufferLen(str) = 20
//

See also
StringBufferLen, StringLen, StringInit

© 2000-2010, MetaQuotes Software Corp.


404 String Functions

StringFind
Search for a substring in a string.

int  StringFind(
string  string_value,  // string in which search is made
string  match_substring,  // what is searched
int  start_pos=0  // from what position search starts
);

Parameters
string_value
[in] String, in which search is made.

match_substring
[in] Searched substring.

start_pos=0
[in] Position in the string from which search is started.

Return Value

Returns position number in a string, from which the searched substring starts, or -1, if the
substring is not found.

© 2000-2010, MetaQuotes Software Corp.


405 String Functions

StringGetCharacter
Returns value of a symbol, located in the specified position of a string.

ushort  StringGetCharacter(
string  string_value,  // string
int  pos  // symbol position in the string
);

Parameters
string_value
[in] String.

pos
[in] Position of a symbol in the string. Can be from 0 to StringLen(text) -1.

Return Value

Symbol code or 0 in case of an error. To get the error code call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


406 String Functions

StringInit
Initializes a string by specified symbols and provides the specified string size.

bool  StringInit(
string&  string_var,  // string to initialize
int  new_len=0,  // required string length after initialization
short  character=0  // symbol, by which the string will be filled
);

Parameters
string_var
[in][out] String that should be initialized and deinitialized.

new_len=0
[in] String length after initialization. If length=0, it deinitializes the string, i.e. the string buffer
is cleared and the buffer address is zeroed.

character=0
[in] Symbol to fill the string.

Return Value

In case of success returns true, otherwise - false. To get the error code call GetLastError().

Note

If character=0 and the length new_len>0, the buffer of the string of indicated length will be
distributed and filled by zeroes. The string length will be equal to zero, because the whole buffer is
filled out by string terminators.

Example:

void OnStart()
{
//---
string str;
StringInit(str,200,0);
Print("str =",str,": StringBufferLen(str) =",
StringBufferLen(str)," StringLen(str) =",StringLen(str));
}
/* Result
str = : StringBufferLen(str) = 200 StringLen(str) = 0
*/

See also
StringBufferLen, StringLen

© 2000-2010, MetaQuotes Software Corp.


407 String Functions

StringLen
Returns the number of symbols in a string.

int  StringLen(
string  string_value  // string
);

Parameters
string_value
[in] String to calculate length.

Return Value

Number of symbols in a string without the ending zero.

© 2000-2010, MetaQuotes Software Corp.


408 String Functions

StringSetCharacter
Returns copy of a string with a changed character in a specified position.

bool  StringSetCharacter(
string&   string_var,  // string
int  pos,  // position
ushort  character  // character
);

Parameters
string_var
[in][out] String.

pos
[in] Position of a character in a string. Can be from 0 to StringLen(text).

character
[in] Symbol code Unicode.

Note

If pos is less than string length and the symbol code value = 0, the string is cut off (but the buffer
size, distributed for the stringremains unchanged). The string length becomes equal to pos.

If pos is equal to string length, the specified symbol is added at the string end, and the length is
enlarged by one.

Example:

void OnStart()
{
string str="0123456789";
Print("before: str =",str,",StringBufferLen(str) =",
StringBufferLen(str)," StringLen(str) =",StringLen(str));
//--- add zero value in the middle
StringSetCharacter(str,6,0);
Print(" after: str =",str,",StringBufferLen(str) =",
StringBufferLen(str)," StringLen(str) =",StringLen(str));
//--- add symbol at the end
int size=StringLen(str);
StringSetCharacter(str,size,'+');
Print("addition: str =",str,",StringBufferLen(str) =",
StringBufferLen(str)," StringLen(str) =",StringLen(str));
}
/* Result
before: str = 0123456789 ,StringBufferLen(str) = 0 StringLen(str) = 10
after: str = 012345 ,StringBufferLen(str) = 16 StringLen(str) = 6
addition: str = 012345+ ,StringBufferLen(str) = 16 StringLen(str) = 7
*/

© 2000-2010, MetaQuotes Software Corp.


409 String Functions

See also

StringBufferLen, StringLen, StringFill, StringInit

© 2000-2010, MetaQuotes Software Corp.


410 String Functions

StringSubstr
Extracts a substring from a text string starting from the specified position.

string  StringSubstr(
string  string_value,  // string
int  start_pos,  // position to start with
int  length=-1  // length of extracted string
);

Parameters
string_value
[in] String to extract a substring from.

start_pos
[in] Initial position of a substring. Can be from 0 to StringLen(text) -1.

length=-1
[in] Length of an extracted substring. If the parameter value is equal to -1 or parameter isn't set,
the substring will be extracted from the indicated position till the string end.

Return Value

Copy of a extracted substring, if possible. Otherwise returns an empty string.

© 2000-2010, MetaQuotes Software Corp.


411 String Functions

StringToLower
Transforms all all symbols of a selected string into lowercase by location.

bool  StringToLower(
string&  string_var  // string to process
);

Parameters
string_var
[in][out] String.

Return Value

In case of success returns true, otherwise - false. To get the error code call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


412 String Functions

StringToUpper
Transforms all all symbols of a selected string into capitals by location.

bool  StringToUpper(
string&  string_var  // string to process
);

Parameters
string_var
[in][out] String.

Return Value

In case of success returns true, otherwise - false. To get the error code call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


413 String Functions

StringTrimLeft
The function cuts line feed characters, spaces and tabs in the left part of the string till the first
meaningful symbol. The string is modified at place.

int  StringTrimLeft(
string&  string_var  // string to cut
);

Parameters
string_var
[in][out] String that will be cut from the left.

Return Value

Returns the number of cut symbols.

© 2000-2010, MetaQuotes Software Corp.


414 String Functions

StringTrimRight
The function cuts line feed characters, spaces and tabs in the right part of the string after the last
meaningful symbol. The string is modified at place.

int  StringTrimRight(
string&  string_var  // string to cut
);
);

Parameters
string_var
[in][out] String that will be cut from the right.

Return Value

Returns the number of cut symbols.

© 2000-2010, MetaQuotes Software Corp.


415 Date and Time

Date and Time


This is the group of functions for working with data of datetime type (an integer that represents the
number of seconds elapsed from 0 hours of January 1, 1970).

Function Action

TimeCurrent Returns the last known server time (time of the


last quote receipt) in the datetime format

TimeTradeServer Returns the current calculation time of the


trade server

TimeLocal Returns the local computer time in datetime


format

TimeGMT Returns GMT in datetime format with the


Daylight Saving Time by local time of the
computer, where the client terminal is running

TimeDaylightSavings Returns the sign of Daylight Saving Time switch

TimeGMTOffset Returns the current difference between GMT


time and the local computer time in seconds,
taking into account DST switch

TimeToStruct Converts a datetime value into a variable of


MqlDateTime structure type

StructToTime Converts a variable of MqlDateTime structure


type into a datetime value

© 2000-2010, MetaQuotes Software Corp.


416 Date and Time

TimeCurrent
Returns the last known server time server, time of the last quote receipt for one of the symbols
selected in the "Market Watch" window. In the OnTick() handler, this function returns the time of the
received handled tick. In other cases (for example, call in handlers OnInit(), OnDeinit(), OnTimer()
and so on) this is the time of the last quote receipt for any symbol available in the "Market Watch"
window, the time shown in the title of this window. The time value is formed on a trade server and
does not depend on the time settings on your computer. There are 2 variants of the function.

Call without parameters

datetime  TimeCurrent();

Call with MqlDateTime type parameter

datetime  TimeCurrent(
MqlDateTime&  dt_struct  // structure type variable
);

Parameters
dt_struct
[out] MqlDateTime structure type variable.

Return Value

Value of datetime type

Note

If the MqlDateTime structure type variable has been passed as a parameter, it is filled accordingly.

© 2000-2010, MetaQuotes Software Corp.


417 Date and Time

TimeTradeServer
Returns the calculated current time of the trade server. Unlike TimeCurrent(), the calculation of the
time value is performed in the client terminal and depends on the time settings on your computer.
There are 2 variants of the function.

Call without parameters

datetime  TimeTradeServer();

Call with MqlDateTime type parameter

datetime  TimeTradeServer(
MqlDateTime&  dt_struct  // Variable of structure type
);

Parameters
dt_struct
[out] Variable of structure type MqlDateTime.

Return Value

Value of datetime type

Note

If the MqlDateTime structure type variable has been passed as a parameter, it is filled accordingly.

© 2000-2010, MetaQuotes Software Corp.


418 Date and Time

TimeLocal
Returns the local time of a computer, where the client terminal is running. There are 2 variants of the
function.

Call without parameters

datetime  TimeLocal();

Call with MqlDateTime type parameter

datetime  TimeLocal(
MqlDateTime&  dt_struct  // Variable of structure type
);

Parameters
dt_struct
[out] Variable of structure type MqlDateTime.

Return Value

Value of datetime type

Note

If the MqlDateTime structure type variable has been passed as a parameter, it is filled accordingly.

© 2000-2010, MetaQuotes Software Corp.


419 Date and Time

TimeGMT
Returns the GMT, which is calculated taking into account the DST switch by the local time on the
computer where the client terminal is running. There are 2 variants of the function.

Call without parameters

datetime  TimeGMT();

Call with MqlDateTime type parameter

datetime  TimeGMT(
MqlDateTime&  dt_struct  // Variable of structure type
);

Parameters
dt_struct
[out] Variable of structure type MqlDateTime.

Return Value

Value of datetime type

Note

If the MqlDateTime structure type variable has been passed as a parameter, it is filled accordingly.

© 2000-2010, MetaQuotes Software Corp.


420 Date and Time

TimeDaylightSavings
Returns correction for daylight saving time in seconds, switch to summer time has been made. It
depends on the time settings of your computer.

int  TimeDaylightSavings();

Return Value

If switch to winter (standard) time has been made, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


421 Date and Time

TimeGMTOffset
Returns the current difference between GMT time and the local computer time in seconds, taking into
account switch to winter or summer time. Depends on the time settings of your computer.

int  TimeGMTOffset();

Return Value

The value of int type, representing the current difference between the local time of the computer
and GMT time in seconds.

© 2000-2010, MetaQuotes Software Corp.


422 Date and Time

TimeToStruct
Converts a value of datetime type (number of seconds since 01.01.1970) into a structure variable
MqlDateTime.

void  TimeToStruct(
datetime  dt,  // date and time
MqlDateTime&  dt_struct  // structure for the adoption of values
);

Parameters
dt
[in] Date value to convert.

dt_struct
[out] Variable of structure type MqlDateTime.

Return Value

No return value.

© 2000-2010, MetaQuotes Software Corp.


423 Date and Time

StructToTime
Converts a structure variable MqlDateTime into a value of datetime type and returns the resulting
value.

datetime  StructToTime(
MqlDateTime$  dt_struct  // structure of the date and time
);

Parameters
dt_struct
[in] Variable of structure type MqlDateTime.

Return Value

The value of datetime type containing the number of seconds since 01.01.1970.

© 2000-2010, MetaQuotes Software Corp.


424 Account Information

Account Information
Functions that return parameters of the current account.

Function Action

AccountInfoDouble Returns a value of double type of the


corresponding account property

AccountInfoInteger Returns a value of integer type (bool, int or


long) of the corresponding account property

AccountInfoString Returns a value string type corresponding


account property

© 2000-2010, MetaQuotes Software Corp.


425 Account Information

AccountInfoDouble
Returns the value of the corresponding account property.

double  AccountInfoDouble(
int  property_id  // identifier of the property
);

Parameters
property_id
[in] Identifier of the property. The value can be one of the values of
ENUM_ACCOUNT_INFO_DOUBLE.

Return Value

Value of double type.

Example:

void OnStart()
{
//--- show all the information available from the function AccountInfoDouble()
printf("ACCOUNT_BALANCE = %G",AccountInfoDouble(ACCOUNT_BALANCE));
printf("ACCOUNT_CREDIT = %G",AccountInfoDouble(ACCOUNT_CREDIT));
printf("ACCOUNT_PROFIT = %G",AccountInfoDouble(ACCOUNT_PROFIT));
printf("ACCOUNT_EQUITY = %G",AccountInfoDouble(ACCOUNT_EQUITY));
printf("ACCOUNT_MARGIN = %G",AccountInfoDouble(ACCOUNT_MARGIN));
printf("ACCOUNT_FREEMARGIN = %G",AccountInfoDouble(ACCOUNT_FREEMARGIN));
printf("ACCOUNT_MARGIN_LEVEL = %G",AccountInfoDouble(ACCOUNT_MARGIN_LEVEL));
printf("ACCOUNT_MARGIN_SO_CALL = %G",AccountInfoDouble(ACCOUNT_MARGIN_SO_CALL));
printf("ACCOUNT_MARGIN_SO_SO = %G",AccountInfoDouble(ACCOUNT_MARGIN_SO_SO));
}

See also
SymbolInfoDouble, SymbolInfoString, SymbolInfoInteger, PrintFormat

© 2000-2010, MetaQuotes Software Corp.


426 Account Information

AccountInfoInteger
Returns the value of the properties of the account.

long  AccountInfoInteger(
int  property_id  // Identifier of the property
);

Parameters
property_id
[in] Identifier of the property. The value can be one of the values of
ENUM_ACCOUNT_INFO_INTEGER.

Return Value

Value of long type.

Note

The property must be one of the bool, int or long types.

Example:

void OnStart()
{
//--- show all the information available from the function AccountInfoInteger()
printf("ACCOUNT_LOGIN = %d",AccountInfoInteger(ACCOUNT_LOGIN));
printf("ACCOUNT_LEVERAGE = %d",AccountInfoInteger(ACCOUNT_LEVERAGE));
bool thisAccountTradeAllowed=AccountInfoInteger(ACCOUNT_TRADE_ALLOWED);
bool EATradeAllowed=AccountInfoInteger(ACCOUNT_TRADE_EXPERT);
ENUM_ACCOUNT_TRADE_MODE tradeMode=AccountInfoInteger(ACCOUNT_TRADE_MODE);
ENUM_ACCOUNT_STOPOUT_MODE stopOutMode=AccountInfoInteger(ACCOUNT_MARGIN_SO_MODE);

//--- Inform about the possibility to perform a trade operation


if(thisAccountTradeAllowed)
Print("Trade for this account is permitted");
else
Print("Trade for this account is prohibited!");

//--- Find out if it is possible to trade on this account by Expert Advisors


if(EATradeAllowed)
Print("Trade by Expert Advisors is permitted for this account");
else
Print("Trade by Expert Advisors is prohibited for this account!");

//--- Find out the account type


switch(tradeMode)
{
case(ACCOUNT_TRADE_MODE_DEMO):
Print("This is a demo account");
break;

© 2000-2010, MetaQuotes Software Corp.


427 Account Information

case(ACCOUNT_TRADE_MODE_CONTEST):
Print("This is a competition account");
break;
default:Print("This is a real account!");
}

//--- Find out the StopOut level setting mode


switch(stopOutMode)
{
case(ACCOUNT_STOPOUT_MODE_PERCENT):
Print("The StopOut level is specified percentage");
break;
default:Print("The StopOut level is specified in monetary terms");
}
}

See also
Account Information

© 2000-2010, MetaQuotes Software Corp.


428 Account Information

AccountInfoString
Returns the value of the corresponding account property.

string  AccountInfoString(
int  property_id  // Identifier of the property
);

Parameters
property_id
[in] Identifier of the property. The value can be one of the values of
ENUM_ACCOUNT_INFO_STRING.

Return Value

Value of string type.

Example:

void OnStart()
{
//--- Show all the information available from the function AccountInfoString()
Print("The name of the broker =",AccountInfoString(ACCOUNT_COMPANY));
Print("Deposit currency =",AccountInfoString(ACCOUNT_CURRENCY));
Print("Client name =",AccountInfoString(ACCOUNT_NAME));
Print("The name of the trade server =",AccountInfoString(ACCOUNT_SERVER));
}

See also
Account Information

© 2000-2010, MetaQuotes Software Corp.


429 Checkup

State Checking
Functions that return parameters of the current state of the client terminal

Function Action

GetLastError Returns the last error

IsStopped Returns true, if an mql5 program has been


commanded to stop its operation

UninitializeReason Returns the code of the reason for


deinitialization

TerminalInfoInteger Returns an integer value of a corresponding


property of the mql5 program environment

TerminalInfoString Returns a string value of a corresponding


property of the mql5 program environment

MQL5InfoInteger Returns an integer value of a corresponding


property of a running mql5 program

MQL5InfoString Returns a string value of a corresponding


property of a running mql5 program

Symbol Returns the name of a symbol of the current


chart

Period Returns the current chart timeframe

Digits Returns the number of decimal digits


determining the accuracy of the price value of
the current chart symbol

Point Returns the point size of the the current symbol


in the quote currency

© 2000-2010, MetaQuotes Software Corp.


430 Checkup

GetLastError
Returns the contents of the system variable _LastError.

int  GetLastError();

Return Value

Returns the value of the last error that occurred during the execution of an mql5 program.

Note

After the function call, the contents of _LastError are not reset. To reset this variable, you need to
call ResetLastError().

© 2000-2010, MetaQuotes Software Corp.


431 Checkup

IsStopped
Checks the forced shutdown of an mql5 program.

bool  IsStopped();

Return Value

Returns true, if the _StopFlag system variable contains a value other than 0. A nonzero value is
written into _StopFlag, if a mql5 program has been commanded to complete its operation. In this
case, you must immediately terminate the program, otherwise the program will be completed
forcibly from the outside after 3 seconds.

© 2000-2010, MetaQuotes Software Corp.


432 Checkup

UninitializeReason
Returns the code of a reason for deinitialization.

int  UninitializeReason();

Return Value

Returns the value of _UninitReason which is formed before OnDeinit() is called. Value depends on
the reasons that led to deinitialization.

© 2000-2010, MetaQuotes Software Corp.


433 Checkup

TerminalInfoInteger
Returns the value of a corresponding property of the mql5 program environment.

int  TerminalInfoInteger(
int  property_id  // identifier of a property
);

Parameters
property_id
[in] Identifier of a property. Can be one one of the values of the enumeration
ENUM_TERMINAL_INFO_INTEGER.

Return Value

Value of int type.

© 2000-2010, MetaQuotes Software Corp.


434 Checkup

TerminalInfoString
the function returns the value of a corresponding property of the mql5 program environment. The
property must be of string type.

string  TerminalInfoString(
int  property_id  // identifier of a property
);

Parameters
property_id
[in] Identifier of a property. Perhaps one of the values of the enumeration
ENUM_TERMINAL_INFO_STRING.

Return Value

Value of string type.

© 2000-2010, MetaQuotes Software Corp.


435 Checkup

MQL5InfoInteger
Returns the value of a corresponding property of a running mql5 program.

int  MQL5InfoInteger(
int  property_id  // identifier of a property
);

Parameters
property_id
[in] Identifier of a property. Cam be one of values of the ENUM_MQL5_INFO_INTEGER
enumeration.

Return Value

Value of int type.

© 2000-2010, MetaQuotes Software Corp.


436 Checkup

MQL5InfoString
Returns the value of a corresponding property of a running mql5 program.

string  MQL5InfoString(
int  property_id  // Identifier of a property
);

Parameters
property_id
[in] Identifier of a property. Can be one of the ENUM_MQL5_INFO_STRING enumeration.

Return Value

Value of string type.

© 2000-2010, MetaQuotes Software Corp.


437 Checkup

Symbol
Returns the name of a symbol of the current chart.

string  Symbol();

Return Value

Value of the _Symbol system variable, which stores the name of the current chart symbol.

© 2000-2010, MetaQuotes Software Corp.


438 Checkup

Period
Returns the current chart timeframe.

ENUM_TIMEFRAMES  Period();

Return Value

The contents of the _Period variable that contains the value of the current chart timeframe. The
value can be one of the values of the ENUM_TIMEFRAMES enumeration.

See also

PeriodSeconds, Chart timeframes, Date and Time, Visibility of objects

© 2000-2010, MetaQuotes Software Corp.


439 Checkup

Digits
Returns the number of decimal digits determining the accuracy of price of the current chart symbol.

int  Digits();

Return Value

The value of the _Digits variable which stores the number of decimal digits determining the
accuracy of price of the current chart symbol.

© 2000-2010, MetaQuotes Software Corp.


440 Checkup

Point
Returns the point size of the current symbol in the quote currency.

double  Point();

Return Value

The value of the _Point variable which stores the point size of the current symbol in the quote
currency.

© 2000-2010, MetaQuotes Software Corp.


441 Market Info

Getting Market Information


These are functions intended for receiving information about the market state.

Function Action

SymbolsTotal Returns the number of available (selected in


Market Watch or all) symbols

SymbolName Returns the name of a specified symbol

SymbolSelect Selects a symbol in the Market Watch window


or removes a symbol from the window

SymbolIsSynchronized Checks whether data of a selected symbol in


the terminal are synchronized with data on the
trade server

SymbolInfoDouble Returns the double value of the symbol for the


corresponding property

SymbolInfoInteger Returns a value of an integer type (long,


datetime, int or bool) of a specified symbol for
the corresponding property

SymbolInfoString Returns a value of the string type of a specified


symbol for the corresponding property

SymbolInfoTick Returns the current prices for the specified


symbol in a variable of the MqlTick type

MarketBookAdd Provides opening of Depth of Market for a


selected symbol, and subscribes for receiving
notifications of the DOM changes

MarketBookRelease Provides closing of Depth of Market for a


selected symbol, and cancels the subscription
for receiving notifications of the DOM changes

MarketBookGet Returns a structure array MqlBookInfo


containing records of the Depth of Market of a
specified symbol

© 2000-2010, MetaQuotes Software Corp.


442 Market Info

SymbolsTotal
Returns the number of available (selected in Market Watch or all) symbols.

int  SymbolsTotal(
bool  selected  // True - only symbols in MarketWatch
);

Parameters
selected
[in] Request mode. Can be true or false.

Return Value

If the 'selected' parameter is true, the function returns the number of symbols selected in
MarketWatch. If the value is false, it returns the total number of all symbols.

© 2000-2010, MetaQuotes Software Corp.


443 Market Info

SymbolName
Returns the name of a symbol.

string  SymbolName(
int  pos,  // number in the list
bool  selected  // true - only symbols in MarketWatch
);

Parameters
pos
[in] Order number of a symbol.

selected
[in] Request mode. If the value is true, the symbol is taken from the list of symbols selected in
MarketWatch. If the value is false, the symbol is taken from the general list.

Return Value

Value of string type with the symbol name.

© 2000-2010, MetaQuotes Software Corp.


444 Market Info

SymbolSelect
Selects a symbol in the Market Watch window or removes a symbol from the window.

bool  SymbolSelect(
string  name,  // symbol name
bool  select  // add or remove
);

Parameters
name
[in] Symbol name.

select
[in] Switch. If the value is false, a symbol should be removed from MarketWatch, otherwise a
symbol should be selected in this window. A symbol can't be removed if the symbol chart is open,
or there are open positions for this symbol.

Return Value

In case of failure returns false.

© 2000-2010, MetaQuotes Software Corp.


445 Market Info

SymbolIsSynchronized
The function checks whether data of a selected symbol in the terminal are synchronized with data on
the trade server.

bool  SymbolIsSynchronized(
string  name,  // symbol name
);

Parameters
name
[in] Symbol name.

Return value

If data are synchronized, returns 'true'; otherwise returns 'false'.

See also
SymbolInfoInteger, Organizing Data Access

© 2000-2010, MetaQuotes Software Corp.


446 Market Info

SymbolInfoDouble
Returns the corresponding property of a specified symbol. There are 2 variants of the function.

1. Immediately returns the property value.

double  SymbolInfoDouble(
string  name,  // symbol
int  prop_id  // identifier of the property
);

2. Returns true or false depending on whether a function is successfully performed. In case of success,
the value of the property is placed into a recipient variable, passed by reference by the last
parameter.

bool  SymbolInfoDouble(
string  name,  // symbol
int  prop_id, // identifier of the property
double&  double_var  // here we assume the property value
);

Parameters
name
[in] Symbol name.

prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM_SYMBOL_INFO_DOUBLE enumeration.

double_var
[out] Variable of double type receiving the value of the requested property.

Return Value

The value of double type.

Example:

void OnTick()
{
//--- obtain spread from the symbol properties
bool spreadfloat=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD_FLOAT);
string comm=StringFormat("Spread %s = %I64d points\r\n",
spreadfloat?"floating":"fixed",
SymbolInfoInteger(Symbol(),SYMBOL_SPREAD));
//--- now let's calculate the spread by ourselves
double ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
double bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
double spread=ask-bid;
int spread_points=(int)MathRound(spread/SymbolInfoDouble(Symbol(),SYMBOL_POINT));
comm=comm+"Calculated spread = "+(string)spread_points+" points";

© 2000-2010, MetaQuotes Software Corp.


447 Market Info

Comment(comm);
}

© 2000-2010, MetaQuotes Software Corp.


448 Market Info

SymbolInfoInteger
Returns the corresponding property of a specified symbol. There are 2 variants of the function.

1. Immediately returns the property value.

long  SymbolInfoInteger(
string  name,  // symbol
int  prop_id  // identifier of a property

);

2. Returns true or false depending on whether a function is successfully performed. In case of success,
the value of the property is placed into a recipient variable, passed by reference by the last
parameter.

bool  SymbolInfoInteger(
string  name,  // symbol
int  prop_id, // identifier of a property
long&  long_var  // here we assume the property value
);

Parameters
name
[in] Symbol name.

prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM_SYMBOL_INFO_INTEGER enumeration.

long_var
[out] Variable of the long type receiving the value of the requested property.

Return Value

The value of int type.

Example:

void OnTick()
{
//--- obtain spread from the symbol properties
bool spreadfloat=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD_FLOAT);
string comm=StringFormat("Spread %s = %I64d points\r\n",
spreadfloat?"floating":"fixed",
SymbolInfoInteger(Symbol(),SYMBOL_SPREAD));
//--- now let's calculate the spread by ourselves
double ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
double bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
double spread=ask-bid;
int spread_points=(int)MathRound(spread/SymbolInfoDouble(Symbol(),SYMBOL_POINT));

© 2000-2010, MetaQuotes Software Corp.


449 Market Info

comm=comm+"Calculated spread = "+(string)spread_points+" points";


Comment(comm);
}

© 2000-2010, MetaQuotes Software Corp.


450 Market Info

SymbolInfoString
Returns the corresponding property of a specified symbol. There are 2 variants of the function.

1. Immediately returns the property value.

string  SymbolInfoString(
string  name,  // Symbol
int  prop_id  // Identifier properties
);

2. Returns true or false, depending on the success of a function. If successful, the value of the
property is placed in a foster variables passed by reference the last parameter.

bool  SymbolInfoString(
string  name,  // Symbol
int  prop_id, // Identifier properties
string& string_var  // Here we assume the property value
);

Parameters
name
[in] Symbol name.

prop_id
[in] Identifier of a symbol property. The value can be one of the values of the
ENUM_SYMBOL_INFO_STRING enumeration.

string_var
[out] Variable of the string type receiving the value of the requested property.

Return Value

The value of string type.

© 2000-2010, MetaQuotes Software Corp.


451 Market Info

SymbolInfoTick
The function returns current prices of a specified symbol in a variable of the MqlTick type.

bool  SymbolInfoTick(
string  symbol,  // symbol name
MqlTick&  tick   // reference to a structure
);

Parameters
symbol
[in] Symbol name.

book[]
[out] Link to the structure of the MqlTick type, to which the current prices and time of the last
price update will be placed.

Return Value

The function returns true if successful, otherwise returns false.

© 2000-2010, MetaQuotes Software Corp.


452 Market Info

MarketBookAdd
Provides opening of Depth of Market for a selected symbol, and subscribes for receiving notifications
of the DOM changes.

bool  MarketBookAdd(
string  symbol  // symbol
);

Parameters
symbol
[in] The name of a symbol, whose Depth of Market is to be used in the Expert Advisor or script.

Return Value

The true value if opened successfully, otherwise false.

Note

Normally, this function must be called from the OnInit() function or in the class constructor. To
handle incoming alerts, in the Expert Advisor program must contain the function void OnBookEvent
(string& symbol).

See also
Structure of Depth of Market, Structures and Classes

© 2000-2010, MetaQuotes Software Corp.


453 Market Info

MarketBookRelease
Provides closing of Depth of Market for a selected symbol, and cancels the subscription for receiving
notifications of the DOM changes.

bool  MarketBookRelease(
string  symbol  // symbol
);

Parameters
symbol
[in] Symbol name.

Return Value

The true value if closed successfully, otherwise false.

Note

Normally, this function must be called from the OnDeinit() function, if the corresponding
MarketBookAdd() function has been called in the OnInit() function. Or it must be called from the
class destructor, if the corresponding MarketBookAdd() function has been called from the class
constructor.

See also
Structure of Depth of Market, Structures and Classes

© 2000-2010, MetaQuotes Software Corp.


454 Market Info

MarketBookGet
Returns a structure array MqlBookInfo containing records of the Depth of Market of a specified
symbol.

bool  MarketBookGet(
string  symbol,  // symbol
MqlBookInfo&  book[]  // reference to an array
);

Parameters
symbol
[in] Symbol name.

book[]
[in] Reference to an array of Depth of Market records. The array can be pre-allocated for a
sufficient number of records. If a dynamic array hasn't been pre-allocated in the operating
memory, the client terminal will distribute the array itself.

Return Value

Returns true in case of success, otherwise false.

Note

The Depth of Market must be pre-opened by the MarketBookAdd() function.

Example:

MqlBookInfo priceArray[];
bool getBook=MarketBookGet(NULL,priceArray);
if(getBook)
{
int size=ArraySize(priceArray);
Print("MarketBookInfo for ",Symbol());
for(int i=0;i<size;i++)
{
Print(i+":",priceArray[i].price
+" Volume="+priceArray[i].volume,
" type =",priceArray[i].type);
}
}
else
{
Print("Could not get contents of the symbol DOM",Symbol());
}

See also
Structure of Depth of Market, Structures and Classes

© 2000-2010, MetaQuotes Software Corp.


455 Timeseries and Indicators Access

Access to Timeseries and Indicator Data


These are functions for working with timeseries and indicators. A timeseries differs from the usual
data array by its reverse ordering - elements of timeseries are indexed from the end of an array to its
begin (from the most recent data to the oldest ones). To copy the time-series values and indicator
data, it's recommended to use dynamic arrays only, because copying functions are designed to allocate
the necessary size of arrays that receive values.

It is historically accepted that an access to the price data in an array is performed from the end of
the data. Physically, the new data are always written at the array end, but the index of the array is
always equal to zero. The 0 index in the timeseries array denotes data of the current bar, i.e. the bar
that corresponds to the unfinished time interval in this timeframe.

A timeframe is the time period, during which a single price bar is formed. There are 21 predefined
standard timeframes.

The Organizing Data Access section describes details of receiving, storing and requesting price data
in the MetaTrader 5 client terminal.

Function Action

SeriesInfoInteger Returns information about the state of


historical data.

Bars Returns the number of bars the history for a


specified symbol and period.

BarsCalculated Returns the number of calculated data in an


indicator buffer or -1 in the case of error (data
hasn't been calculated yet).

IndicatorRelease Remove the indicator handle and release the


calculation block of the indicator, if it no one

© 2000-2010, MetaQuotes Software Corp.


456 Timeseries and Indicators Access

else enjoys.

IndicatorCreate Returns the handle to the specified technical


indicator created by an array of type
parameters MqlParam.

CopyBuffer Gets data of a specified buffer from a specified


indicator into an array.

CopyRates Gets history data of the Rates structure for a


specified symbol and period into an array.

CopyTime Gets history data on bar opening time for a


specified symbol and period into an array.

CopyOpen Gets history data on bar opening price for a


specified symbol and period into an array.

CopyHigh Gets history data on maximal bar price for a


specified symbol and period into an array.

CopyLow Gets history data on minimal bar price for a


specified symbol and period into an array.

CopyClose Gets history data on bar closing price for a


specified symbol and period into an array.

CopyTickVolume Gets history data on tick volumes for a


specified symbol and period into an array.

CopyRealVolume Gets history data on trade volumes for a


specified symbol and period into an array.

CopySpread Gets history data on spreads for a specified


symbol and period into an array.

Despite the fact that by using the ArraySetAsSeries() function it is possible to set up in arrays
access to elements like that in timeseries, it should be remembered that the array elements are
physically stored in one and the same order - only indexing direction changes. To demonstrate this
fact let's perform an example:

datetime TimeAsSeries[];
//--- set access to the array like to a timeseries
ArraySetAsSeries(TimeAsSeries,true);
ResetLastError();
int copied=CopyTime(NULL,0,0,10,TimeAsSeries);
if(copied<=0)
{
Print("The copy operation of the open time values for last 10 bars has failed");
return;
}
Print("TimeCurrent =",TimeCurrent());
Print("ArraySize(Time) =",ArraySize(TimeAsSeries));
int size=ArraySize(TimeAsSeries);
for(int i=0;i<size;i++)

© 2000-2010, MetaQuotes Software Corp.


457 Timeseries and Indicators Access

{
Print("TimeAsSeries["+i+"] =",TimeAsSeries[i]);
}

datetime ArrayNotSeries[];
ArraySetAsSeries(ArrayNotSeries,false);
ResetLastError();
copied=CopyTime(NULL,0,0,10,ArrayNotSeries);
if(copied<=0)
{
Print("The copy operation of the open time values for last 10 bars has failed");
return;
}
size=ArraySize(ArrayNotSeries);
for(int i=size-1;i>=0;i--)
{
Print("ArrayNotSeries["+i+"] =",ArrayNotSeries[i]);
}

As a result we will get the output like this:

TimeCurrent = 2009.06.11 14:16:23


ArraySize(Time) = 10
TimeAsSeries[0] = 2009.06.11 14:00:00
TimeAsSeries[1] = 2009.06.11 13:00:00
TimeAsSeries[2] = 2009.06.11 12:00:00
TimeAsSeries[3] = 2009.06.11 11:00:00
TimeAsSeries[4] = 2009.06.11 10:00:00
TimeAsSeries[5] = 2009.06.11 09:00:00
TimeAsSeries[6] = 2009.06.11 08:00:00
TimeAsSeries[7] = 2009.06.11 07:00:00
TimeAsSeries[8] = 2009.06.11 06:00:00
TimeAsSeries[9] = 2009.06.11 05:00:00

ArrayNotSeries[9] = 2009.06.11 14:00:00


ArrayNotSeries[8] = 2009.06.11 13:00:00
ArrayNotSeries[7] = 2009.06.11 12:00:00
ArrayNotSeries[6] = 2009.06.11 11:00:00
ArrayNotSeries[5] = 2009.06.11 10:00:00
ArrayNotSeries[4] = 2009.06.11 09:00:00
ArrayNotSeries[3] = 2009.06.11 08:00:00
ArrayNotSeries[2] = 2009.06.11 07:00:00
ArrayNotSeries[1] = 2009.06.11 06:00:00
ArrayNotSeries[0] = 2009.06.11 05:00:00

As we see from the output, as the index of TimeAsSeries array increases, the time value of the
index decreases, i.e. we move from the present to the past. For the common array ArrayNotSeries the
result is different - as index grows, we move from past to present.

See Also

© 2000-2010, MetaQuotes Software Corp.


458 Timeseries and Indicators Access

ArrayIsDynamic, ArrayGetAsSeries, ArraySetAsSeries, ArrayIsSeries

© 2000-2010, MetaQuotes Software Corp.


459 Timeseries and Indicators Access

Organizing Data Access


In this section questions connected with obtaining, storing and requesting price data (timeseries)
are considered.

Receiving Data from a Trade Server

Before price data become available in the MetaTrader 5 terminal, they must be received and
processed. To receive data, connection to the MetaTrader 5 trade server must be established. Data
are received in the form of packed blocks of minute bars from the server upon the request of a
terminal.

The mechanism of server reference for data doesn't depend on how the request has been initiated -
by a user when navigating in a chart or in a program way in the MQL5 language.

Storing Intermediate Data

Data received from a server are automatically unpacked and saved in the HCC intermediate
formate. Data on each symbol are written into a separate folder: terminal_directory\bases\
server_name\history\symbol_name. For example, data on EURUSD received from the MetaQuotes-
Demo server will be stored in terminal_directory\bases\MetaQuotes-Demo\history\EURUSD\.

Data are written into files with .hcc extension. Each file stores data of minute bars for one year.
For example, the file named 2009.hcc in the EURUSD folder contains minute bars of EURUSD for year
2009. These files are used for preparing price data for all timeframes and are not intended for direct
access.

Obtaining Data on a Necessary Timeframe out of Intermediate Data

Intermediate HCC files are used as the data source for building price data for requested timeframes
in the HC format. Data of HC format are timeseries that are maximally prepared for a quick access.
They are created upon a request of a chart or a mql5 program. The volume of data should not exceed
the value of the "Max bars in charts" charts. Data are stored for further using in files with hc
extension.

To save resources, data on a timeframe are stored and saved in RAM only if necessary. If not called
long, they are released form RAM and saved into a file. For each timeframe, data are prepared
regardless of whether there are ready data for other timeframes or not. Rules of forming and
accessing data are the same for all timeframes. It means, despite the fact that the unit data stored in
HCC is one minute, the availability of HCC data doesn't mean the availability of data on M1 timeframe
as HC in the same volume.

Receipt of new data from a server calls automatic update of used price data in HC format of all
timeframes. It also leads to the recalculation of all indicators that implicitly use them as input data for
calculations.

Parameter "Max bars in chart"

The "Max bars in charts" parameter restricts number of bars in HC format available to charts,
indicators and mql5 programs. This is valid for all available timeframes and serves, first of all, to
save computer resources.

© 2000-2010, MetaQuotes Software Corp.


460 Timeseries and Indicators Access

When setting a large value of this parameter, it should be remembered, that if deep history price
data for small timeframes are available, memory used for storing timeseries and indicator buffers can
become hundreds of megabytes and reach the RAM restriction for the client terminal program (2Gb for
32-bit applications of MS Windows).

Change of the "Max bars in charts" comes into effect after the client terminal is restarted. Change
of this parameter causes neither automatic referring to a server for additional data, nor forming of
additional bars of timeseries. Additional price data are requested from the server, and timeseries are
updated taking into account the new limitation, in case of either chart scroll to the area with no data,
or when data are requested by a mql5 program.

Volume of data requested from the server corresponds to the required number of bars of this
timeframe with the "Max bars in charts" parameter taken into account. The restriction set by this
parameter is not strict, and in some cases the number of available bars for a timeframe can be a little
more than the current parameter value.

Data Availability

Presence of data on HCC format or even in the prepared for using HC format does not always
denote the absolute availability if these data to be shown in a chart or used in mql5 programs.

When accessing to price data or indicator values from a mql5 program it should be remembered that
their availability in a certain moment of time or starting from a certain moment of time is not
guaranteed. It is connected with the fact that with the purpose of saving resources, the full copy of
data necessary for a mql5 program isn't stored in MetaTrader 5; only direct access to the terminal
data base is given.

The price history for all timeframes is built from common data of HCC format, and any update of
data from a server leads to the update of data for all timeframes and to the recalculation of
indicators. Due to this access to data can be closed, even if these data were available a moment ago.

Synchronization of the Terminal Data and Server Data

Since a mql5 program can call data fro any symbol and timeframe, there is a possibility that data of
a necessary timeseries are not formed yet in the terminal or the necessary price data aren't
synchronized with the trade server. In this case it's hard to predict the latency time.

Algorithms using latency cycles are not the best solution. The only exception in this case are scripts,
because they do not have any alternative algorithm choice due to not having event handling. For
custom indicators such algorithms, as well as as any other latency cycles are strongly not
recommended, because they lead to termination of calculation of all indicators and any other handling
of price data of the symbol.

For Expert Advisors and indicators, it is better to use the even model of handling. If during handling
of OnTick() or OnCalculate() event, data receipt for the required timeseries failed, you should exit the
event handler, relying on the access availability during the next call of the handler.

Example of a Script for Adding History


Let's consider the example of a script that executes a request to receive history for the selected
symbol from a trade server. The script is intended for running in a chart of a selected symbol;
timeframe doesn't matter, because, as it was mentioned above, price data are received from a trade

© 2000-2010, MetaQuotes Software Corp.


461 Timeseries and Indicators Access

server as packed one minute data, from which any predefined timeseries is constructed then.

Write all actions concerning data receipt as a separate function CheckLoadHistory(symbol,


timeframe, start_date):

int CheckLoadHistory(string symbol,ENUM_TIMEFRAMES period,datetime start_date)


{
}

The CheckLoadHistory() function is designed as a universal function that can be called from any
program (Expert Advisor, script or indicator); and therefore it requires three input parameters:
symbol name, period and start date to indicate the beginning of price history you need.

Insert necessary checks into the function code before requesting the missing history. First of all, we
should make sure that the symbol name and period value are correct:

if(symbol==NULL || symbol=="") symbol=Symbol();


if(period==PERIOD_CURRENT) period=Period();

Then let's make sure that the symbol is available in the MarketWatch window, i.e., the history for
the symbol will be available when sending a request to a trade server. If there is no such a symbol in
MarketWatch, add it using the SymbolSelect() function.

if(!SymbolInfoInteger(symbol,SYMBOL_SELECT))
{
if(GetLastError()==ERR_MARKET_UNKNOWN_SYMBOL) return(-1);
SymbolSelect(symbol,true);
}

Now we should receive the start date of the available history for the indicated symbol/period pair.
Perhaps, the value of the input parameter startdate, passed to CheckLoadHistory(), is within the
available history; then request to a trade server is not needed. In order to obtain the very first date
for the symbol-period as of the moment, the SeriesInfoInteger() function with the SERIES_FIRSTDATE
modifier is used.

SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date);
if(first_date>0 && first_date<=start_date) return(1);

The next important check is checking the type of the program, from which the function is called.
Note, sending request to update the timeseries with the same period as that of the indicator, that
calls the update, is undesirable. The undesirability of requesting data on the same symbol-period as
that of the indicator is conditioned by the fact that update of history data is performed in the same
thread where the indicator operates. So the possibility of clinch occurrence is high. To check this use
the MQL5InfoInteger() function with the MQL5_PROGRAM_TYPE modifier.

if(MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR && Period()==period && Symbol()==symbol


return(-4);

If all the checks have been passed successfully, make the last attempt to d without referring to the
trade server. First let's find out the start date, for which minute data in HCC format are available.
Request this value using the SeriesInfoInteger() function with the SERIES_TERMINAL_FIRSTDATE
modifier and again compare it to the value of the start_date parameter.

© 2000-2010, MetaQuotes Software Corp.


462 Timeseries and Indicators Access

if(SeriesInfoInteger(symbol,PERIOD_M1,SERIES_TERMINAL_FIRSTDATE,first_date))
{
//--- there is loaded data to build timeseries
if(first_date>0)
{
//--- force timeseries build
CopyTime(symbol,period,first_date+PeriodSeconds(period),1,times);
//--- check date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(2);
}
}

If after all the checks the execution thread is still in the body of the CheckLoadHistory() function, it
means there is a necessity to request the missing price data from a trade server. First, return the
value of "Max bars in chart" using the TerminalInfoInteger() function:

int max_bars=TerminalInfoInteger(TERMINAL_MAXBARS);

We'll need it to prevent requesting extra data. Then find the very first date in the symbol history on
the trade server (regardless of the period) using already known function SeriesInfoInteger() with the
SERIES_SERVER_FIRSTDATE modifier.

datetime first_server_date=0;
while(!SeriesInfoInteger(symbol,PERIOD_M1,SERIES_SERVER_FIRSTDATE,first_server_date) && !IsStopp
Sleep(5);

Since the request is an asynchronous operation, the function is called in the cycle with a small delay
of 5 milliseconds until the first_server_date variable receives a value, or the cycle execution is
terminated by a user (IsStopped() will return true in this case). Let's indicate a correct value of the
start date, starting from which we request price data from a trade server.

if(first_server_date>start_date) start_date=first_server_date;
if(first_date>0 && first_date<first_server_date)
Print("Warning: first server date",first_server_date,"for",symbol,"does not match to first se

If the start date first_server_date of the server is lower than the start date first_date of the symbol
in HCC format, the corresponding entry will be output in the journal.

Now we are ready to make a request to a trade server asking for missing price data. Make the
request in the form of a cycle and start filling out its body:

while(!IsStopped())
{
//1. wait for synchronization between the re-built timeseries and intermediate history as HHC
//2. receive the current number of bars n this timeseries
// if bars is larger than Max_bars_in_chart, we can exit, work is over
//3. obtain the start date first_date in the re-built timeseries and compare it to start_date
// if first_date is lower than start_date, we can exit, work is over
//4. request from a server a new part of history - 100 bars starting from last available bar
}

The first three points are implemented by already known means.

© 2000-2010, MetaQuotes Software Corp.


463 Timeseries and Indicators Access

while(!IsStopped())
{
//--- 1.wait till timeseries re-build process is over
while(!SeriesInfoInteger(symbol,period,SERIES_SYNCRONIZED) && !IsStopped())
Sleep(5);
//--- 2.request how many bars we have
int bars=Bars(symbol,period);
if(bars>0)
{
//--- bars more than can be drawn in the chart, exit
if(bars>=max_bars) return(-2);
//--- 3. return the current start date in the timeseries
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
// start date was earlier than that requested, task completed
if(first_date>0 && first_date<=start_date) return(0);
}
//4. Request from a server a new part of history - 100 bars starting from last available bar
}

The last fourth point is left - requesting history. We can't refer to a server directly, but any Copy-
function automatically initiates request sending to a server, if the history in HCC format is not
enough. Since the time of the very first start date in the first_date variable is the simple and natural
criterion to evaluate the request execution degree, then the easiest way is to use the CopyTime()
function.

When calling functions that copy any data from timeseries, it should be noted that the start
parameter (number of the bar, starting from which price data should be coped) must always be within
the available terminal history. If you have only 100 bars, it meaningless to try copying 300 bars
starting from the bar with the index 500. Such a request will be understood as an erroneous and won't
be handled, i.e. no additional history will be loaded from a trade server.

That's why we'll copy by 100 bars starting from the bar with the bars index. This will provide the
smooth loading of missing history from a trade server. Actually a little more than the requested 100
bars will be loaded, while server sends oversized history.

int copied=CopyTime(symbol,period,bars,100,times);

After the copying operation, we should analyze the number of copied elements. If the attempt fails,
then value of the copied will be equal to null and the value of the fail_cnt counter will be increased by
1. After 100 failing attempts, the operation of the function will be stopped.

int fail_cnt=0;

© 2000-2010, MetaQuotes Software Corp.


464 Timeseries and Indicators Access

...
int copied=CopyTime(symbol,period,bars,100,times);
if(copied>0)
{
//--- check data
if(times[0]<=start_date) return(0); // the copied value is smaller, ready
if(bars+copied>=max_bars) return(-2); // bars are more than can be drawn in the chart, ready
fail_cnt=0;
}
else
{
//--- no more than 100 failing attempts in succession
fail_cnt++;
if(fail_cnt>=100) return(-5);
Sleep(10);
}

So, not only correct handling of the current situation at each moment of execution is implemented
in the function, but also the termination code is returned, that can be handled after calling the
CheckLoadHistory() function for getting additional information. For example, this way:

int res=CheckLoadHistory(InpLoadedSymbol,InpLoadedPeriod,InpStartDate);
switch(res)
{
case -1 : Print("Unknown symbol",InpLoadedSymbol); break;
case -2 : Print("More requested bars than can be drawn in the chart"); break;
case -3 : Print("Execution stopped by user"); break;
case -4 : Print("Indicator mustn't load its own data"); break;
case -5 : Print("Loading failed"); break;
case 0 : Print("All data loaded"); break;
case 1 : Print("Already available data in timeseries are enough"); break;
case 2 : Print("Timeseries is built from available terminal data"); break;
default : Print("Execution result undefined");
}

The full code of the function can be found in the example of a script that shows the correct
organization of access to any data with the handling of request results.

Code:

//+------------------------------------------------------------------+
//| TestLoadHistory.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.02"
#property script_show_inputs
//--- input parameters
input string InpLoadedSymbol="NZDUSD"; // Symbol to be load
input ENUM_TIMEFRAMES InpLoadedPeriod=PERIOD_H1; // Period to be load
input datetime InpStartDate=D'2006.01.01'; // Start date
//+------------------------------------------------------------------+
//| Script program start function |

© 2000-2010, MetaQuotes Software Corp.


465 Timeseries and Indicators Access

//+------------------------------------------------------------------+
void OnStart()
{
Print("Start load",InpLoadedSymbol+","+GetPeriodName(InpLoadedPeriod),"from",InpStartDate);
//---
int res=CheckLoadHistory(InpLoadedSymbol,InpLoadedPeriod,InpStartDate);
switch(res)
{
case -1 : Print("Unknown symbol",InpLoadedSymbol); break;
case -2 : Print("Requested bars more than max bars in chart"); break;
case -3 : Print("Program was stopped"); break;
case -4 : Print("Indicator shouldn't load its own data"); break;
case -5 : Print("Load failed"); break;
case 0 : Print("Loaded OK"); break;
case 1 : Print("Loaded previously"); break;
case 2 : Print("Loaded previously and built"); break;
default : Print("Unknown result");
}
//---
datetime first_date;
SeriesInfoInteger(InpLoadedSymbol,InpLoadedPeriod,SERIES_FIRSTDATE,first_date);
int bars=Bars(InpLoadedSymbol,InpLoadedPeriod);
Print("First date",first_date,"-",bars,"bars");
//---
}
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
int CheckLoadHistory(string symbol,ENUM_TIMEFRAMES period,datetime start_date)
{
datetime first_date=0;
datetime times[100];
//--- check symbol & period
if(symbol==NULL || symbol=="") symbol=Symbol();
if(period==PERIOD_CURRENT) period=Period();
//--- check if symbol is selected in the MarketWatch
if(!SymbolInfoInteger(symbol,SYMBOL_SELECT))
{
if(GetLastError()==ERR_MARKET_UNKNOWN_SYMBOL) return(-1);
SymbolSelect(symbol,true);
}
//--- check if data is present
SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date);
if(first_date>0 && first_date<=start_date) return(1);
//--- don't ask for load of its own data if it is an indicator
if(MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR && Period()==period && Symbol()==symbol
return(-4);
//--- second attempt

© 2000-2010, MetaQuotes Software Corp.


466 Timeseries and Indicators Access

if(SeriesInfoInteger(symbol,PERIOD_M1,SERIES_TERMINAL_FIRSTDATE,first_date))
{
//--- there is loaded data to build timeseries
if(first_date>0)
{
//--- force timeseries build
CopyTime(symbol,period,first_date+PeriodSeconds(period),1,times);
//--- check date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(2);
}
}
//--- max bars in chart from terminal options
int max_bars=TerminalInfoInteger(TERMINAL_MAXBARS);
//--- load symbol history info
datetime first_server_date=0;
while(!SeriesInfoInteger(symbol,PERIOD_M1,SERIES_SERVER_FIRSTDATE,first_server_date) && !IsStopp
Sleep(5);
//--- fix start date for loading
if(first_server_date>start_date) start_date=first_server_date;
if(first_date>0 && first_date<first_server_date)
Print("Warning: first server date",first_server_date,"for",symbol,"does not match to first se
//--- load data step by step
int fail_cnt=0;
while(!IsStopped())
{
//--- wait for timeseries build
while(!SeriesInfoInteger(symbol,period,SERIES_SYNCRONIZED) && !IsStopped())
Sleep(5);
//--- ask for built bars
int bars=Bars(symbol,period);
if(bars>0)
{
if(bars>=max_bars) return(-2);
//--- ask for first date
if(SeriesInfoInteger(symbol,period,SERIES_FIRSTDATE,first_date))
if(first_date>0 && first_date<=start_date) return(0);
}
//--- copying of next part forces data loading
int copied=CopyTime(symbol,period,bars,100,times);
if(copied>0)
{
//--- check for data
if(times[0]<=start_date) return(0);
if(bars+copied>=max_bars) return(-2);
fail_cnt=0;
}
else

© 2000-2010, MetaQuotes Software Corp.


467 Timeseries and Indicators Access

{
//--- no more than 100 failed attempts
fail_cnt++;
if(fail_cnt>=100) return(-5);
Sleep(10);
}
}
//--- stopped
return(-3);
}
//+------------------------------------------------------------------+
//| returns string value of the period |
//+------------------------------------------------------------------+
string GetPeriodName(ENUM_TIMEFRAMES period)
{
if(period==PERIOD_CURRENT) period=Period();
//---
switch(period)
{
case PERIOD_M1: return("M1");
case PERIOD_M2: return("M2");
case PERIOD_M3: return("M3");
case PERIOD_M4: return("M4");
case PERIOD_M5: return("M5");
case PERIOD_M6: return("M6");
case PERIOD_M10: return("M10");
case PERIOD_M12: return("M12");
case PERIOD_M15: return("M15");
case PERIOD_M20: return("M20");
case PERIOD_M30: return("M30");
case PERIOD_H1: return("H1");
case PERIOD_H2: return("H2");
case PERIOD_H3: return("H3");
case PERIOD_H4: return("H4");
case PERIOD_H6: return("H6");
case PERIOD_H8: return("H8");
case PERIOD_H12: return("H12");
case PERIOD_D1: return("Daily");
case PERIOD_W1: return("Weekly");
case PERIOD_MN1: return("Monthly");
}
//---
return("unknown period");
}

© 2000-2010, MetaQuotes Software Corp.


468 Timeseries and Indicators Access

SeriesInfoInteger
Returns information about the state of historical data. There are 2 variants of function calls.

Directly returns the property value.

long  SeriesInfoInteger(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
ENUM_SERIES_INFO_INTEGER  prop_id,  // property identifier
);

Returns true or false depending on the success of the function run.

bool  SeriesInfoInteger(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
ENUM_SERIES_INFO_INTEGER  prop_id,  // property ID
long&  long_var  // variable for getting info
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

prop_id
[in] Identifier of the requested property, value of the ENUM_SERIES_INFO_INTEGER enumeration.

long_var
[out] Variable to which the value of the requested property is placed.

Return Value

In the first case, it returns value of the long type.

For the second case, it returns true, if the specified property is available and it's value has been
placed into long_var variable, otherwise it returns false. For more details about an error, call
GetLastError().

Example:

void OnStart()
{
//---
Print("Total number of bars for the symbol-period at this moment =",
SeriesInfoInteger(Symbol(),0,SERIES_BARS_COUNT));

Print("The first date for the symbol-period at this moment =",


(datetime)SeriesInfoInteger(Symbol(),0,SERIES_FIRSTDATE));

© 2000-2010, MetaQuotes Software Corp.


469 Timeseries and Indicators Access

Print("The first date in the history for the symbol-period on the server =",
(datetime)SeriesInfoInteger(Symbol(),0,SERIES_SERVER_FIRSTDATE));

Print("Symbol data are synchronized =",


(bool)SeriesInfoInteger(Symbol(),0,SERIES_SYNCRONIZED));
}

© 2000-2010, MetaQuotes Software Corp.


470 Timeseries and Indicators Access

Bars
Returns the number of bars count in the history for a specified symbol and period. There are 2
variants of functions calls.

Request all of the history bars

int  Bars(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
);

Request the history bars for the selected time interval

int  Bars(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time  // end date and time
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

start_time
[in] Bar time corresponding to the first element.

stop_time
[in] Bar time corresponding to the last element.

Return Value

If the start_time and stop_time parameters are defined, the function returns the number of bars in
the specified time interval, otherwise it returns the total number of bars.

Note

If data for the timeseries with specified parameters are not formed in the terminal by the time of
the Bars() function call, or data of the timeseries are not synchronized with a trade server by the
moment of the function call, the function returns a zero value.

Sample:

© 2000-2010, MetaQuotes Software Corp.


471 Timeseries and Indicators Access

int bars=Bars(_Symbol,_Period);
if(bars>0)
{
Print("Number of bars in the terminal history for the symbol-period at the moment =",bars);
}
else //no available bars
{
//--- data on the symbol might be not synchronized with data on the server
bool synchronized=false;
//--- loop counter
int attempts=0;
// make 5 attempts to wait for synchronization
while(attempts<5)
{
if(SeriesInfoInteger(Symbol(),0,SERIES_SYNCRONIZED))
{
//--- synchronization done, exit
synchronized=true;
break;
}
//--- increase the counter
attempts++;
//--- wait 10 milliseconds till the nest iteration
Sleep(10);
}
//--- exit the loop after synchronization
if(synchronized)
{
Print("Number of bars in the terminal history for the symbol-period at the moment =",bars)
Print("The first date in the terminal history for the symbol-period at the moment =",
(datetime)SeriesInfoInteger(Symbol(),0,SERIES_FIRSTDATE));
Print("The first date in the history for the symbol on the server =",
(datetime)SeriesInfoInteger(Symbol(),0,SERIES_SERVER_FIRSTDATE));
}
//--- synchronization of data didn't happen
else
{
Print("Failed to get number of bars for ",_Symbol);
}
}

See also
Event Processing Functions

© 2000-2010, MetaQuotes Software Corp.


472 Timeseries and Indicators Access

BarsCalculated
Returns the number of calculated data for the specified indicator.

int  BarsCalculated(
int  indicator_handle,  // indicator handle
);

Parameters
indicator_handle
[in] The indicator handle, returned by the corresponding indicator function.

Return Value

Returns the amount of calculated data in the indicator buffer or -1 in the case of error (data not
calculated yet)

Note

The function is useful when it's necessary to get the indicator data immediately after its creation
(indicator handle is available).

Example:

void OnStart()
{
double Ups[];
//--- set timeseries ordering for the the arrays
ArraySetAsSeries(Ups,true);
//--- create handle for the Fractal Indicator
int FractalsHandle=iFractals(NULL,0);
//--- reset the error code
ResetLastError();
//--- try to copy the indicator values
int i,copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Sleep(50);
for(i=0;i<100;i++)
{
if(BarsCalculated(FractalsHandle)>0)
break;
Sleep(50);
}
copied=CopyBuffer(FractalsHandle,0,0,1000,Ups);
if(copied<=0)
{
Print("Failed to copy upper fractals. Error =",GetLastError(),
"i=",i," copied=",copied);
return;
}

© 2000-2010, MetaQuotes Software Corp.


473 Timeseries and Indicators Access

else
Print("Upper fractals copied",
"i=",i," copied=",copied);
}
else Print("Upper fractals copied. ArraySize =",ArraySize(Ups));
}

© 2000-2010, MetaQuotes Software Corp.


474 Timeseries and Indicators Access

IndicatorCreate
The function returns the handle of a specified technical indicator created based on the array of
parameters of MqlParam type.

int  IndicatorCreate(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // timeframe
ENUM_INDICATOR   indicator_id,  // indicator type from the enumeration ENUM_
int  parameters_cnt=0,  // number of parameters
const MqlParam& parameters_array[]=NULL,  // array of parameters
);

Parameters
symbol
[in] Name of a symbol, on data of which the indicator is calculated. NULL means the current
symbol.

period
[in] The value of the timeframe can be one of values of the ENUM_TIMEFRAMES enumeration, 0
means the current timeframe.

indicator_id
[in] Indicator type, can be one of values of the ENUM_INDICATOR enumeration.

parameters_cnt
[in] The number of parameters passed in the parameters_array[] array. The array elements have a
special structure type MqlParam. By default, zero - parameters are not passed. If you specify a
non-zero number of parameters, the parameter parameters_array is obligatory. You can pass no
more than 256 parameters.

parameters_array[]=NULL
[in] An array of MqlParam type, whose elements contain the type and value of each input
parameter of a technical indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

If the indicator handle of IND_CUSTOM type is created, the type field of the first element of the
array of input parameters parameters_array must have the TYPE_STRING value of the
ENUM_DATATYPE enumeration, and the string_value field of the first element must contain the
name of the custom indicator. The custom indicator must be compiled (file with EX5 extension) and
located in the directory MQL5/Indicators of the client terminal or in a subdirectory.

If the first form of the call is used in a custom indicator, you can additionally indicate as the last
parameter on what data it will be calculated when passing input parameters. If the "Apply to"
parameter is not specified explicitly, the default calculation is based on the PRICE_CLOSE values.

Example:

© 2000-2010, MetaQuotes Software Corp.


475 Timeseries and Indicators Access

void OnStart()
{
MqlParam params[];
int h_MA,h_MACD;
//--- create iMA("EURUSD",PERIOD_M15,8,0,MODE_EMA,PRICE_CLOSE);
ArrayResize(params,4);
//--- set ma_period
params[0].type =TYPE_INT;
params[0].integer_value=8;
//--- set ma_shift
params[1].type =TYPE_INT;
params[1].integer_value=0;
//--- set ma_method
params[2].type =TYPE_INT;
params[2].integer_value=MODE_EMA;
//--- set applied_price
params[3].type =TYPE_INT;
params[3].integer_value=PRICE_CLOSE;
//--- create MA
h_MA=IndicatorCreate("EURUSD",PERIOD_M15,IND_MA,4,params);
//--- create iMACD("EURUSD",PERIOD_M15,12,26,9,h_MA);
ArrayResize(params,4);
//--- set fast ma_period
params[0].type =TYPE_INT;
params[0].integer_value=12;
//--- set slow ma_period
params[1].type =TYPE_INT;
params[1].integer_value=26;
//--- set smooth period for difference
params[2].type =TYPE_INT;
params[2].integer_value=9;
//--- set indicator handle as applied_price
params[3].type =TYPE_INT;
params[3].integer_value=h_MA;
//--- create MACD based on moving average
h_MACD=IndicatorCreate("EURUSD",PERIOD_M15,IND_MACD,4,params);
//--- use indicators
//--- . . .
//--- release indicators (first h_MACD)
IndicatorRelease(h_MACD);
IndicatorRelease(h_MA);
}

© 2000-2010, MetaQuotes Software Corp.


476 Timeseries and Indicators Access

IndicatorRelease
The function removes an indicator handle and release the calculation block of the indicator, if it's not
used by anyone else.

bool  IndicatorRelease(
int  indicator_handle,  // indicator handle
);

Returned value

Returns true in case of success, otherwise returns false.

Note

The function allows removing an indicator handle, if it's no longer needed, thus saving memory. The
handle is removed immediately, the calculation block is deleted in some time (if it's not called
anymore).

Example:

//+------------------------------------------------------------------+
//| Test_IndicatorRelease.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"
//--- input parameters
input int MA_Period=15;
input int MA_shift=0;
input ENUM_MA_METHOD MA_smooth=MODE_SMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
//--- will store indicator handle
int MA_handle;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- create indicator handle
MA_handle=iMA(Symbol(),0,MA_Period,MA_shift,MA_smooth,price);
//---
return(0);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- if the global variable value is not set

© 2000-2010, MetaQuotes Software Corp.


477 Timeseries and Indicators Access

if(GlobalVariableCheck("MA_value")==0)
{
//--- dynamic array for the indicator values
double v[];
//--- obtain the indicator value in the last two bars
if(CopyBuffer(MA_handle,0,0,2,v)==2 && v[1]!=EMPTY_VALUE)
{
//--- remember in the global variable value on the last but one bar
if(GlobalVariableSet("MA_value",v[1]))
{
//--- free the handle of the indicator
if(!IndicatorRelease(MA_handle))
Print("IndicatorRelease() failed. Error",GetLastError());
}
}
}
//---
}

© 2000-2010, MetaQuotes Software Corp.


478 Timeseries and Indicators Access

CopyBuffer
Gets data of a specified buffer of a certain indicator in the necessary quantity. There are 3 variants
of function calls.

Call by the first position and the number of required elements

int  CopyBuffer(
int  indicator_handle,  // indicator handle
int  buffer_num,  // indicator buffer number
int  start_pos,  // start position
int  count,  // amount to copy
double  buffer[]  // target array to copy
);

Call by the start date and the number of required elements

int  CopyBuffer(
int  indicator_handle,  // indicator handle
int  buffer_num,  // indicator buffer number
datetime  start_time,  // start date and time
int  count,  // amount to copy
double  buffer[] // target array to copy
);

Call by the start and end dates of a required time interval

int  CopyBuffer(
int  indicator_handle,  // indicator handle
int  buffer_num,  // indicator buffer number
datetime  start_time,  // start date and time
datetime  stop_time,  // end date and time
double   buffer[] // target array to copy
);

Parameters
indicator_handle
[in] The indicator handle, returned by the corresponding indicator function.

buffer_num
[in] The indicator buffer number.

start_pos
[in] The position of the first element to copy.

count
[in] Data count to copy.

start_time
[in] Bar time, corresponding to the first element.

stop_time

© 2000-2010, MetaQuotes Software Corp.


479 Timeseries and Indicators Access

[in] Bar time, corresponding to the last element.

buffer[]
[out] Array of double type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

Counting of elements of copied data (indicator buffer with the index buffer_num) from the starting
position is performed from the present to the past, i.e., starting position of 0 means the current
bar (indicator value for the current bar).

It is recommended to use a dynamic array as a buffer[] recipient buffer, because the CopyBuffer()
function tries to allocate the size of the receiving array to the size of the copied data. If an
indicator buffer (array that is pre-allocated for storing indicator values by the SetIndexBufer()
function) is used as the buffer[] recipient array, partial copying is allowed. An example can be found
in the Awesome_Oscillator.mql5 custom indicator in the standard terminal package.

If you need to make a partial copy of the indicator values into another array (non-indicator buffer),
you should use an intermediate array, to which the desired number is copied. After that conduct the
element-wise copying of the required number of values into the required places if a receiving array
from this intermediate one.

Example:

//+------------------------------------------------------------------+
//| TestCopyBuffer3.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"

#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot MA
#property indicator_label1 "MA"
#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input bool AsSeries=true;
input int period=15;
input ENUM_MA_METHOD smootMode=MODE_EMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
input int shift=0;

© 2000-2010, MetaQuotes Software Corp.


480 Timeseries and Indicators Access

//--- indicator buffers


double MABuffer[];
int ma_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
Print("Parameter AsSeries =",AsSeries);
Print("Indicator buffer after SetIndexBuffer() is a timeseries =",
ArrayGetAsSeries(MABuffer));
//--- set short indicator name
IndicatorSetString(INDICATOR_SHORTNAME,"MA("+period+")"+AsSeries);
//--- set AsSeries(dependes from input parameter)
ArraySetAsSeries(MABuffer,AsSeries);
Print("Indicator buffer after ArraySetAsSeries(MABuffer,true); is a timeseries =",
ArrayGetAsSeries(MABuffer));
//---
ma_handle=iMA(Symbol(),0,period,shift,smootMode,price);
return(0);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- check if all data calculated
if(BarsCalculated(ma_handle)<rates_total) return(0);
//--- we can copy not all data
int to_copy;
if(prev_calculated>rates_total || prev_calculated<=0) to_copy=rates_total;
else
{
to_copy=rates_total-prev_calculated;
//--- last value is always copied
to_copy++;
}

© 2000-2010, MetaQuotes Software Corp.


481 Timeseries and Indicators Access

//--- try to copy


if(CopyBuffer(ma_handle,0,0,to_copy,MABuffer)<=0) return(0);
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+

See also

Properties of Custom Indicators, SetIndexBuffer

© 2000-2010, MetaQuotes Software Corp.


482 Timeseries and Indicators Access

CopyRates
Gets history data of MqlRates structure of a specified symbol-period in specified quantity into the
rates_array array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyRates(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
MqlRates rates_array[]  // target array to copy
);

Call by the start date and the number of required elements

int  CopyRates(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
MqlRates rates_array[]  // target array to copy
);

Call by the start and end dates of a required time interval

int  CopyRates(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // end date and time
MqlRates rates_array[]  // target array to copy
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

start_time
[in] Bar time for the first element to copy.

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

stop_time

© 2000-2010, MetaQuotes Software Corp.


483 Timeseries and Indicators Access

[in] Bar time, corresponding to the last element to copy.

rates_array[]
[out] Array of MqlRates type.

Return Value

Returns the number of copied elements or -1 in case of an error.

Note

The elements ordering of the copied data is from present to the past, i.e., starting position of 0
means the current bar.

Example:

void OnStart()
{
//---
MqlRates rates[];
ArraySetAsSeries(rates,true);
int copied=CopyRates(Symbol(),0,0,100,rates);
if(copied>0)
{
Print("Bars copied:"+copied);
string format="open=%G, high=%G, low=%G, close=%G, volume=%d";
string out;
int size=fmin(copied,10);
for(int i=0;i<size;i++)
{
out=i+":"+TimeToString(rates[i].time);
out=out+" "+StringFormat(format,
rates[i].open,
rates[i].high,
rates[i].low,
rates[i].close,
rates[i].tick_volume);
Print(out);
}
}
else Print("Failed to get history data for the symbol",Symbol());
}

See also
Structures and Classes, TimeToString, StringFormat

© 2000-2010, MetaQuotes Software Corp.


484 Timeseries and Indicators Access

CopyTime
The function gets to time_array history data of bar opening time for the specified symbol-period pair
in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyTime(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
datetime  time_array[] // target array to copy open times
);

Call by the start date and the number of required elements

int  CopyTime(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
datetime  time_array[] // target array to copy open times
);

Call by the start and end dates of a required time interval

int  CopyTime(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
datetime  time_array[] // target array to copy open times
);

Parameters
symbol_name
[in] Symbol name.

timeframe

© 2000-2010, MetaQuotes Software Corp.


485 Timeseries and Indicators Access

[in] Period.

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time corresponding to the last element to copy.

time_array[]
[out] Array of datetime type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

© 2000-2010, MetaQuotes Software Corp.


486 Timeseries and Indicators Access

CopyOpen
The function gets into open_array the history data of bar open prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyOpen(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
double  open_array[] // target array to copy open prices
);

Call by the start date and the number of required elements

int  CopyOpen(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
double  open_array[] // target array for bar open prices
);

Call by the start and end dates of a required time interval

int  CopyOpen(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
double  open_array[] // target array for bar open values
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


487 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] The start time for the last element to copy.

open_array[]
[out] Array of double type.

Return Value

Returns the number of element in the array or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

© 2000-2010, MetaQuotes Software Corp.


488 Timeseries and Indicators Access

CopyHigh
The function gets into high_array the history data of highest bar prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyHigh(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
double  high_array[]  // target array to copy
);

Call by the start date and the number of required elements

int  CopyHigh(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
double  high_array[]  // target array to copy
);

Call by the start and end dates of a required time interval

int  CopyHigh(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
double  high_array[]  // target array to copy
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


489 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy.

high_array[]
[out] Array of double type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

Example:

#property copyright "2009, MetaQuotes Software Corp."


#property link "http://www.mql5.com"
#property version "1.00"

#property description "An example for output of the High[i] and Low[i]"
#property description "for a random chosen bars"

double High[],Low[];
//+------------------------------------------------------------------+
//| Get Low for specified bar index |
//+------------------------------------------------------------------+
double iLow(string symbol,ENUM_TIMEFRAMES timeframe,int index)
{
double low=0;
ArraySetAsSeries(Low,true);
int copied=CopyLow(symbol,timeframe,0,Bars(symbol,timeframe),Low);
if(copied>0 && index<copied) low=Low[index];
return(low);
}
//+------------------------------------------------------------------+
//| Get the High for specified bar index |
//+------------------------------------------------------------------+
double iHigh(string symbol,ENUM_TIMEFRAMES timeframe,int index)
{
double high=0;
ArraySetAsSeries(High,true);

© 2000-2010, MetaQuotes Software Corp.


490 Timeseries and Indicators Access

int copied=CopyHigh(symbol,timeframe,0,Bars(symbol,timeframe),High);
if(copied>0 && index<copied) high=High[index];
return(high);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//--- at each tick we output the High and Low values for the bar with index,
//--- equal of the tick second
datetime t=TimeCurrent();
int sec=t%60;
printf("High[%d] =%G Low[%d] =%G",
sec,iHigh(Symbol(),0,sec),
sec,iLow(Symbol(),0,sec));
}

© 2000-2010, MetaQuotes Software Corp.


491 Timeseries and Indicators Access

CopyLow
The function gets into low_array the history data of minimal bar prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyLow(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
double  low_array[] // target array to copy
);

Call by the start date and the number of required elements

int  CopyLow(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
double  low_array[]  // target array to copy
);

Call by the start and end dates of a required time interval

int  CopyLow(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
double  low_array[] // target array to copy
);

Parameters
symbol_name
[in] Symbol.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


492 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] Bar time, corresponding to the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy.

low_array[]
[out] Array of double type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

See also
CopyHigh

© 2000-2010, MetaQuotes Software Corp.


493 Timeseries and Indicators Access

CopyClose
The function gets into close_array the history data of bar close prices for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyClose(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
double  close_array[]  // target array to copy
);

Call by the start date and the number of required elements

int  CopyClose(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
double  close_array[]  // target array to copy
);

Call by the start and end dates of a required time interval

int  CopyClose(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
double  close_array[]  // target array to copy
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


494 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy.

close_array[]
[out] Array of double type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

© 2000-2010, MetaQuotes Software Corp.


495 Timeseries and Indicators Access

CopyTickVolume
The function gets into volume_array the history data of tick volumes for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyTickVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
long  volume_array[] // target array for tick volumes
);

Call by the start date and the number of required elements

int  CopyTickVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
long  volume_array[] // target array for tick volumes
);

Call by the start and end dates of a required time interval

int  CopyTickVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
long  volume_array[] // target array for tick volumes
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


496 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy..

volume_array[]
[out] Array of long type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

Example:

#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot TickVolume
#property indicator_label1 "TickVolume"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 C'143,188,139'
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int bars=3000;
//--- indicator buffers
double TickVolumeBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,TickVolumeBuffer,INDICATOR_DATA);
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


497 Timeseries and Indicators Access

int OnCalculate(const int rates_total,


const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
if(prev_calculated==0)
{
long timeseries[];
ArraySetAsSeries(timeseries,true);
int prices=CopyTickVolume(Symbol(),0,0,bars,timeseries);
for(int i=0;i<rates_total-prices;i++) TickVolumeBuffer[i]=0.0;
for(int i=0;i<prices;i++) TickVolumeBuffer[rates_total-1-i]=timeseries[prices-1-i];
Print("We have received the following number of TickVolume values:"+prices);
}
else
{
long timeseries[];
int prices=CopyTickVolume(Symbol(),0,0,1,timeseries);
TickVolumeBuffer[rates_total-1]=timeseries[0];
}
//--- return value of prev_calculated for next call
return(rates_total);
}

© 2000-2010, MetaQuotes Software Corp.


498 Timeseries and Indicators Access

CopyRealVolume
The function gets into volume_array the history data of trade volumes for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopyRealVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
long  volume_array[] // target array for volumes values
);

Call by the start date and the number of required elements

int  CopyRealVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
long  volume_array[] // target array for volumes values
);

Call by the start and end dates of a required time interval

int  CopyRealVolume(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
long  volume_array[] // target array for volumes values
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


499 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy.

volume_array[]
[out] Array of long type.

Return Value

Returns the copied data count or -1 in the case of error.

Note

The elements ordering of the copied data is from present to the past, i.e., starting position of 0
means the current bar.

© 2000-2010, MetaQuotes Software Corp.


500 Timeseries and Indicators Access

CopySpread
The function gets into spread_array the history data of spread values for the selected symbol-period
pair in the specified quantity. It should be noted that elements ordering is from present to past, i.e.,
starting position of 0 means the current bar.

It is recommended to use dynamical array as a target array, because if the requested data count is
less (or more) than the length of the target array, function tries to reallocate the memory so that the
requested data fit entirely.

No matter what is the property of the target array - as_series=true or as_series=false. Data will be
copied so that the oldest element will be located at the start of the physical memory allocated for the
array. There are 3 variants of function calls.

Call by the first position and the number of required elements

int  CopySpread(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
int  start_pos,  // start position
int  count,  // data count to copy
int  spread_array[] // target array for spread values
);

Call by the start date and the number of required elements

int  CopySpread(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
int  count,  // data count to copy
int  spread_array[] // target array for spread values
);

Call by the start and end dates of a required time interval

int  CopySpread(
string  symbol_name,  // symbol name
ENUM_TIMEFRAMES  timeframe,  // period
datetime  start_time,  // start date and time
datetime  stop_time,  // stop date and time
int  spread_array[] // target array for spread values
);

Parameters
symbol_name
[in] Symbol name.

timeframe
[in] Period.

© 2000-2010, MetaQuotes Software Corp.


501 Timeseries and Indicators Access

start_pos
[in] The start position for the first element to copy.

count
[in] Data count to copy.

start_time
[in] The start time for the first element to copy.

stop_time
[in] Bar time, corresponding to the last element to copy.

spread_array[]
[out] Array of int type.

Return Value

Returns the copied data count or -1 in case of an error.

Note

The elements ordering of the copied data is from present to past, i.e., starting position of 0 means
the current bar.

Example:

#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Spread
#property indicator_label1 "Spread"
#property indicator_type1 DRAW_HISTOGRAM
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int bars=3000;
//--- indicator buffers
double SpreadBuffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,SpreadBuffer,INDICATOR_DATA);
IndicatorSetInteger(INDICATOR_DIGITS,0);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


502 Timeseries and Indicators Access

int OnCalculate(const int rates_total,


const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
if(prev_calculated==0)
{
int spread_int[];
ArraySetAsSeries(spread_int,true);
int spreads=CopySpread(Symbol(),0,0,bars,spread_int);
Print("We have received the following number of Spread values:",spreads);
for (int i=0;i<spreads;i++)
{
SpreadBuffer[rates_total-1-i]=spread_int[i];
if(i<=30) Print("spread["+i+"] =",spread_int[i]);
}
}
else
{
double Ask,Bid;
Ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
Bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
Comment("Ask =",Ask," Bid =",Bid);
SpreadBuffer[rates_total-1]=(Ask-Bid)/Point();
}
//--- return value of prev_calculated for next call
return(rates_total);
}

© 2000-2010, MetaQuotes Software Corp.


503 Chart Operations

Chart Operations
These are functions for working with charts. All chart operations are allowed in Expert Advisors and
scripts only.

Function Action

ChartApplyTemplate Applies a specific template from a specified file


to the chart

ChartWindowFind Returns the number of a subwindow where an


indicator is drawn

ChartOpen Opens a new chart with the specified symbol


and period

ChartClose Closes the specified chart

ChartFirst Returns the ID of the first chart of the client


terminal

ChartNext Returns the chart ID of the chart next to the


specified one

ChartSymbol Returns the symbol name of the specified chart

ChartPeriod Returns the period value of the specified chart

ChartRedraw Calls a forced redrawing of a specified chart

ChartSetDouble Sets the double value for a corresponding


property of the specified chart

ChartSetInteger Sets the integer value (datetime, int, color,


bool or char) for a corresponding property of
the specified chart

ChartSetString Sets the string valuefor a corresponding


property of the specified chart

ChartGetDouble Returns the double value property of the


specified chart

ChartGetInteger Returns the integer value property of the


specified chart

ChartGetString Returns the string value property of the


specified chart

ChartNavigate Performs shift of the specified chart by the


specified number of bars relative to the
specified position in the chart

ChartID Returns the ID of the current chart.

ChartWindowOnDropped Returns the number (index) of the chart


subwindow, the Expert Advisor or script has
been dropped to

© 2000-2010, MetaQuotes Software Corp.


504 Chart Operations

ChartPriceOnDropped Returns the price coordinate of the chart point,


the Expert Advisor or script has been dropped
to

ChartTimeOnDropped Returns the time coordinate of the chart point,


the Expert Advisor or script has been dropped
to

ChartXOnDropped Returns the X coordinate of the chart point, the


Expert Advisor or script has been dropped to

ChartYOnDropped Returns the Y coordinate of the chart point, the


Expert Advisor or script has been dropped to

ChartSetSymbolPeriod Changes the symbol value and a period of the


specified chart.

ChartScreenShot Provides a screenshot of the chart of its current


state in a gif format

© 2000-2010, MetaQuotes Software Corp.


505 Chart Operations

ChartApplyTemplate
Applies a specific template from a specified file to the chart.

bool  ChartApplyTemplate(
long  chart_id, // Chart ID
const string  filename  // Template file name
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

filename
[in] The name of the file containing the template. The file is searched in "MQL5\Files" folder.

Return Value

If a template is applied successfully, the function returns true, otherwise false. To get an
information about the error, call the GetLastError() function.

Note

The Expert Advisor will be unloaded and won't be able to continue operating in case of successful
loading of a new template to the chart it is attached to.

Example:

//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- Let's open and try to apply 'my_template.tpl' template
if(!ChartApplyTemplate(0,"my_template"))
{
//--- If unable to apply template, then
Print("Unable to apply 'my_template', error",GetLastError());
ResetLastError();
//--- Let's search just 'my_template' file, without 'tpl' extension
if(FileIsExist("my_template"))
Print("File 'my_template' exists, but 'my_template.tpl' file is needed");
else
Print("'my_template.tpl' file is not found in "
+TerminalInfoString(TERMINAL_PATH)
+"\\MQL5\\Files");

//--- Now let's return correct filename with 'tpl' extension


if(ChartApplyTemplate(0,"my_template.tpl"))
Print("'my_template.tpl' successfully applied ");
else

© 2000-2010, MetaQuotes Software Corp.


506 Chart Operations

Print("Unable to apply 'my_template.tpl', error",GetLastError());

}
else
{
//--- Template is stored in file without extension
Print("'my_template' successfully applied - file without extension");
}
}

© 2000-2010, MetaQuotes Software Corp.


507 Chart Operations

ChartWindowFind
The function returns the number of a subwindow where an indicator is drawn. There are 2 variants of
the function.

1. The function searches in the indicated chart for the subwindow with the specified "short name" of
the indicator (the short name is displayed in the left top part of the subwindow), and it returns the
subwindow number in case of success.

int  ChartWindowFind(
long  chart_id,  // chart identifier
string  indicator_shortname // short indicator name, see INDICATOR_SHORTNAME

2. The function must be called from a custom indicator. It returns the number of the subwindow where
the indicator is working.

int  ChartWindowFind();

Parameters
chart_id
[in] Chart ID. 0 denotes the current chart.

indicator_shortname
[in] Short name of the indicator.

Return Value

Subwindow number in case of success. In case of failure the function returns -1.

Note

If the second variant of the function (without parameters) is called from a script or Expert Advisor,
the function returns -1.

Exapmle:

#property script_show_inputs
//--- input parameters
input string shortname="MACD(12,26,9)";
//+------------------------------------------------------------------+
//| returns number of the chart window with this indicator |
//+------------------------------------------------------------------+
int GetIndicatorSubWindowNumber(long chartID=0,string short_name="")
{
int window=-1;
//---
if((ENUM_PROGRAM_TYPE)MQL5InfoInteger(MQL5_PROGRAM_TYPE)==PROGRAM_INDICATOR)
{
//--- the function is called from the indicator, name is not required
window=ChartWindowFind();
}
else

© 2000-2010, MetaQuotes Software Corp.


508 Chart Operations

{
//--- the function is called from an Expert Advisor or script
window=ChartWindowFind(0,short_name);
if(window==-1) Print(__FUNCTION__+"(): Error = ",GetLastError());
}
//---
return(window);
}
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//---
int window=GetIndicatorSubWindowNumber(0,shortname);
if(window!=-1)
Print("Indicator "+shortname+" is in the window #"+(string)window);
else
Print("Indicator "+shortname+" is not found. window = "+(string)window);
}

See also
ObjectCreate(), ObjectFind()

© 2000-2010, MetaQuotes Software Corp.


509 Chart Operations

ChartOpen
Opens a new chart with the specified symbol and period.

long  ChartOpen(
string  symbol,  // Symbol name
ENUM_TIMEFRAMES  period  // Period
);

Parameters
symbol
[in] Chart symbol. NULL means the symbol of the current chart (the Expert Advisor is attached
to).

period
[in] Chart period (timeframe). Can be one of the ENUM_TIMEFRAMES values. 0 means the current
chart period.

Return Value

If successful, it returns the opened chart ID. Otherwise returns 0.

Note

The maximum possible number of simultaneously open charts in the terminal can't exceed the
CHARTS_MAX value.

© 2000-2010, MetaQuotes Software Corp.


510 Chart Operations

ChartFirst
Returns the ID of the first chart of the client terminal.

long  ChartFirst();

Return Value

Chart ID.

© 2000-2010, MetaQuotes Software Corp.


511 Chart Operations

ChartNext
Returns the chart ID of the chart next to the specified one.

long  ChartNext(
long  chart_id  // Chart ID
);

Parameters
chart_id
[in] Chart ID. 0 does not mean the current chart. 0 means "return the first chart ID".

Return Value

Chart ID. If this is the end of the chart list, it returns -1.

Example:

//--- variables for chart ID


long currChart,prevChart=ChartFirst();
int i=0,limit=100;
Print("ChartFirst =",ChartSymbol(prevChart)," ID =",prevChart);
while(i<limit)// We have certainly not more than 100 open charts
{
currChart=ChartNext(prevChart); // Get the new chart ID by using the previous chart ID
if(currChart<0) break; // Have reached the end of the chart list
Print(i,ChartSymbol(currChart)," ID =",currChart);
prevChart=currChart;// let's save the current chart ID for the ChartNext()
i++;// Do not forget to increase the counter
}

© 2000-2010, MetaQuotes Software Corp.


512 Chart Operations

ChartClose
Closes the specified chart.

bool  ChartClose(
long  chart_id=0  // Chart ID
);

Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.

Return Value

If successful, returns true, otherwise false.

© 2000-2010, MetaQuotes Software Corp.


513 Chart Operations

ChartSymbol
Returns the symbol name for the specified chart.

string  ChartSymbol(
long  chart_id=0  // Chart ID
);

Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.

Return Value

If chart does not exist, the result will be an empty string.

See also
ChartSetSymbolPeriod

© 2000-2010, MetaQuotes Software Corp.


514 Chart Operations

ChartPeriod
Returns the timeframe period of specified chart.

ENUM_TIMEFRAMES  ChartPeriod(
long  chart_id=0  // Chart ID
);

Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.

Return Value

The function returns one of the ENUM_TIMEFRAMES values. If chart does not exist, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


515 Chart Operations

ChartRedraw
This function calls a forced redrawing of a specified chart.

void  ChartRedraw(
long  chart_id=0  // Chart ID
);

Parameters
chart_id=0
[in] Chart ID. 0 means the current chart.

Note

Usually it is used after changing the object properties.

See also
Objects functions

© 2000-2010, MetaQuotes Software Corp.


516 Chart Operations

ChartSetDouble
Sets a value for a corresponding property of the specified chart. Chart property should be of a double
type.

bool  ChartSetDouble(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
double  value  // Value
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. Can be one of the ENUM_CHART_PROPERTY_DOUBLE values (except the
read-only properties).

value
[in] Property value.

Return Value

Returns true if successful, otherwise returns false.

© 2000-2010, MetaQuotes Software Corp.


517 Chart Operations

ChartSetInteger
Sets a value for a corresponding property of the specified chart. Chart property must be
datetime, int, color, bool or char.

bool  ChartSetInteger(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
long  value  // Value
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. It can be one of the ENUM_CHART_PROPERTY_INTEGER value (except the
read-only properties).

value
[in] Property value.

Return Value

Returns true if successful, otherwise returns false.

© 2000-2010, MetaQuotes Software Corp.


518 Chart Operations

ChartSetString
Sets a value for a corresponding property of the specified chart. Chart property must be of the string
type.

bool  ChartSetString(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
string  str_value  // Value
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. It's value can be one of the ENUM_CHART_PROPERTY_STRING values
(except the read-only properties).

str_value
[in] Property value string. String length cannot exceed 2045 characters (extra characters will be
truncated).

Return Value

Returns true if successful, otherwise false.

Note

ChartSetString can be used for a comment output on the chart instead of the Comment function.

Example:

void OnTick()
{
//---
double Ask,Bid;
int Spread;
Ask=SymbolInfoDouble(Symbol(),SYMBOL_ASK);
Bid=SymbolInfoDouble(Symbol(),SYMBOL_BID);
Spread=SymbolInfoInteger(Symbol(),SYMBOL_SPREAD);
string comment=StringFormat("Printing prices:\nAsk = %G\nBid = %G\nSpread = %d",
Ask,Bid,Spread);
ChartSetString(0,CHART_COMMENT,comment);
}

See also
Comment, ChartGetString

© 2000-2010, MetaQuotes Software Corp.


519 Chart Operations

ChartGetDouble
Returns the value of a corresponding property of the specified chart. Chart property must be of double
type. There are 2 variants of th efunction calls.

1. Returns the property value directly.

double  ChartGetDouble(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
int  sub_window=0 // subwindow number, if necessary
);

2. Returns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable double_var passed by reference.

bool  ChartGetDouble(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
int  sub_window, // Subwindow number
double& double_var  // Target variable for the chart property
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. This value can be one of the ENUM_CHART_PROPERTY_DOUBLE values.

sub_window
[in] Number of the chart subwindow. For the first case, the default value is 0 (main chart
window). The most of the properties do not require a subwindow number.

double_var
[out] Target variable of double type for the requested property.

Return Value

The value of double type.

For the second call case it returns true if the specified property is available and its value has been
placed into double_var variable, otherwise returns false. To get an additional information about the
error, it is necessary to call the function GetLastError().

Example:

void OnStart()
{
double priceMin=ChartGetDouble(0,CHART_PRICE_MIN,0);
double priceMax=ChartGetDouble(0,CHART_PRICE_MAX,0);
Print("CHART_PRICE_MIN =",priceMin);

© 2000-2010, MetaQuotes Software Corp.


520 Chart Operations

Print("CHART_PRICE_MAX =",priceMax);
}

© 2000-2010, MetaQuotes Software Corp.


521 Chart Operations

ChartGetInteger
Returns the value of a corresponding property of the specified chart. Chart property must be of
datetime, int or bool type. There are 2 variants of the function calls.

1. Returns the property value directly.

long  ChartGetInteger(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
int  sub_window=0 // subwindow number, if necessary
);

2. Returns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable long_var passed by reference.

bool  ChartGetInteger(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
int  sub_window, // subwindow number
long&  long_var   // Target variable for the property
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. This value can be one of the ENUM_CHART_PROPERTY_INTEGER values.

sub_window
[in] Number of the chart subwindow. For the first case, the default value is 0 (main chart
window). The most of the properties do not require a subwindow number.

long_var
[out] Target variable of long type for the requested property.

Return Value

The value of long type.

For the second call case it returns true if specified property is available and its value has been
stored into long_var variable, otherwise returns false. To get additional information about the error
, it is necessary to call the function GetLastError().

Example:

void OnStart()
{
int height=ChartGetInteger(0,CHART_HEIGHT_IN_PIXELS,0);
int width=ChartGetInteger(0,CHART_WIDTH_IN_PIXELS,0);
Print("CHART_HEIGHT_IN_PIXELS =",height,"pixels");

© 2000-2010, MetaQuotes Software Corp.


522 Chart Operations

Print("CHART_WIDTH_IN_PIXELS =",width,"pixels");
}

© 2000-2010, MetaQuotes Software Corp.


523 Chart Operations

ChartGetString
Returns the value of a corresponding property of the specified chart. Chart property must be of string
type. There are 2 variants of the function call.

1. Returns the property value directly.

string  ChartGetString(
long  chart_id,  // Chart ID
int  prop_id   // Property ID
);

2. Returns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable string_var passed by reference.

bool  ChartGetString(
long  chart_id,  // Chart ID
int  prop_id,  // Property ID
string& string_var // Target variable for the property
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

prop_id
[in] Chart property ID. This value can be one of the ENUM_CHART_PROPERTY_STRING values.

string_var
[out] Target variable of string type for the requested property.

Return Value

The value of string type.

For the second call case it returns true if the specified property is available and its value has been
stored into string_var variable, otherwise returns false. To get additional information about the
error, it is necessary to call the function GetLastError().

Note

ChartGetString can be used for reading comments plotted on the chart using the Comment or
ChartSetString functions.

Example:

void OnStart()
{
ChartSetString(0,CHART_COMMENT,"Test comment.\nSecond line.\nThird!");
ChartRedraw();
Sleep(1000);
string comm=ChartGetString(0,CHART_COMMENT);
Print(comm);

© 2000-2010, MetaQuotes Software Corp.


524 Chart Operations

See also
Comment, ChartSetString

© 2000-2010, MetaQuotes Software Corp.


525 Chart Operations

ChartNavigate
Performs shift of the specified chart by the specified number of bars relative to the specified position
in the chart.

bool  ChartNavigate(
long  chart_id,  // Chart ID
int  position,  // Position
int  shift=0  // Shift value
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

position
[in] Chart position to perform a shift. Can be one of the ENUM_CHART_POSITION values.

shift=0
[in] Number of bars to shift the chart. The positive value means the right shift (to the end if the
chart), the negative value means the left shift (to the chart begin). The zero shift can be used to
navigate to chart beginning or end.

Return Value

Returns true if successful, otherwise returns false.

© 2000-2010, MetaQuotes Software Corp.


526 Chart Operations

ChartID
Returns the ID of the current chart.

long  ChartID();

Return Value

Value of long type.

© 2000-2010, MetaQuotes Software Corp.


527 Chart Operations

ChartWindowOnDropped
Returns the number (index) of the chart subwindow, the Expert Advisor or script has been dropped to.
0 means the main chart window.

int  ChartWindowOnDropped();

Return Value

Value of int type.

Example:

int myWindow=ChartWindowOnDropped();
int windowsTotal=ChartGetInteger(0,CHART_WINDOWS_TOTAL);
Print("Script is running on the window #"+myWindow+
". Total windows on the chart "+ChartSymbol()+":",windowsTotal);

See also
ChartPriceOnDropped, ChartTimeOnDropped, ChartXOnDropped, ChartYOnDropped

© 2000-2010, MetaQuotes Software Corp.


528 Chart Operations

ChartPriceOnDropped
Returns the price coordinate corresponding to the chart point, an Expert Advisor or script has been
dropped to.

double  ChartPriceOnDropped();

Return Value

Value of double type.

Example:

double p=ChartPriceOnDropped();
Print("ChartPriceOnDropped()=",p);

See also
ChartXOnDropped, ChartYOnDropped

© 2000-2010, MetaQuotes Software Corp.


529 Chart Operations

ChartTimeOnDropped
Returns the time coordinate corresponding to the chart point, an Expert Advisor or script has been
dropped to.

datetime  ChartTimeOnDropped();

Return Value

Value of datetime type.

Example:

datetime t=ChartTimeOnDropped();
Print("Script was dropped on the "+t);

See also
ChartXOnDropped, ChartYOnDropped

© 2000-2010, MetaQuotes Software Corp.


530 Chart Operations

ChartXOnDropped
Returns the X coordinate of the chart point, an Expert Advisor or script has been dropped to.

int  ChartXOnDropped();

Return Value

The X coordinate value.

Note

X axis direction from left to right.

Example:

int X=ChartXOnDropped();
int Y=ChartYOnDropped();
Print("(X,Y)=("+X+","+Y+")");

See also
ChartWindowOnDropped, ChartPriceOnDropped, ChartTimeOnDropped

© 2000-2010, MetaQuotes Software Corp.


531 Chart Operations

ChartYOnDropped
Returns the Y coordinateof the chart point, an Expert Advisor or script has been dropped to.

int  ChartYOnDropped();

Return Value

The Y coordinate value.

Note

Y axis direction from top to bottom.

See also
ChartWindowOnDropped, ChartPriceOnDropped, ChartTimeOnDropped

© 2000-2010, MetaQuotes Software Corp.


532 Chart Operations

ChartSetSymbolPeriod
Changes the symbol and period of the specified chart. The function is asynchronous, i.e. it sends the
command and does not wait for its execution completion.

bool  ChartSetSymbolPeriod(
long  chart_id,  // Chart ID
string  symbol,  // Symbol name
ENUM_TIMEFRAMES  period  // Period
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

symbol
[in] Chart symbol. NULL value means the current chart symbol (Expert Advisor is attached to)

period
[in] Chart period (timeframe). Can be one of the ENUM_TIMEFRAMES values. 0 means the current
chart period.

Return Value

Returns true if successful, otherwise false.

Note

The symbol/period change leads to the re-initialization of the Expert Advisor, attached to a chart.

See also
ChartSymbol, ChartPeriod

© 2000-2010, MetaQuotes Software Corp.


533 Chart Operations

ChartScreenShot
The function provides a screenshot of the chart in its current state in a gif format.

bool  ChartScreenShot(
long  chart_id,  // Chart ID
string  filename,  // Symbol name
int  width,  // Width
int  height,  // Height
ENUM_ALIGN_MODE  align_mode=ALIGN_RIGHT  // Alignment type
);

Parameters
chart_id
[in] Chart ID. 0 means the current chart.

filename
[in] Screenshot file name. Cannot exceed 63 characters. Screenshot files are placed in the
directory \ Files.

width
[in] Screenshot width in pixels.

height
[in] Screenshot height in pixels.

align_mode=ALIGN_RIGHT
[in] Output mode of a narrow screenshot. ALIGN_RIGHT means align to the right margin (the
output from the end). ALIGN_LEFT means Left justify.

Return Value

Returns true if successful, otherwise false.

Note

If you need to take a screenshot from a chart from a certain position, first it's necessary to position
the graph using the ChartNavigate() function. If the horizontal size of the screenshot is smaller than
the chart window, either the right part of the chart window, or its left part is output, depending on
the align_mode settings.

© 2000-2010, MetaQuotes Software Corp.


534 Trade Functions

Trade Functions
This is the group of functions intended for managing trading activities.

Trading functions can be used in Expert Advisors and scripts. Trading functions can be called only if
in the properties of the Expert Advisor or script the "Allow live trading" checkbox is enabled.

Function Action

OrderSend Sends trade requests to a server

PositionsTotal Returns the number of open positions

PositionGetSymbol Returns the symbol corresponding to the open


position

PositionSelect Chooses an open position for further working


with it

PositionGetDouble Returns the requested property of an open


position (double)

PositionGetInteger Returns the requested property of an open


position (datetime or int)

PositionGetString Returns the requested property of an open


position (string)

OrdersTotal Returns the number of orders

OrderGetTicket Return the ticket of a corresponding order

OrderSelect Selects a order for further working with it

OrderGetDouble Returns the requested property of the order


(double)

OrderGetInteger Returns the requested property of the order


(datetime or int)

OrderGetString Returns the requested property of the order


(string)

HistorySelect Retrieves the history of transactions and orders


for the specified period of the server time

HistoryOrderSelect Selects an order in the history for further


working with it

HistoryOrdersTotal Returns the number of orders in the history

HistoryOrderGetTicket Return order ticket of a corresponding order in


the history

HistoryOrderGetDouble Returns the requested property of an order in


the history of (double)

HistoryOrderGetInteger Returns the requested property of an order in


the history (datetime or int)

© 2000-2010, MetaQuotes Software Corp.


535 Trade Functions

HistoryOrderGetString Returns the requested property of an order in


the history of (string)

HistoryDealSelect Selects a deal in the history for further calling it


through appropriate functions

HistoryDealsTotal Returns the number of deals in the history

HistoryDealGetTicket Returns a ticket of a corresponding deal in the


history

HistoryDealGetDouble Returns the requested property of a deal in the


history (double)

HistoryDealGetInteger Returns the requested property of a deal in the


history (datetime or int)

HistoryDealGetString Returns the requested property of a deal in the


history (string)

© 2000-2010, MetaQuotes Software Corp.


536 Trade Functions

OrderSend
OrderSend () is intended for implementing trading activities within MQL5.

bool  OrderSend(
MqlTradeRequest&  request  // query structure
MqlTradeResult&   result   // structure of the answer
);

Parameters
request
[in] Pointer to a structure of MqlTradeRequest type describing the trade activity of the client.

result
[in,out] Pointer to a structure of MqlTradeResult type describing the result of trade operation in
case of a successful completion (if true is returned).

Return Value

In case of a successful basic check of structures (index checking) returns true – this is not a sign of
successful execution of a trade operation. For a more detailed description of the function
execution result, analyze the fields of result structure.

Note

It should be noted when placing a market order that the successful completion of the OrderSend()
method operation does not always mean a successful deal completion. Check in the returned result
structure result the retcode value containing trade server return code, and values of deal or order
field depending on the type of operation.

Example:

//--- value for ORDER_MAGIC


input long order_magic=55555;
//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- make sure that the account is demo
if(AccountInfoInteger(ACCOUNT_TRADE_MODE)==ACCOUNT_TRADE_MODE_REAL)
{
Alert("Script operation is not allowed on a live account!");
return;
}
//--- place or delete order
if(GetOrdersTotalByMagic(order_magic)==0)
{
//--- no current orders - place an order
int res=SendRandomPendingOrder(order_magic);
Print("Return code of the trade server",res);

© 2000-2010, MetaQuotes Software Corp.


537 Trade Functions

}
else // there are orders - delete orders
{
DeleteAllOrdersByMagic(order_magic);
}
}
//+------------------------------------------------------------------+
//| receive the current number of orders with specified ORDER_MAGIC |
//+------------------------------------------------------------------+
int GetOrdersTotalByMagic(long const magic_number)
{
long order_ticket;
int total=0;
//--- selection through the entire history
HistorySelect(0,TimeCurrent());
//--- go through all pending orders
for(int i=0;i<OrdersTotal();i++)
if(order_ticket=OrderGetTicket(i))
if(magic_number==OrderGetInteger(ORDER_MAGIC)) total++;
//---
return(total);
}
//+------------------------------------------------------------------+
//| deletes all pending orders with specified ORDER_MAGIC |
//+------------------------------------------------------------------+
void DeleteAllOrdersByMagic(long const magic_number)
{
long order_ticket;
int total=0;
//--- selection through the entire history
HistorySelect(0,TimeCurrent());
//--- go through all pending orders
for(int i=0;i<OrdersTotal();i++)
if(order_ticket=OrderGetTicket(i))
//--- order with appropriate ORDER_MAGIC
if(magic_number==OrderGetInteger(ORDER_MAGIC))
{
MqlTradeResult result;
MqlTradeRequest request;
request.order=order_ticket;
request.action=TRADE_ACTION_REMOVE;
OrderSend(request,result);
//--- write the server reply to log
Print(__FUNCTION__,":",result.comment,"reply code",result.retcode);
}
//---
}
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


538 Trade Functions

//| set a pending order in a random way |


//+------------------------------------------------------------------+
int SendRandomPendingOrder(long const magic_number)
{
//--- prepare a request
MqlTradeRequest request;
request.action=TRADE_ACTION_PENDING; // setting a pending order
request.magic=magic_number; // ORDER_MAGIC
request.symbol=_Symbol; // symbol
request.volume=0.1; // volume in 0.1 lots
request.sl=0; // Stop Loss is not specified
request.tp=0; // Take Profit is not specified
request.deviation=5; // deviation in 5 points
//--- form the order type
request.type=GetRandomType(); // order type
//--- form the price for the pending order
request.price=GetRandomPrice(request.type); // open price
//--- send a trade request
MqlTradeResult result;
OrderSend(request,result);
//--- write the server reply to log
Print(__FUNCTION__,":",result.comment);
if(result.retcode==10016) Print(result.bid,result.ask,result.price);
//--- return code of the trade server reply
return result.retcode;
}
//+------------------------------------------------------------------+
//| return type of a pending order in a random way |
//+------------------------------------------------------------------+
ENUM_ORDER_TYPE GetRandomType()
{
int t=MathRand()%4;
//--- 0<=t<4
switch(t)
{
case(0):return(ORDER_TYPE_BUY_LIMIT);
case(1):return(ORDER_TYPE_SELL_LIMIT);
case(2):return(ORDER_TYPE_BUY_STOP);
case(3):return(ORDER_TYPE_SELL_STOP);
}
//--- incorrect value
return(WRONG_VALUE);
//---
}
//+------------------------------------------------------------------+
//| return price in a random way |
//+------------------------------------------------------------------+
double GetRandomPrice(ENUM_ORDER_TYPE type)

© 2000-2010, MetaQuotes Software Corp.


539 Trade Functions

{
int t=(int)type;
//--- stop levels for the symbol
int distance=(int)SymbolInfoInteger(_Symbol,SYMBOL_TRADE_STOPS_LEVEL);
//--- receive data of the last tick
MqlTick last_tick;
SymbolInfoTick(_Symbol,last_tick);
//--- calculate price according to the type
double price;
if(t==2 || t==5) // ORDER_TYPE_BUY_LIMIT or ORDER_TYPE_SELL_STOP
{
price=last_tick.bid; // depart from price Bid
price=price-(distance+(MathRand()%10)*5)*_Point;
}
else // ORDER_TYPE_SELL_LIMIT or ORDER_TYPE_BUY_STOP
{
price=last_tick.ask; // depart from price Ask
price=price+(distance+(MathRand()%10)*5)*_Point;
}
return(price);
}

© 2000-2010, MetaQuotes Software Corp.


540 Trade Functions

PositionsTotal
Returns the number of open positions.

int  PositionsTotal();

Return Value

Value of int type.

© 2000-2010, MetaQuotes Software Corp.


541 Trade Functions

PositionGetSymbol
Returns the symbol corresponding to the open position and automatically selects the position for
further working with it using functions PositionGetDouble, PositionGetInteger, PositionGetString.

string  PositionGetSymbol(
int  index  // Number in the list of positions
);

Parameters
index
[in] Number of the position in the list of open positions.

Return Value

Value of the string type.

© 2000-2010, MetaQuotes Software Corp.


542 Trade Functions

PositionSelect
Chooses an open position for further working with it. Returns true if the function is successfully
completed. Returns false in case of failure. To obtain information about the error, call GetLastError().

bool  PositionSelect(
string  symbol  // Symbol name
uint  timeout=0  // Timeout in milliseconds
);

Parameters
symbol
[in] Name of the financial security.

timeout=0
[in] Timeout value in milliseconds. Means the maximum time allowed to find the position for the
specified symbol. If during the timeout a position hasn't been selected, the function returns false.

Return Value

Value of the bool type.

Note

If the function fails due to a timeout 4757 error will be generated.

© 2000-2010, MetaQuotes Software Corp.


543 Trade Functions

PositionGetDouble
The function returns the requested property of an open position, pre-selected using PositionGetSymbol
or PositionSelect. The position property must be of the double type. There are 2 variants of the
function.

1. Immediately returns the property value.

double  PositionGetDouble(
ENUM_POSITION_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variables passed by reference by the last parameter.

bool  PositionGetDouble(
ENUM_POSITION_PROPERTY  property_id, // Property identifier
double&  double_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM_POSITION_PROPERTY_DOUBLE enumeration.

double_var
[out] Variable of the double type, accepting the value of the requested property.

Return Value

Value of the double type.

© 2000-2010, MetaQuotes Software Corp.


544 Trade Functions

PositionGetInteger
The function returns the requested property of an open position, pre-selected using PositionGetSymbol
or PositionSelect. The position property should be of datetime, int type. There are 2 variants of the
function.

1. Immediately returns the property value.

long  PositionGetInteger(
ENUM_POSITION_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variables passed by reference by the last parameter.

bool  PositionGetInteger(
ENUM_POSITION_PROPERTY  property_id, // Property identifier
long&  long_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM_POSITION_PROPERTY_INTEGER enumeration.

long_var
[out] Variable of the long type accepting the value of the requested property.

Return Value

Value of the long type.

© 2000-2010, MetaQuotes Software Corp.


545 Trade Functions

PositionGetString
The function returns the requested property of an open position, pre-selected using PositionGetSymbol
or PositionSelect. The position property should be of the string type. There are 2 variants of the
function.

1. Immediately returns the property value.

string  PositionGetString(
ENUM_POSITION_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function execution. If successful, the value
of the property is placed in a receiving variables passed by reference by the last parameter.

bool  PositionGetString(
ENUM_POSITION_PROPERTY  property_id, // Property identifier
string&  string_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of a position property. The value can be one of the values of the
ENUM_POSITION_PROPERTY_STRING enumeration.

string_var
[out] Variable of the string type accepting the value of the requested property.

Return Value

Value of the string type.

© 2000-2010, MetaQuotes Software Corp.


546 Trade Functions

OrdersTotal
Returns the number of orders.

int  OrdersTotal();

Return Value

Value of the int type.

© 2000-2010, MetaQuotes Software Corp.


547 Trade Functions

OrderGetTicket
Returns ticket of a corresponding order automatically selects the order for further working with it
using functions.

ulong  OrderGetTicket(
int  index  // Number in the list of orders
);

Parameters
index
[in] Number of an order in the list of orders.

Return Value

Value of the ulong type.

Example:

void OnStart()
{
datetime from=0;
datetime to=TimeCurrent();
//--- request the entire history
HistorySelect(from,to);
//--- variables for returning values from order properties
ulong ticket;
double open_price;
double initial_volume;
datetime time_setup;
string symbol;
string type;
long order_magic;
//--- number of current pending orders
uint total=OrdersTotal();
//--- go through orders in a loop
for(uint i=0;i<total;i++)
{
//--- return order ticket by its position in the list
if(ticket=OrderGetTicket(i))
{
//--- return order properties
open_price= OrderGetDouble(ORDER_PRICE_OPEN);
time_setup= OrderGetInteger(ORDER_TIME_SETUP);
symbol= OrderGetString(ORDER_SYMBOL);
order_magic= OrderGetInteger(ORDER_MAGIC);
positionID = OrderGetInteger(ORDER_POSITION_ID);
initial_volume= OrderGetDouble(ORDER_VOLUME_INITIAL);
type=GetOrderType(OrderGetInteger(ORDER_TYPE));
//--- prepare and show information about the order

© 2000-2010, MetaQuotes Software Corp.


548 Trade Functions

printf("#ticket %d %s %G %s at %G was set up at %s",


ticket, // order ticket
type, // type
initial_volume, // placed volume
symbol, // symbol
open_price, // specified open price
TimeToString(time_setup)// time of order placing
);
}
}
//---
}
//+------------------------------------------------------------------+
//| returns the string name of the order type |
//+------------------------------------------------------------------+
string GetOrderType(long type)
{
string str_type="unknown operation";
switch(type)
{
case (ORDER_TYPE_BUY): return("buy");
case (ORDER_TYPE_SELL): return("sell");
case (ORDER_TYPE_BUY_LIMIT): return("buy limit");
case (ORDER_TYPE_SELL_LIMIT): return("sell limit");
case (ORDER_TYPE_BUY_STOP): return("buy stop");
case (ORDER_TYPE_SELL_STOP): return("sell stop");
case (ORDER_TYPE_BUY_STOP_LIMIT): return("buy stop limit");
case (ORDER_TYPE_SELL_STOP_LIMIT):return("sell stop limit");
}
return(str_type);
}

See also
OrderGetInteger()

© 2000-2010, MetaQuotes Software Corp.


549 Trade Functions

OrderSelect
Selects an order to work with. Returns true if the function has been successfully completed. Returns
false if the function completion has failed. For more information about an error call GetLastError().

bool  OrderSelect(
ulong  ticket  // Order ticket
uint  timeout=0  // Timeout in milliseconds
);

Parameters
ticket
[in] Order ticket.

timeout=0
[in] Timeout value in milliseconds. It denotes the maximum time allowed to find the order with
the specified ticket. If during the timeout the order hasn't been found, the function returns false.

Return Value

Value of the bool type.

Note

If the function fails due to a timeout, the error 4757 will be generated.

© 2000-2010, MetaQuotes Software Corp.


550 Trade Functions

OrderGetDouble
Returns the requested property of an order, pre-selected using OrderGetTicket or OrderSelect. The
order property must be of the double type. There are 2 variants of the function.

1. Immediately returns the property value.

double  OrderGetDouble(
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of a function. If successful, the value of the
property is placed in a target variable passed by reference by the last parameter.

bool  OrderGetDouble(
ENUM_ORDER_PROPERTY  property_id, // Property identifier
double&  double_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_DOUBLE enumeration.

double_var
[out] Variable of the double type that accepts the value of the requested property.

Return Value

Value of the double type.

© 2000-2010, MetaQuotes Software Corp.


551 Trade Functions

OrderGetInteger
Returns the requested order property, pre-selected using OrderGetTicket or OrderSelect. Order
property must be of the datetime, int type. There are 2 variants of the function.

1. Immediately returns the property value.

long  OrderGetInteger(
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  OrderGetInteger(
ENUM_ORDER_PROPERTY  property_id, // Property identifier
long&  long_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_INTEGER enumeration.

long_var
[out] Variable of the long type that accepts the value of the requested property.

Return Value

Value of the long type.

© 2000-2010, MetaQuotes Software Corp.


552 Trade Functions

OrderGetString
Returns the requested order property, pre-selected using OrderGetTicket or OrderSelect. The order
property must be of the string type. There are 2 variants of the function.

1. Immediately returns the property value.

string  OrderGetString(
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  OrderGetString(
ENUM_ORDER_PROPERTY  property_id, // Property identifier
string&  string_var  // Here we accept the property value
);

Parameters
property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_STRING enumeration.

string_var
[out] Variable of the string type that accepts the value of the requested property.

Return Value

Value of the string type.

© 2000-2010, MetaQuotes Software Corp.


553 Trade Functions

HistorySelect
Retrieves the history of transactions and orders for the specified period of server time.

bool  HistorySelect(
datetime  from_date,  // From date
datetime  to_date  // To date
);

Parameters
from_date
[in] Start date of the request.

to_date
[in] End date of the request request.

Return Value

It returns true if successful, otherwise returns false.

Note

HistorySelect() creates a list of orders and a list of trades in a mql5-program, for further referring
to the list elements using corresponding functions. The deals list size can be returned using the
HistoryDealsTotal() function; the size of the list of orders in the history can be obtained using
HistoryOrdersTotal(). Selection in the list of orders should be better performed by
HistoryOrderGetTicket(), for items in the list of deals HistoryDealGetTicket() suits better.

After using HistoryOrderSelect(), the list of history orders available to the mql5 program is reset
and filled again by the found order, if the search of an order by the ticket has been completed
successfully. The same applies to the list of deals available to the mql5 program - it is reset by
HistoryDealSelect() and filled again in case of a successful receipt of a deal by ticket number.

Example:

void OnStart()
{
color BuyColor =Blue;
color SellColor=Red;
//--- request trade history
HistorySelect(0,TimeCurrent());
//--- create objects
string name;
uint total=HistoryDealsTotal();
ulong ticket=0;
double price;
double profit;
datetime time;
string symbol;
long type;
long entry;
//--- for all deals

© 2000-2010, MetaQuotes Software Corp.


554 Trade Functions

for(uint i=0;i<total;i++)
{
//--- try to get deals ticket
if(ticket=HistoryDealGetTicket(i))
{
//--- get deals properties
price =HistoryDealGetDouble(ticket,DEAL_PRICE);
time =HistoryDealGetInteger(ticket,DEAL_TIME);
symbol=HistoryDealGetString(ticket,DEAL_SYMBOL);
type =HistoryDealGetInteger(ticket,DEAL_TYPE);
entry =HistoryDealGetInteger(ticket,DEAL_ENTRY);
profit=HistoryDealGetDouble(ticket,DEAL_PROFIT);
//--- only for current symbol
if(price && time && symbol==Symbol())
{
//--- create price object
name="TradeHistory_Deal_"+string(ticket);
if(entry) ObjectCreate(0,name,OBJ_ARROW_RIGHT_PRICE,0,time,price,0,0);
else ObjectCreate(0,name,OBJ_ARROW_LEFT_PRICE,0,time,price,0,0);
//--- set object properties
ObjectSetInteger(0,name,OBJPROP_SELECTABLE,0);
ObjectSetInteger(0,name,OBJPROP_BACK,0);
ObjectSetInteger(0,name,OBJPROP_COLOR,type?BuyColor:SellColor);
if(profit!=0) ObjectSetString(0,name,OBJPROP_TEXT,"Profit: "+string(profit));
}
}
}
//--- apply on chart
ChartRedraw();
}

See also
HistoryOrderSelect(), HistoryDealSelect()

© 2000-2010, MetaQuotes Software Corp.


555 Trade Functions

HistoryOrderSelect
Selects an order from the history for further calling it through appropriate functions. It returns true if
the function has been successfully completed. Returns false if the function has failed. For more details
on error call GetLastError().

bool  HistoryOrderSelect(
ulong  ticket  // Order ticket
uint  timeout=0  // Timeout in milliseconds
);

Parameters
ticket
[in] Order ticket.

Return Value

Returns true if successful, otherwise false.


timeout=0
[in] Timeout value in milliseconds. It denotes the maximum time allowed to find the order with
the specified ticket. If during the timeout the order hasn't been found, the function returns false.

Note

If the function fails due to a timeout, the 4757 error will be generated.

HistoryOrderSelect() clears in a mql5-program the list of orders from a history, available for calls,
and copies to it a single order, if the execution of HistoryOrderSelect () has been completed
successfully. If you need to go through all deals selected by HistorySelect(), you should better use
HistoryOrderGetTicket().

See also

HistorySelect(), HistoryOrderGetTicket()

© 2000-2010, MetaQuotes Software Corp.


556 Trade Functions

HistoryOrdersTotal
Returns the number of orders in the history.

int  HistoryOrdersTotal();

Return Value

Value of the int type.

© 2000-2010, MetaQuotes Software Corp.


557 Trade Functions

HistoryOrderGetTicket
Return the ticket of a corresponding order in the history.

ulong  HistoryOrderGetTicket(
int  index  // Number in the list of orders
);

Parameters
index
[in] Number of the order in the list of orders.

Return Value

Value of the ulong type.

Note

HistoryOrderGetTicket() not only returns the ticket of an order in history, but also selects it for
future calling it using HistoryOrderGetDouble(), HistoryOrderGetInteger and HistoryOrderGetString.
Thus, HistoryOrderSelect() selects an order for the specified ticket, while HistoryDealGetTicket()
selects an order by its number in the list of orders in history.

Пример:

void OnStart()
{
datetime from=0;
datetime to=TimeCurrent();
//--- request the entire history
HistorySelect(from,to);
//--- variables for returning values from order properties
ulong ticket;
double open_price;
double initial_volume;
datetime time_setup;
datetime time_done;
string symbol;
string type;
long order_magic;
long positionID;
//--- number of current pending orders
uint total=HistoryOrdersTotal();
//--- go through orders in a loop
for(uint i=0;i<total;i++)
{
//--- return order ticket by its position in the list
if(ticket=HistoryOrderGetTicket(i))
{
//--- return order properties
open_price= HistoryOrderGetDouble(ticket,ORDER_PRICE_OPEN);

© 2000-2010, MetaQuotes Software Corp.


558 Trade Functions

time_setup= HistoryOrderGetInteger(ticket,ORDER_TIME_SETUP);
time_done= HistoryOrderGetInteger(ticket,ORDER_TIME_DONE);
symbol= HistoryOrderGetString(ticket,ORDER_SYMBOL);
order_magic= HistoryOrderGetInteger(ticket,ORDER_MAGIC);
positionID = HistoryOrderGetInteger(ticket,ORDER_POSITION_ID);
initial_volume= HistoryOrderGetDouble(ticket,ORDER_VOLUME_INITIAL);
type=GetOrderType(HistoryOrderGetInteger(ticket,ORDER_TYPE));
//--- prepare and show information about the order
printf("#ticket %d %s %G %s at %G was set up at %s => done at %s, pos ID=%d",
ticket, // order ticket
type, // type
initial_volume, // placed volume
symbol, // symbol
open_price, // specified open price
TimeToString(time_setup),// time of order placing
TimeToString(time_done), // time of order execution or deletion
positionID // ID of a position , to which the deal of the order is in
);
}
}
//---
}
//+------------------------------------------------------------------+
//| returns the string name of the order type |
//+------------------------------------------------------------------+
string GetOrderType(long type)
{
string str_type="unknown operation";
switch(type)
{
case (ORDER_TYPE_BUY): return("buy");
case (ORDER_TYPE_SELL): return("sell");
case (ORDER_TYPE_BUY_LIMIT): return("buy limit");
case (ORDER_TYPE_SELL_LIMIT): return("sell limit");
case (ORDER_TYPE_BUY_STOP): return("buy stop");
case (ORDER_TYPE_SELL_STOP): return("sell stop");
case (ORDER_TYPE_BUY_STOP_LIMIT): return("buy stop limit");
case (ORDER_TYPE_SELL_STOP_LIMIT):return("sell stop limit");
}
return(str_type);
}

See also
HistorySelect(), HistoryOrdersTotal(), HistoryOrderSelect()

© 2000-2010, MetaQuotes Software Corp.


559 Trade Functions

HistoryOrderGetDouble
Returns the requested order property. The order property must be of the double type. There are 2
variants of the function.

1. Immediately returns the property value.

double  HistoryOrderGetDouble(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryOrderGetDouble(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id, // Property identifier
double&  double_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Order ticket.

property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_DOUBLE enumeration.

double_var
[out] Variable of the double type that accepts the value of the requested property.

Return Value

Value of the double type.

© 2000-2010, MetaQuotes Software Corp.


560 Trade Functions

HistoryOrderGetInteger
Returns the requested property of an order. The order property must be of datetime, int type. There
are 2 variants of the function.

1. Immediately returns the property value.

long  HistoryOrderGetInteger(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryOrderGetInteger(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id, // Property identifier
long&  long_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Order ticket.

property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_INTEGER enumeration.

long_var
[out] Variable of the long type that accepts the value of the requested property.

Return Value

Value of the long type.

© 2000-2010, MetaQuotes Software Corp.


561 Trade Functions

HistoryOrderGetString
Returns the requested property of an order. The order property must be of the string type. There are
2 variants of the function.

1. Immediately returns the property value.

string  HistoryOrderGetString(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryOrderGetString(
ulong  ticket_number,  // Ticket
ENUM_ORDER_PROPERTY  property_id, // Property identifier
string&  string_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Order ticket.

property_id
[in] Identifier of the order property. The value can be one of the values of the
ENUM_ORDER_PROPERTY_STRING enumeration.

string_var
[out] Variable of the string type.

Return Value

Value of the string type.

© 2000-2010, MetaQuotes Software Corp.


562 Trade Functions

HistoryDealSelect
Selects a deal in the history for further calling it through appropriate functions. It returns true if the
function has been successfully completed. Returns false if the function has failed. For more details on
error call GetLastError().

bool  HistoryDealSelect(
ulong  ticket  // Deal ticket
uint  timeout=0  // Timeout in milliseconds
);

Parameters
ticket
[in] Deal ticket.

Return Value

Returns true if successful, otherwise false.


timeout=0
[in] Timeout value in milliseconds. It denotes the maximum time allowed to find the order with
the specified ticket. If during the timeout the order hasn't been found, the function returns false.

Note

If the function fails due to a timeout, the 4757 error will be generated.

HistoryDealSelect() clears in a mql5-program the list of deals available for reference, and copies the
single deal, if the the execution of HistoryDealSelect() has been completed successfully. If you need
to go through all deals selected by the HistorySelect() function, you should better use
HistoryDealGetTicket().

See also

HistorySelect(), HistoryDealGetTicket()

© 2000-2010, MetaQuotes Software Corp.


563 Trade Functions

HistoryDealsTotal
Returns the number of deal in history.

int  HistoryDealsTotal();

Return Value

Value of the int type.

© 2000-2010, MetaQuotes Software Corp.


564 Trade Functions

HistoryDealGetTicket
The function selects a deal for further processing and returns the deal ticket in history.

ulong  HistoryDealGetTicket(
int  index  // ticket deal
);

Parameters
index
[in] Number of a deal in the list of deals

Return Value

Value of the ulong type.

Note

HistoryDealGetTicket() not only returns the ticket of a deal in history, but also selects it to further
refer to by means of HistoryDealGetDouble(), HistoryDealGetInteger() and HistoryDealGetString().
Thus, HistoryDealSelect() selects a deal for the specified ticket, while HistoryDealGetTicket()
selects a deal by its number in the list of deals in history.

Example:

© 2000-2010, MetaQuotes Software Corp.


565 Trade Functions

void OnStart()
{
ulong deal_ticket; // deal ticket
ulong order_ticket; // ticket of the order the deal was executed on
datetime transaction_time; // time of a deal execution
long deal_type ; // type of a trade operation
long position_ID; // position ID
string deal_description; // operation description
double volume; // operation volume
string symbol; // symbol of the deal
//--- set the start and end date to request the history of deals
datetime from_date=0; // from the very beginning
datetime to_date=TimeCurrent();// till the current moment
//--- request the history of deals in the specified period
HistorySelect(from_date,to_date);
//--- total number in the list of deals
int deals=HistoryDealsTotal();
//--- now process each trade
for(int i=0;i<deals;i++)
{
deal_ticket= HistoryDealGetTicket(i);
volume= HistoryDealGetDouble(deal_ticket,DEAL_VOLUME);
transaction_time=(datetime)HistoryDealGetInteger(deal_ticket,DEAL_TIME);
order_ticket= HistoryDealGetInteger(deal_ticket,DEAL_ORDER);
deal_type= HistoryDealGetInteger(deal_ticket,DEAL_TYPE);
symbol= HistoryDealGetString(deal_ticket,DEAL_SYMBOL);
position_ID= HistoryDealGetInteger(deal_ticket,DEAL_POSITION_ID);
deal_description= GetDealDescription(deal_type,volume,symbol,order_ticket,position_I
//--- perform fine formatting for the deal number
string print_index=StringFormat("% 3d",i);
//--- show information on the deal
Print(print_index+": deal #",deal_ticket," at ",transaction_time,deal_description);
}
}
//+------------------------------------------------------------------+
//| returns the string description of the operation |
//+------------------------------------------------------------------+
string GetDealDescription(long deal_type,double volume,string symbol,long ticket,long pos_ID)
{
string descr;
//---
switch(deal_type)
{
case DEAL_TYPE_BALANCE: return ("balance");
case DEAL_TYPE_CREDIT: return ("credit");
case DEAL_TYPE_CHARGE: return ("charge");
case DEAL_TYPE_CORRECTION: return ("correction");
case DEAL_TYPE_BUY: descr="buy"; break;
case DEAL_TYPE_SELL: descr="sell"; break;
}
descr=StringFormat("%s %G %s (order #%d, position ID %d)",
descr, // current description
volume, // deal volume
symbol, // deal symbol
ticket, // ticket of the order that caused the deal
pos_ID // ID of a position, in which the deal is included
);
return(descr);
//---
}

© 2000-2010, MetaQuotes Software Corp.


566 Trade Functions

See also
HistorySelect(), HistoryDealsTotal(), HistoryDealSelect()

© 2000-2010, MetaQuotes Software Corp.


567 Trade Functions

HistoryDealGetDouble
Returns the requested property of a deal. The deal property must be of the double type. There are 2
variants of the function.

1. Immediately returns the property value.

double  HistoryDealGetDouble(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryDealGetDouble(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id, // Property identifier
double&  double_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Deal ticket.

property_id
[in] Identifier of a deal property. The value can be one of the values of the
ENUM_DEAL_PROPERTY_DOUBLE enumeration.

double_var
[out] Variable of the double type that accepts the value of the requested property.

Return Value

Value of the double type.

© 2000-2010, MetaQuotes Software Corp.


568 Trade Functions

HistoryDealGetInteger
Returns the requested property of a deal. The deal property must be of the datetime, int type. There
are 2 variants of the function.

1. Immediately returns the property value.

long  HistoryDealGetInteger(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryDealGetInteger(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id, // Property identifier
long&  long_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Trade ticket.

property_id
[in] Identifier of the deal property. The value can be one of the values of the
ENUM_DEAL_PROPERTY_INTEGER enumeration.

long_var
[out] Variable of the long type that accepts the value of the requested property.

Return Value

Value of the long type.

© 2000-2010, MetaQuotes Software Corp.


569 Trade Functions

HistoryDealGetString
Returns the requested property of a deal. The deal property must be of the string type. There are 2
variants of the function.

1. Immediately returns the property value.

string  HistoryDealGetString(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id  // Property identifier
);

2. Returns true or false, depending on the success of the function. If successful, the value of the
property is placed into a target variable passed by reference by the last parameter.

bool  HistoryDealGetString(
ulong  ticket_number,  // Ticket
ENUM_DEAL_PROPERTY  property_id, // Property identifier
string&  string_var  // Here we accept the property value
);

Parameters
ticket_number
[in] Deal ticket.

property_id
[in] Identifier of the deal property. The value can be one of the values of the
ENUM_DEAL_PROPERTY_STRING enumeration.

string_var
[out] Variable of the string type that accepts the value of the requested property.

Return Value

Value of the string type.

© 2000-2010, MetaQuotes Software Corp.


570 Global Variables of the Terminal

Global Variables of the Client Terminal


There is a group set of functions for working with global variables.

Global variables of the client terminal should not be mixed up with variables declared in the global
scope of the mql5 program.

Global variables are kept in the client terminal within 4 weeks since the last access, then they will
be deleted automatically. An access to a global variable is not only setting of a new value, but reading
of the global variable value, as well.

Global variables of the client terminal are accessible simultaneously from all mql5 programs
launched in the client terminal.

Function Action

GlobalVariableCheck Checks the existence of a global variable with


the specified name

GlobalVariableTime Returns time of the last accessing the global


variable

GlobalVariableDel Deletes a global variable

GlobalVariableGet Returns the value of a global variable

GlobalVariableName Returns the name of a global variable by it's


ordinal number in the list of global variables

GlobalVariableSet Sets the new value to a global variable

GlobalVariablesFlush Forcibly saves contents of all global variables to


a disk

GlobalVariableTemp Sets the new value to a global variable, that


exists only in the current session of the
terminal

GlobalVariableSetOnCondition Sets the new value of the existing global


variable by condition

GlobalVariablesDeleteAll Deletes global variables with the specified


prefix in their names

GlobalVariablesTotal Returns the total number of global variables

© 2000-2010, MetaQuotes Software Corp.


571 Global Variables of the Terminal

GlobalVariableCheck
Checks the existence of a global variable with the specified name

bool  GlobalVariableCheck(
string  name  // Global variable name
);

Parameters
name
[in] Global variable name.

Return Value

Returns true, if the global variable exists, otherwise returns false. For more details about the error,
call GetLastError().

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

See also
GlobalVariableTime()

© 2000-2010, MetaQuotes Software Corp.


572 Global Variables of the Terminal

GlobalVariableTime
Returns the time when the global variable was last accessed.

datetime  GlobalVariableTime(
string  name  // name
);

Parameters
name
[in] Name of the global variable.

Return Value

The function returns time of last accessing the specified global variable. Calling a variable to obtain
value is also considered as an access to it. In order to obtain error details, call the GetLastError()
function.

Note

Global variables exist in the client terminal during 4 weeks since they were called last. After that
they are automatic ally deleted.

See also
GlobalVariableCheck()

© 2000-2010, MetaQuotes Software Corp.


573 Global Variables of the Terminal

GlobalVariableDel
Deletes a global variable from the client terminal.

bool  GlobalVariableDel(
string  name  // Global variable name
);

Parameters
name
[in] Global variable name.

Return Value

If successful, the function returns true, otherwise it returns false. To obtain an information about
the error it is necessary to call the function GetLastError().

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

© 2000-2010, MetaQuotes Software Corp.


574 Global Variables of the Terminal

GlobalVariableGet
Returns the value of an existing global variable of the client terminal. There are 2 variants of the
function.

1. Immediately returns the value of the global variable.

double  GlobalVariableGet(
string  name  // Global variable name
);

2. Returns true or false depending on the success of the function run. If successful, the global
variable of the client terminal is placed in a variable passed by reference in the second parameter.

bool  GlobalVariableGet(
string  name  // Global variable name
double& double_var  // This variable will contain the value of the global variable
);

Parameters
name
[in] Global variable name.

double_var
[out] Target variable of the double type, which accepts the value stored in a the global variable of
the client terminal.

Return Value

The value of the existing global variable or 0 in case of an error. For more details about the error,
call GetLastError().

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

© 2000-2010, MetaQuotes Software Corp.


575 Global Variables of the Terminal

GlobalVariableName
Returns the name of a global variable by it's ordinal number.

string  GlobalVariableName(
int  index  // Global variable number in the list of global variables
);

Parameters
index
[in] Sequence number in the list of global variables. It should be greater than or equal to 0 and
less than GlobalVariablesTotal().

Return Value

Global variable name by it's ordinal number in the list of global variables. For more details about the
error, call GetLastError().

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

© 2000-2010, MetaQuotes Software Corp.


576 Global Variables of the Terminal

GlobalVariableSet
Sets a new value for a global variable. If the variable does not exist, the system creates a new global
variable.

datetime  GlobalVariableSet(
string  name,  // Global variable name
double  value  // Value to set
);

Parameters
name
[in] Global variable name.

value
[in] The new numerical value.

Return Value

If successful, the function returns the last modification time, otherwise 0. For more details about
the error, call GetLastError().

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

© 2000-2010, MetaQuotes Software Corp.


577 Global Variables of the Terminal

GlobalVariablesFlush
Forcibly saves contents of all global variables to a disk.

void  GlobalVariablesFlush();

Return Value

No return value.

Note

The terminal writes all the global variables when the work is over, but data can be lost at a sudden
computer operation failure. This function allows independently controlling the process of saving
global variables in case of contingency.

© 2000-2010, MetaQuotes Software Corp.


578 Global Variables of the Terminal

GlobalVariableTemp
The function attempts to create a temporary global variable. If the variable doesn't exist, the system
creates a new temporary global variable.

bool  GlobalVariableTemp(
string  name,  // Global variable name
);

Parameters
name
[in] The name of a temporary global variable.

Return Value

If successful, the function returns true, otherwise - false. For details about the error, to call
GetLastError().

Note

Temporary global variables exist only while the client terminal is running; after the terminal
shutdown they are automatically deleted. Note that during the execution of GlobalVariablesFlush()
temporary global variables are not written to a disk.

After a temporary global variable has been created, it can be accessed and modified the same as
global variable of the client terminal.

© 2000-2010, MetaQuotes Software Corp.


579 Global Variables of the Terminal

GlobalVariableSetOnCondition
Sets the new value of the existing global variable if the current value equals to the third parameter
check_value. If there is no global variable, the function will generate an error
ERR_GLOBALVARIABLE_NOT_FOUND (4501) and return false.

bool  GlobalVariableSetOnCondition(
string  name,  // Global variable name
double  value,  // New value for variable if condition is true
double  check_value  // Check value condition
);

Parameters
name
[in] The name of a global variable.

value
[in] New value.

check_value
[in] The value to check the current value of the global variable.

Return Value

If successful, the function returns true, otherwise it returns false. For details about the error call
GetLastError(). If the current value of the global variable is different from check_value, the
function returns false.

Note

Function provides atomic access to the global variable, so it can be used for providing of a
semaphore at interaction of several Expert Advisors working simultaneously within one client
terminal.

© 2000-2010, MetaQuotes Software Corp.


580 Global Variables of the Terminal

GlobalVariablesDeleteAll
Deletes global variables of the client terminal.

int  GlobalVariablesDeleteAll(
string  prefix_name=NULL  // All global variables with names beginning with the prefix
datetime   limit_data=0  // All global variables that were changed before this date
);

Parameters
prefix_name=NULL
[in] Name prefix global variables to remove. If you specify a prefix NULL or empty string, then all
variables that meet the data criterion will be deleted.

limit_data=0
[in] Date to select global variables by the time of their last modification. The function removes
global variables, which were changed before this date. If the parameter is zero, then all variables
that meet the first criterion (prefix) are deleted.

Return Value

The number of deleted variables.

Note

If both options are equal to zero (prefix_name = NULL and limit_data = 0), then function deletes all
global variables of the terminal. If both parameters are specified, then it deletes global variables
corresponding to both parameters.

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted.

© 2000-2010, MetaQuotes Software Corp.


581 Global Variables of the Terminal

GlobalVariablesTotal
Returns the total number of global variables of the client terminal.

int  GlobalVariablesTotal();

Return Value

Number of global variables.

Note

Global variables exist in the client terminal during 4 weeks since their last use, then they are
automatically deleted. Call of a global variable is not only setting a new value, but also reading the
value of the global variable.

© 2000-2010, MetaQuotes Software Corp.


582 File Functions

File Functions
This is a group of functions for working with files.

There are two directories (with subdirectories) in which working files can be located:

terminal_path\MQL5\FILES\ (in the terminal menu select to view "File" - "Open the data directory");
the common folder for all the terminals installed on a computer - usually located in the directory C:
\Documents and Settings\All Users\Application Data\MetaQuotes\Terminal\Common\.

There is a program method to obtain names of these catalogs using the TerminalInfoString()
function, using the ENUM_TERMINAL_INFO_STRING enumerations:

//--- Folder that stores the terminal data


string terminal_data_path=TerminalInfoString(TERMINAL_DATA_PATH);
//--- Common folder for all client terminals
string common_data_path=TerminalInfoString(TERMINAL_COMMONDATA_PATH);

Work with files from other directories is prohibited.

Function Action

FileFindFirst Starts the search of files in a directory in


accordance with the specified filter

FileFindNext Continues the search started by the


FileFindFirst() function

FileFindClose Closes search handle

FileOpen Opens a file with a specified name and flag

FileDelete Deletes a specified file

FileFlush Writes to a disk all data remaining in the


input/output file buffer

FileIsEnding Defines the end of a file in the process of


reading

FileIsLineEnding Defines the end of a line in a text file in the


process of reading

FileClose Closes a previously opened file

FileIsExist Checks the existence of a file

FileCopy Copies the original file from a local or shared


folder to another file

FileMove Moves or renames a file

FileReadArray Reads arrays of any type except for string from


the file of the BIN type

FileReadBool Reads from the file of the CSV type a string


from the current position till a delimiter (or till

© 2000-2010, MetaQuotes Software Corp.


583 File Functions

the end of a text line) and converts the read


string to a value of bool type

FileReadDatetime Reads from the file of the CSV type a string of


one of the formats: "YYYY.MM.DD HH:MI:SS",
"YYYY.MM.DD" or "HH:MI:SS" - and converts it
into a datetime value

FileReadDouble Reads a double value from the current position


of the file pointer

FileReadFloat Reads a float value from the current position of


the file pointer

FileReadInteger Reads int, short or char value from the current


position of the file pointer

FileReadLong Reads a long type value from the current


position of the file pointer

FileReadNumber Reads from the file of the CSV type a string


from the current position till a delimiter (or til
the end of a text line) and converts the read
string into double value

FileReadString Reads a string from the current position of a


file pointer from a file

FileReadStruct Reads from a binary file contents into a


structure passed as a parameter, from the
current position of the file pointer

FileSeek Moves the position of the file pointer by a


specified number of bytes relative to the
specified position

FileSize Returns the size of a corresponding open file

FileTell Returns the current position of the file pointer


of a corresponding open file

FileWrite Writes data to a file of CSV or TXT type

FileWriteArray Writes arrays of any type except for string into


a file of BIN type

FileWriteDouble Writes value of the double type from the


current position of a file pointer into a binary
file

FileWriteFloat Writes value of the float type from the current


position of a file pointer into a binary file

FileWriteInteger Writes value of the int type from the current


position of a file pointer into a binary file

FileWriteLong Writes value of the long type from the current


position of a file pointer into a binary file

© 2000-2010, MetaQuotes Software Corp.


584 File Functions

FileWriteString Writes the value of a string parameter into a


BIN or TXT file starting from the current
position of the file pointer

FileWriteStruct Writes the contents of a structure passed as a


parameter into a binary file, starting from the
current position of the file pointer

FolderCreate

FolderDelete Removes a selected directory. If the folder is


not empty, then it can't be removed

FolderClean Deletes all files in the specified folder

If the file is opened for writing using FileOpen(), all subfolders specified in the path will be created
if there are no such ones.

© 2000-2010, MetaQuotes Software Corp.


585 File Functions

FileFindFirst
The function starts the search of files in a directory in accordance with the specified filter.

long  FileFindFirst(
string  file_filter,  // String - search filter
string&  returned_filename,  // Name of the file found
int  common_flag  // Defines the search
);

Parameters
file_filter
[in] Search filter. A subdirectory (or sequence of nested subdirectories) relative to the \Files
directory, in which files should be searched for, can be specified in the filter.

returned_filename
[out] The returned parameter, where, in case of success, the name of the first found file is
placed.

common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals. Otherwise, the file is located in a local folder.

Return Value

Returns handle of the object searched, which should be used for further sorting of files by the
FileFindNext() function, or INVALID_HANDLE when there is no file corresponding to the filter (in the
particular case - when the directory is empty). After searching handle must be closed using the
FileFindClose() function.

Example:

void OnStart()
{
string filename;
//---
int found=FileFindFirst("*.*",filename);
if(found!=INVALID_HANDLE)
Print("FileFindFirst returned",filename);
else
{
Print("Files not found!!! Continue search in Common");
found=FileFindFirst("*.*",filename,FILE_COMMON);
if(found!=INVALID_HANDLE)
Print("FileFindFirst in Common returned",filename);
}
}

See also
FileFindNext, FileFindClose

© 2000-2010, MetaQuotes Software Corp.


586 File Functions

FileFindNext
The function continues the search started by FileFindFirst().

bool  FileFindNext(
long  search_handle,  // Search handle
string&  returned_filename  // Name of the file found
);

Parameters
search_handle
[in] Search handle, retrieved by FileFindFirst().

returned_filename
[out] The name of the next file or directory found.

Return Value

If successful returns true, otherwise false.

Example:

void OnStart()
{
string filename;
int i=0;
//---
int search=FileFindFirst("*.*",filename);
if(search!=INVALID_HANDLE)
{
Print("FileFindFirst returned",filename);
while(FileFindNext(search,filename))
{
i++;
Print(i,":",filename);
}
FileFindClose(filename);
}
else
Print("Files not found!!!");
}

See also
FileFindFirst, FileFindClose

© 2000-2010, MetaQuotes Software Corp.


587 File Functions

FileFindClose
The function closes the search handle.

void  FileFindClose(
long  search_handle  // Search handle
);

Parameters
search_handle
[in] Search handle, retrieved by FileFindFirst().

Return Value

No value returned.

Note

Function must be called to free up system resources.

© 2000-2010, MetaQuotes Software Corp.


588 File Functions

FileIsExist
Checks the existence of a file.

bool  FileIsExist(
string  file_name,  // File name
int  common_flag=0  // Search area
);

Parameters
file_name
[in] The name of the file being checked

common_flag=0
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals. Otherwise, the file is located in a local folder.

Return Value

Returns true, if the specified file exists.

Note

If common_flag = FILE_COMMON, then the function looks for the file in a shared folder for all client
terminals, otherwise the function looks for a file in a local folder (MQL5 \ Files or MQL5 \ Tester \
Files in the case of testing).

© 2000-2010, MetaQuotes Software Corp.


589 File Functions

FileOpen
The function opens the file with the specified name and flag.

int  FileOpen(
string  file_name,  // File name
int  open_flags,  // Combination of flags
short  delimiter='\t'  // Delimiter
uint  codepage=CP_ACP  // Code page
);

Parameters
file_name
[in] The name of the file can contain subfolders. If the file is opened for writing, these subfolders
will be created if there are no such ones.

open_flags
[in] combination of flags determining the operation mode for the file. The flags are defined as
follows:
FILE_READ file is opened for reading
FILE_WRITE file is opened for writing
FILE_BIN binary read-write mode (no conversion from a string and to a string)
FILE_CSV file of csv type (all recorded items are converted to the strings of unicode or ansi type,
and are separated by a delimiter)
FILE_TXT a simple text file (the same as csv, but the delimiter is not taken into account)
FILE_ANSI lines of ANSI type (single-byte symbols)
FILE_UNICODE lines of UNICODE type (double-byte characters)
FILE_SHARE_READ shared reading from several programs
FILE_SHARE_WRITE shared writing from several programs
FILE_COMMON location of the file in a shared folder for all client terminals

delimiter='\t'
[in] value to be used as a separator in txt or csv-file. If the csv-file delimiter is not specified, it
defaults to a tab. If the txt-file delimiter is not specified, then no separator is used. If the
separator is clearly set to 0, then no separator is used.

codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.

Return Value

If a file has been opened successfully, the function returns the file handle, which is then used to
access the file data. In case of failure returns INVALID_HANDLE.

Note

The file is opened in the folder of the client terminal in the subfolder MQL5\files (or MQL5
\tester\files in case of testing). If FILE_COMMON is specified among flags, the file is opened in a
shared folder for all MetaTrader 5 client terminals.

Example:

© 2000-2010, MetaQuotes Software Corp.


590 File Functions

//+------------------------------------------------------------------+
//| Script program start function |
//+------------------------------------------------------------------+
void OnStart()
{
//--- incorrect file opening method
string terminal_data_path=TerminalInfoString(TERMINAL_DATA_PATH);
string filename=terminal_data_path+"\\MQL5\\Files\\"+"fractals.csv";
int filehandle=FileOpen(filename,FILE_WRITE|FILE_CSV);
if(filehandle<0)
{
Print("Failed to open the file by the absolute path");
Print("Error code",GetLastError());
}

//--- correct way of working in the "file sandbox"


ResetLastError();
filehandle=FileOpen("fractals.csv",FILE_WRITE|FILE_CSV);
if(filehandle!=INVALID_HANDLE)
{
FileWrite(filehandle,TimeCurrent(),Symbol(),PERIOD_CURRENT);
FileClose(filehandle);
Print("FileOpen OK");
}
else Print("Operation FileOpen failed, error",GetLastError());
//--- another example with the creation of an enclosed directory in MQL5\Files\
string subfolder="Research";
filehandle=FileOpen(subfolder+"\\fractals.txt",FILE_WRITE|FILE_CSV);
if(filehandle!=INVALID_HANDLE)
{
FileWrite(filehandle,TimeCurrent(),Symbol(),PERIOD_CURRENT);
FileClose(filehandle);
Print("The file most be created in the folder "+terminal_data_path+"\\"+subfolder);
}
else Print("File open failed, error",GetLastError());
}

See also
FileFindFirst, FolderCreate, File opening flags

© 2000-2010, MetaQuotes Software Corp.


591 File Functions

FileClose
Close the file previously opened by FileOpen().

void  FileClose(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

No value returned.

© 2000-2010, MetaQuotes Software Corp.


592 File Functions

FileCopy
The function copies the original file from a local or shared folder to another file.

bool  FileCopy(
string  src_filename,  // Name of a source file
int  common_flag,  // Location
string  dst_filename,  // Name of the destination file
int  mode_flags  // Access mode
);

Parameters
src_filename
[in] File name to copy.

common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals. Otherwise, the file is located in a local folder.

dst_filename
[in] Result file name.

mode_flags
[in] Access flags. The parameter can contain only 2 flags: FILE_REWRITE and/or FILE_COMMON -
other flags are ignored. If the file already exists, and the FILE_REWRITE flag hasn't been
specified, then the file will not be rewritten, and the function will return false.

Return Value

In case of failure the function returns false.

Note

If the new file already exists, the copy will be made depending on the availability of the
FILE_REWRITE flag in the mode_flags parameter.

© 2000-2010, MetaQuotes Software Corp.


593 File Functions

FileDelete
Deletes the specified file in a local folder of the client terminal.

bool  FileDelete(
string  file_name  // File name to delete
int  common_flag=0  // Location of the file to delete
);

Parameters
file_name
[in] File name.

common_flag=0
[in] Flag determining the file location. If common_flag = FILE_COMMON, then the file is located in
a shared folder for all client terminals. Otherwise, the file is located in a local folder.

Return Value

In case of failure the function returns false.

Note

Deletes the specified file from a local folder of the client terminal (MQL5\files or MQL5\tester\files
in case of testing). If common_flag = FILE_COMMON, then the function removes the file from the
shared folder for all client terminals.

© 2000-2010, MetaQuotes Software Corp.


594 File Functions

FileMove
Moves a file from a local or shared folder to another folder.

bool  FileMove(
string  src_filename,  // File name for the move operation
int  common_flag,  // Location
string  dst_filename,  // Name of the destination file
int  mode_flags  // Access mode
);

Parameters
src_filename
[in] File name to move/rename.

common_flag
[in] Flag determining the location of the file. If common_flag = FILE_COMMON, then the file is
located in a shared folder for all client terminals. Otherwise, the file is located in a local folder.

dst_filename
[in] File name after operation

mode_flags
[in] Access flags. The parameter can contain only 2 flags: FILE_REWRITE and/or FILE_COMMON -
other flags are ignored. If the file already exists and the FILE_REWRITE flag isn't specified, the
file will not be rewritten, and the function will return false.

Return Value

In case of failure the function returns false.

Note

If the new file already exists, the copy will be made depending on the availability of the
FILE_REWRITE flag in the mode_flags parameter.

© 2000-2010, MetaQuotes Software Corp.


595 File Functions

FileFlush
Writes to a disk all data remaining in the input/output file buffer.

void  FileFlush(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

No value returned.

Note

Function FileFlush () must be called between the operations of reading from a file and write to a
file.

© 2000-2010, MetaQuotes Software Corp.


596 File Functions

FileIsEnding
Defines the end of a file in the process of reading.

bool  FileIsEnding(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The function returns true if the file end has been reached in the process of reading or moving of the
file pointer.

© 2000-2010, MetaQuotes Software Corp.


597 File Functions

FileIsLineEnding
Defines the line end in a text file in the process of reading.

bool  FileIsLineEnding(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

Returns true if in the process of reading txt or csv-file reached the end of the line (the characters
CR-LF).

© 2000-2010, MetaQuotes Software Corp.


598 File Functions

FileReadArray
Reads from a file of BIN type arrays of any type except string (may be an array of structures, not
containing strings, and dynamic arrays).

uint  FileReadArray(
int  file_handle  // File handle
void  array[],  // Array to record
int  start_item=0,  // start array position to write
int  items_count=WHOLE_ARRAY // count to read
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

array[]
[out] An array where the data will be loaded.

start_item=0
[in] Start position to write to the array.

items_count=WHOLE_ARRAY
[in] Number of elements to read. By default, reads the entire array (cnt=WHOLE_ARRAY).

Return Value

Number of elements read.

Note

String array can be read only from the file of TXT type. If necessary, the function tries to increase
the size of the array.

See also
Variables

© 2000-2010, MetaQuotes Software Corp.


599 File Functions

FileReadBool
Reads from the file of CSV type string from the current position to a delimiter (or till the end of the
text line) and converts the read string to a bool type value.

bool  FileReadBool(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

Line read may be set to "true", "false" or the symbolic representation of integers "0" or "1". A
nonzero value is converted to a logical true. The function returns the converted value.

See also
Type bool

© 2000-2010, MetaQuotes Software Corp.


600 File Functions

FileReadDatetime
Reads from the file of CSV type a string of one of the formats: "YYYY.MM.DD HH:MI:SS", "YYYY.MM.
DD" or "HH:MI:SS" - and converts it into a value of datetime type.

datetime  FileReadDatetime(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of datetime type.

See also
Type datetime, StringToTime, TimeToString

© 2000-2010, MetaQuotes Software Corp.


601 File Functions

FileReadDouble
Reads a double-precision floating point number (double) from the current position of the binary file.

double  FileReadDouble(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of double type.

Note

For more details about the error, call GetLastError().

See also
Real types (double, float), StringToDouble, DoubleToString

© 2000-2010, MetaQuotes Software Corp.


602 File Functions

FileReadFloat
Reads the single-precision floating point number (float) from the current position of the binary file.

float  FileReadFloat(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of float type.

Note

For more details about the error, call GetLastError().

See also
Real types (double, float), FileReadDouble

© 2000-2010, MetaQuotes Software Corp.


603 File Functions

FileReadInteger
The function reads int, short or char value from the current position of the file pointer depending on the
length specified in bytes.
int  FileReadInteger(
int  file_handle  // File handle
int  size=INT_VALUE  // Size of an integer in bytes
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

size=INT_VALUE
[in] Number of bytes (up to 4 inclusive), that should be written. The corresponding constants are
provided: CHAR_VALUE = 1, SHORT_VALUE = 2 and INT_VALUE = 4, so the function can read the
whole value of char, short or int type.

Return Value

The value of int type. Since the int type value is returned, it can be converted to any integer,
signed or unsigned value. File pointer is moved by the number of bytes of the read integer type.

See also
IntegerToString, StringToInteger, Integer types

© 2000-2010, MetaQuotes Software Corp.


604 File Functions

FileReadLong
The function reads an integer of long type (8 bytes) from the current position of the binary file.

long  FileReadLong(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of long type.

See also
Integer types, FileReadInteger

© 2000-2010, MetaQuotes Software Corp.


605 File Functions

FileReadNumber
The function reads from the CSV file a string from the current position till a separator (or till the end
of a text string) and converts the read string to a value of double type.

double  FileReadNumber(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of double type.

© 2000-2010, MetaQuotes Software Corp.


606 File Functions

FileReadString
The function reads from a string from the current position of a file pointer in a file.

string  FileReadString(
int  file_handle  // File handle
int  size=-1  // Length of the string
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

size=-1
[in] Number of characters to read.

Return Value

Line read (string).

Note

When reading from a bin-file. the length of a string to read must be specified. When reading from a
txt-file the string length is not required, and the string will be read from the current position to the
line feed character "\r\n". When reading from a csv-file, the string length isn't required also, the
string will be read from the current position till the nearest delimiter or till the text string end
character.

If the file is opened with FILE_ANSI flag, then the line read is converted to Unicode.

See also
Type string, Data Conversion

© 2000-2010, MetaQuotes Software Corp.


607 File Functions

FileReadStruct
The function reads contents into a structure passed as a parameter from a bin-file, starting with the
current position of the file pointer.

uint  FileReadStruct(
int  file_handle  // File handle
any_simple_struct  str_object,  // target structure to read to
int  size=-1  // structure size in bytes
);

Parameters
file_handle
[in] File descriptor of an open bin-file.

str_object
[out] The object of this structure. The structure should not contain strings, dynamic arrays or
virtual functions.

size=-1
[in] Number of bytes that should be read. If size is not specified or the indicated value is greater
than the size of the structure, the exact size of the specified structure is used.

Return Value

If successful the function returns the number of bytes read. File pointer is moved by the same
number of bytes.

See also
Structures and classes

© 2000-2010, MetaQuotes Software Corp.


608 File Functions

FileSeek
The function moves the position of the file pointer by a specified number of bytes relative to the
specified position.

void  FileSeek(
long  file_handle  // File handle
int  offset,  // In bytes
ENUM_FILE_POSITION  origin  // Position for reference
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

offset
[in] The shift in bytes (may take a negative value).

origin
[in] The starting point for the displacement. Can be one of values of ENUM_FILE_POSITION.

Return Value

No value returned.

Note

If the execution of the FileSeek() function results in a negative shift (going beyond the "level
boundary" of the file), the file pointer will be set to the file beginning.

If a position is set beyond the "right boundary" of the file (larger than the file size), the next writing
to the file will be performed not from the end of the file, but from the position set. In this case
indefinite values will be written for the previous file end and the position set.

© 2000-2010, MetaQuotes Software Corp.


609 File Functions

FileSize
The function returns the file size in bytes.

ulong  FileSize(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

The value of type int.

Note

To obtain information about the error call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


610 File Functions

FileTell
The file returns the current position of the file pointer of an open file.

ulong  FileTell(
int  file_handle  // File handle
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

Return Value

Current position of the file descriptor in bytes from the beginning of the file.

Note

To obtain information about the error call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


611 File Functions

FileWrite
The function is intended for writing of data into a CSV file, delimiter being inserted automatically
unless it is equal to 0. After writing into the file, the line end character "\r\n" will be added.

uint  FileWrite(
int  file_handle  // File handle
... // List of recorded parameters
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

...
[in] The list of parameters separated by commas, to write to the file. The number of written
parameters can be up to 63.

Return Value

Number of bytes written.

Note

Numbers will be converted into a text at output (see the Print() function). Data of the double type
are output with the accuracy of 16 digits after the decimal point, and the data can be displayed
either in traditional or in scientific format - depending on which format will be the most compact.
The data of the float type are shown with 5 digits after the decimal point. To output real numbers
with different precision or in a clearly specified format, use DoubleToString().

Numbers of the bool type are displayed as "true" or "false" strings. Numbers of the datetime type
are displayed as "YYYY.MM.DD HH:MI:SS".

See also
Comment, Print, StringFormat

© 2000-2010, MetaQuotes Software Corp.


612 File Functions

FileWriteArray
The function writes arrays of any type except for string to a BIN file (can be an array of structures not
containing strings or dynamic arrays).

int  FileWriteArray(
int  file_handle  // File handle
void  array[],  // Array
int  start_item=0,  // Start index in the array
int  items_count=WHOLE_ARRAY // Number of elements
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

array[]
[out] Array for recording.

start_item=0
[in] Initial index in the array (number of the first recorded element).

items_count=WHOLE_ARRAY
[in] Number of items to record (WHOLE_ARRAY means that records all items starting with the
number start_item until the end of the array).

Return Value

Number of recorded items.

Note

String array can be recorded in a TXT file. In this case, strings are automatically ended by the line
end characters "\r\n". Depending on the file type ANSI or UNICODE, strings are either converted to
ansi-encoding or not.

See also
Variables

© 2000-2010, MetaQuotes Software Corp.


613 File Functions

FileWriteDouble
The function writes the value of a double parameter to a file, starting from the current position of the
file pointer.

uint  FileWriteDouble(
int  file_handle  // File handle
double  dvalue  // Value to write
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

dvalue
[in] The value of double type.

Return Value

If successful the function returns the number of bytes written (in this case sizeof(double)=8). The
file pointer is shifted by the same number of bytes.

See also
Real types (double, float)

© 2000-2010, MetaQuotes Software Corp.


614 File Functions

FileWriteFloat
The function writes the value of the float parameter to a bin-file, starting from the current position of
the file pointer.

uint  FileWriteFloat(
int  file_handle  // File handle
float  fvalue  // Value to be written
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

fvalue
[in] The value of float type.

Return Value

If successful the function returns the number of bytes written (in this case sizeof(float)=4). The file
pointer is shifted by the same number of bytes.

See also
Real types (double, float), FileWriteDouble

© 2000-2010, MetaQuotes Software Corp.


615 File Functions

FileWriteInteger
The function writes the value of the int parameter to a bin-file, starting from the current position of
the file pointer.

uint  FileWriteInteger(
int  file_handle  // File handle
int  ivalue,  // Value to be written
int  size=INT_VALUE  // Size in bytes
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

ivalue
[in] Integer value.

size=INT_VALUE
[in] Number of bytes (up to 4 inclusive), that should be written. The corresponding constants are
provided: CHAR_VALUE=1, SHORT_VALUE=2 and INT_VALUE=4, so the function can write the
integer value of char, uchar, short, ushort, int, or uint type.

Return Value

If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.

See also
IntegerToString, StringToInteger, Integer types

© 2000-2010, MetaQuotes Software Corp.


616 File Functions

FileWriteLong
The function writes the value of the long-type parameter to a bin-file, starting from the current
position of the file pointer.

uint  FileWriteLong(
int  file_handle  // File handle
long  lvalue  // Value to be written
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

lvalue
[in] Value of type long.

Return Value

If successful the function returns the number of bytes written (in this case sizeof(long)=8). The file
pointer is shifted by the same number of bytes.

See also
Integer types, FileWriteInteger

© 2000-2010, MetaQuotes Software Corp.


617 File Functions

FileWriteString
The function writes the value of a string-type parameter into a BIN or TXT file starting from the
current position of the file pointer. When writing to a TXT file: if there is a symbol in the string '\n'
(LF) without previous character '\r' (CR), then before '\n' the missing '\r' is added.

uint  FileWriteString(
int  file_handle  // File handle
string  svalue,  // string to write
int  size=-1  // number of symbols
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

svalue
[in] String.

size=-1
[in] The number of characters that you want to write. This option is needed for writing a string
into a BIN file. If the size is not specified, then the entire string without the trailer 0 is written. If
you specify a size smaller than the length of the string, then a part of the string without the trailer
0 is written. If you specify a size greater than the length of the string, the string is filled by the
appropriate number of zeros. For files of TXT type, this parameter is ignored and the string is
written entirely.

Return Value

If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.

Note

Note that when writing to a file opened by the FILE_UNICODE flag (or without a flag FILE_ANSI),
then the number of bytes written will be twice as large as the number of string characters written.
When recording to a file opened with the FILE_ANSI flag, the number of bytes written will coincide
with the number of string characters written.

See also
Type string, StringFormat

© 2000-2010, MetaQuotes Software Corp.


618 File Functions

FileWriteStruct
The function writes into a bin-file contents of a structure passed as a parameter, starting from the
current position of the file pointer.

uint  FileWriteStruct(
int  file_handle  // File handle
any_simple_struct  str_object&,  // link to an object
int  size=-1 // size to be written in bytes
);

Parameters
file_handle
[in] File descriptor returned by FileOpen().

str_object&
[in] Reference to the object of this structure. The structure should not contain strings, dynamic
arrays or virtual functions.

size=-1
[in] Number of bytes that you want to record. If size is not specified or the specified number of
bytes is greater than the size of the structure, the entire structure is written.

Return Value

If successful the function returns the number of bytes written. The file pointer is shifted by the
same number of bytes.

See also
Structures and classes

© 2000-2010, MetaQuotes Software Corp.


619 File Functions

FolderCreate
The function creates a directory in the Files directory (depending on the value of common_flag).

bool  FolderCreate(
string  folder_name,  // String with the name of the new folder
int  common_flag=0  // Scope
);

Parameters
folder_name
[in] The name of the directory you want to create. Contains the full path to the folder.

common_flag=0
[in] Flag determining the location of the directory. If common_flag=FILE_COMMON, then the
directory is in the shared folder for all client terminals. Otherwise, the directory is in a local folder
(MQL5\files or MQL5\tester\files in case of testing).

Return Value

Returns true if successful, otherwise - false.

© 2000-2010, MetaQuotes Software Corp.


620 File Functions

FolderDelete
The function removes the specified directory. If the folder is not empty, then it can't be removed.

bool  FolderDelete(
string  folder_name,  // String with the name of the folder to delete
int  common_flag=0  // Scope
);

Parameters
folder_name
[in] The name of the directory you want to delete. Contains the full path to the folder.

common_flag=0
[in] Flag determining the location of the directory. If common_flag=FILE_COMMON, then the
directory is in the shared folder for all client terminals. Otherwise, the directory is in a local folder
(MQL5\files or MQL5\tester\files in the case of testing).

Return Value

Returns true if successful, otherwise false.

Note

If the directory contains at least one file and/or subdirectory, then this directory can't be deleted, it
must be cleared first. FolderClean() is used to clear a folder of all its files or subfolders.

© 2000-2010, MetaQuotes Software Corp.


621 File Functions

FolderClean
The function deletes all files in a specified folder.

bool  FolderClean(
string  folder_name,  // String with the name of the deleted folder
int  common_flag=0  // Scope
);

Parameters
folder_name
[in] The name of the directory where you want to delete all files. Contains the full path to the
folder.

common_flag=0
[in] Flag determining the location of the directory. If common_flag = FILE_COMMON, then the
directory is in the shared folder for all client terminals. Otherwise, the directory is in a local folder
(MQL5\files or MQL5\tester\files in case of testing).

Return Value

Returns true if successful, otherwise false.

Note

This function should be used with caution, since all the files and all subdirectories are deleted
irretrievably.

© 2000-2010, MetaQuotes Software Corp.


622 Custom Indicators

Custom Indicators
This is the group functions used in the creation of custom indicators. These functions can't be used
when writing Expert Advisors and Scripts.

Function Action

SetIndexBuffer Binds the specified indicator buffer with one-


dimensional dynamic array of the double type

IndicatorSetDouble Sets the value of an indicator property of the


double type

IndicatorSetInteger Sets the value of an indicator property of the


int type

IndicatorSetString Sets the value of an indicator property of the


string type

PlotIndexSetDouble Sets the value of an indicator line property of


the type double

PlotIndexSetInteger Sets the value of an indicator line property of


the int type

PlotIndexSetString Sets the value of an indicator line property of


the string type

PlotIndexGetInteger Returns the value of an indicator line property


of the integer type

All the necessary calculations of a custom indicator must be placed in the predetermined function
OnCalculate(). If you use a short form of the OnCalculate() function call, like

int OnCalculate (const int rates_total, const int prev_calculated, const int begin, const double& p

then the rates_total variable contains the value of the total number of elements of the price[]
array, passed as an input parameter for calculating indicator values.

Parameter prev_calculated is the result of the execution of OnCalculate() at the previous call; it
allows organizing a saving algorithm for calculating indicator values. For example, if the current value
rates_total = 1000, prev_calculated = 999, then perhaps it's enough to make calculations only for one
value of each indicator buffer.

If the information about the size of the input array price would have been unavailable, then it would
lead to the necessity to make calculations for 1000 values of each indicator buffer. At the first call of
OnCalculate() value prev_calculated = 0. If the price[] array has changed somehow, then in this case
prev_calculated is also equal to 0.

The begin parameter shows the number of initial values of the price array, which don't contain data
for calculation. For example, if values of Accelerator Oscillator (for which the first 37 values aren't
calculated) were used as an input parameter, then begin = 37. For example, let's consider a simple
indicator:

#property indicator_chart_window

© 2000-2010, MetaQuotes Software Corp.


623 Custom Indicators

#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Label1"
#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double Label1Buffer[];
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Label1Buffer,INDICATOR_DATA);
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const int begin,
const double &price[])

{
//---
Print("begin =",begin," prev_calculated =",prev_calculated," rates_total =",rates_total);
//--- return value of prev_calculated for next call
return(rates_total);
}

Drag it from the "Navigator" window to the window of the Accelerator Oscillator indicator and we
indicate that calculations will be made based on the values of the previous indicator:

© 2000-2010, MetaQuotes Software Corp.


624 Custom Indicators

As a result, the first call of OnCalculate() the value of prev_calculated will be equal to zero, and in
further calls it will be equal to the rates_total value (until the number of bars on the price chart
increases).

The value of the begin parameter will be exactly equal to the number of initial bars, for which the
values of the Accelerator indicator aren't calculated according to the logic of this indicator. If we look
at the source code of the custom indicator Accelerator.mq5, we'll see the following lines in the OnInit()
function:

//--- sets first bar from what index will be drawn


PlotIndexSetInteger(0,PLOT_DRAW_BEGIN,37);

Using the function PlotIndexSetInteger(0, PLOT_DRAW_BEGIN, empty_first_values), we set the


number of non-existing first values in the zero indicator array of a custom indicator, which we don't

© 2000-2010, MetaQuotes Software Corp.


625 Custom Indicators

need to accept for calculation (empty_first_values). Thus, we have mechanisms to:

1. set the number of initial values of an indicator, which shouldn't be used for calculations in another
custom indicator;
2. get information on the number of first values to be ignored when you call another custom indicator,
without going into the logic of its calculations.

© 2000-2010, MetaQuotes Software Corp.


626 Custom Indicators

Connection between Indicator Properties and Corresponding


Functions
Every custom indicator has numerous properties, some of which are obligatory and are always
positioned at the beginning of description. They are the following properties:

indication of a window to plot the indicator – indicator_separate_window or indicator_chart_window;


number of indicator buffers – indicator_buffers;
number of plots of the indicator – indicator_plots.
Also there are other properties that can be set both through preprocessor directives and through
functions intended for custom indicator creation. These properties and corresponding functions are
described in the following table.

Directives for properties of Functions of IndicatorSet... Description of the adjusted


indicator subwindow () type property of the subwindow

indicator_minimum IndicatorSetDouble( Minimal value of the vertical


INDICATOR_MINIMUM, axis
dMaxValue)

indicator_maximum IndicatorSetDouble( Maximal value of the vertical


INDICATOR_MAXIMUM, axis
dMinValue)

indicator_levelN IndicatorSetDouble( Vertical axis value for N level


INDICATOR_LEVELVALUE, N-1,
nLevelValue)

нет директивы IndicatorSetString( Name of a displayed level


препроцессора INDICATOR_LEVELTEXT, N-1,
sLevelName)

indicator_levelcolor IndicatorSetInteger( Color of N level


INDICATOR_LEVELCOLOR, N-
1, nLevelColor)

indicator_levelwidth IndicatorSetInteger( Line width for N level


INDICATOR_LEVELWIDTH, N-
1, nLevelWidth)

indicator_levelstyle IndicatorSetInteger( Line style for N level


INDICATOR_LEVELSTYLE, N-1,
nLevelStyle)

Directives for plotting Functions of Description of the adjusted


properties PlotIndexSet...() type property of a plot

indicator_labelN PlotIndexSetString(N-1, Short name of the number N


PLOT_LABEL,sLabel) plot. It is displayed in
DataWindow and in the pop-up
tooltip when pointing the
mouse cursor over it

indicator_colorN PlotIndexSetInteger(N-1, Line color for N plot

© 2000-2010, MetaQuotes Software Corp.


627 Custom Indicators

PLOT_LINE_COLOR, nColor)

indicator_styleN PlotIndexSetInteger(N-1, Line style for N plot


PLOT_LINE_STYLE, nType)

indicator_typeN PlotIndexSetInteger(N-1, Line type for N plot


PLOT_DRAW_TYPE, nType)

indicator_widthN PlotIndexSetInteger(N-1, Line width for N plot


PLOT_LINE_WIDTH, nWidth)

Common indicator Functions of IndicatorSet... Description


properties () type

no preprocessor directive IndicatorSetString( Sets the convenient short


INDICATOR_SHORTNAME, name of the indicator that will
sShortName) be displayed in the list of
indicators (opened in the
terminal by pressing Ctrl+I).

no preprocessor directive IndicatorSetInteger( Sets required accuracy of


INDICATOR_DIGITS, nDigits) display of indicator values -
number of decimal places

no preprocessor directive IndicatorSetInteger( Sets number of levels in the


INDICATOR_LEVELS, nLevels) indicator window

indicator_applied_price No function, the property can Default price type used for the
be set only by the indicator calculation. It is
preprocessor directive. specified when necessary, only
if OnCalculate() of the first
type is used.
The property value can also be
set from the dialog of
indicator properties in the
"Parameters" tab - "Apply to".

It should be noted that numeration of levels and plots in preprocessor terms starts with one, while
numeration of the same properties at using functions starts with zero, i.e. the indicated value must
be by 1 less than that indicated for #property.

There are several directives, for which there are no corresponding functions:

Directive Description

indicator_chart_window Indicator is displayed in the main window

indicator_separate_window Indicator is displayed in a separate subwindow

indicator_buffers Number of required indicator buffers

indicator_plots Number of plots in the indicator

© 2000-2010, MetaQuotes Software Corp.


628 Custom Indicators

SetIndexBuffer
The function binds a specified indicator buffer with one-dimensional dynamic array of the double type
announced at the global level.

bool  SetIndexBuffer(
int  index,  // buffer index
double  buffer[],  // array
ENUM_INDEXBUFFER_TYPE  data_type  // what will be stored
);

Parameters
index
[in] Number of the indicator buffer. The numbering starts with 0. The number must be less than
the value declared in #property indicator_buffers.

buffer[]
[in] An array declared in the custom indicator program.

data_type
[in] Type of data stored in the indicator array. By default it is INDICATOR_DATA (values of the
calculated indicator). It may also take the value of INDICATOR_COLOR_INDEX; in this case this
buffer is used for storing color indexes for the previous indicator buffer. You can specify up to 64
colors in the #property indicator_colorN line. The INDICATOR_CALCULATIONS value means that the
buffer is used in intermediate calculations of the indicator and is not intended for drawing.

Return Value

If successful, returns true, otherwise - false.

Note

After binding, the dynamic array buffer[] will be indexed as in common arrays, even if the indexing
of timeseries is pre-installed for the bound array. If you want to change the order of access to
elements of the indicator array, use the ArraySetAsSeries() function.

Example:

//+------------------------------------------------------------------+
//| TestCopyBuffer1.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"

#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot MA

© 2000-2010, MetaQuotes Software Corp.


629 Custom Indicators

#property indicator_label1 "MA"


#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input bool AsSeries=true;
input int period=15;
input ENUM_MA_METHOD smootMode=MODE_EMA;
input ENUM_APPLIED_PRICE price=PRICE_CLOSE;
input int shift=0;
//--- indicator buffers
double MABuffer[];
int ma_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
if(AsSeries) ArraySetAsSeries(MABuffer,true);
Print("Indicator buffer is timeseries =",ArrayGetAsSeries(MABuffer));
SetIndexBuffer(0,MABuffer,INDICATOR_DATA);
Print("Indicator buffer after SetIndexBuffer() is timeseries =",
ArrayGetAsSeries(MABuffer));

//--- change the oredr of accessing elements of the indicator buffer


ArraySetAsSeries(MABuffer,AsSeries);

IndicatorSetString(INDICATOR_SHORTNAME,"MA("+period+")"+AsSeries);
//---
ma_handle=iMA(Symbol(),0,period,shift,smootMode,price);
return(0);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{

© 2000-2010, MetaQuotes Software Corp.


630 Custom Indicators

//--- Copy the values of the moving average in the buffer MABuffer
int copied=CopyBuffer(ma_handle,0,0,rates_total,MABuffer);

Print("MABuffer[0] =",MABuffer[0]);// Depending on the value AsSeries


// Will receive a very old value
// Or for the current unfinished bar

//--- return value of prev_calculated for next call


return(rates_total);
}
//+------------------------------------------------------------------+

See also

Properties custom indicators, Access to timeseries and indicators

© 2000-2010, MetaQuotes Software Corp.


631 Custom Indicators

IndicatorSetDouble
The function sets the value of the corresponding indicator property. Property of the indicator should
be of the double type. There are 2 variants of the function.

Call indicating identifier of the property.

bool  IndicatorSetDouble(
int  prop_id,  // identifier
double  prop_value  // value to be set
);

Call indicating the identifier and modifier of the property.

bool  IndicatorSetDouble(
int  prop_id,  // identifier
int  prop_modifier,  // modifier
double  prop_value  // value to be set
)

Parameters
prop_id
[in] The value can be one of the values of the ENUM_CUSTOMIND_PROPERTY_DOUBLE
enumeration.

prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise - false.

© 2000-2010, MetaQuotes Software Corp.


632 Custom Indicators

IndicatorSetInteger
The function sets the value of the corresponding indicator property. The property must be of int or
color type. There are 2 variants of the function.

Call indicating identifier of the property.

bool  IndicatorSetInteger(
int  prop_id,  // identifier
int  prop_value  // value to be set
);

Call indicating the identifier and modifier of the property.

bool  IndicatorSetInteger(
int  prop_id,  // identifier
int  prop_modifier,  // modifier
int  prop_value  // value to be set
)

Parameters
prop_id
[in] The value can be one of the values of the ENUM_CUSTOMIND_PROPERTY_INTEGER
enumeration.

prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise - false.

© 2000-2010, MetaQuotes Software Corp.


633 Custom Indicators

IndicatorSetString
The function sets the value of a corresponding indicator property. The indicator property must be of
the string type. There are 2 variants of the function.

Call indicating identifier of the property.

bool  IndicatorSetString(
int  prop_id,  // identifier
string  prop_value  // value to be set
);

Call indicating the identifier and modifier of the property.

bool  IndicatorSetString(
int  prop_id,  // identifier
int  prop_modifier,  // modifier
string  prop_value  // value to be set
)

Parameters
prop_id
[in] The value can be one of the values of the ENUM_CUSTOMIND_PROPERTY_STRING
enumeration.

prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise - false.

© 2000-2010, MetaQuotes Software Corp.


634 Custom Indicators

PlotIndexSetDouble
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the double type.

bool  PlotIndexSetDouble(
int  plot_index,  // plotting style index
int  prop_id,  // property identifier
double  prop_value  // value to be set
);

Parameters
plot_index
[in] Index of the graphical plotting

prop_id
[in] The value can be one of the values of the ENUM_PLOT_PROPERTY_DOUBLE enumeration.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise false.

© 2000-2010, MetaQuotes Software Corp.


635 Custom Indicators

PlotIndexSetInteger
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the int, char, bool or color type. There are 2 variants of the function.

Call indicating identifier of the property.

bool  PlotIndexSetInteger(
int  plot_index,  // plotting style index
int  prop_id,  // property identifier
int  prop_value  // value to be set
);

Call indicating the identifier and modifier of the property.

bool  PlotIndexSetInteger(
int  plot_index,  // plotting style index
int  prop_id,  // property identifier
int  prop_modifier,  // property modifier
int  prop_value  // value to be set
)

Parameters
plot_index
[in] Index of the graphical plotting

prop_id
[in] The value can be one of the values of the ENUM_PLOT_PROPERTY_INTEGER enumeration.

prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise false.

Example: an indicator that draws a three-color line. The color scheme changes every 5 ticks.

© 2000-2010, MetaQuotes Software Corp.


636 Custom Indicators

#property indicator_chart_window
#property indicator_buffers 2
#property indicator_plots 1
//---- plot ColorLine
#property indicator_label1 "ColorLine"
#property indicator_type1 DRAW_COLOR_LINE
#property indicator_color1 Red,Green,Blue
#property indicator_style1 STYLE_SOLID
#property indicator_width1 3
//--- indicator buffers
double ColorLineBuffer[];
double ColorBuffer[];
int MA_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,ColorLineBuffer,INDICATOR_DATA);
SetIndexBuffer(1,ColorBuffer,INDICATOR_COLOR_INDEX);
//--- get MA handle
MA_handle=iMA(Symbol(),0,10,0,MODE_EMA,PRICE_CLOSE);
//---
}
//+------------------------------------------------------------------+
//| get color index |
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


637 Custom Indicators

int getIndexOfColor(int i)
{
int j=i%300;
if(j<100) return(0);// first index
if(j<200) return(1);// second index
return(2); // third index
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
static int ticks=0,modified=0;
int limit;
//--- first calculation or number of bars was changed
if(prev_calculated==0)
{
//--- copy values of MA into indicator buffer ColorLineBuffer
int copied=CopyBuffer(MA_handle,0,0,rates_total,ColorLineBuffer);
if(copied<=0) return(0);// copying failed - throw away
//--- now set line color for every bar
for(int i=0;i<rates_total;i++)
ColorBuffer[i]=getIndexOfColor(i);
}
else
{
//--- copy values of MA into indicator buffer ColorLineBuffer
int copied=CopyBuffer(MA_handle,0,0,rates_total,ColorLineBuffer);
if(copied<=0) return(0);

ticks++;// ticks counting


if(ticks>=5)//it's time to change color scheme
{
ticks=0; // reset counter
modified++; // counter of color changes
if(modified>=3)modified=0;// reset counter
ResetLastError();
switch(modified)

© 2000-2010, MetaQuotes Software Corp.


638 Custom Indicators

{
case 0:// first color scheme
PlotIndexSetInteger(0,PLOT_LINE_COLOR,0,Red);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,1,Blue);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,2,Green);
Print("Color scheme"+modified);
break;
case 1:// second color scheme
PlotIndexSetInteger(0,PLOT_LINE_COLOR,0,Yellow);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,1,Pink);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,2,LightSlateGray);
Print("Color scheme"+modified);
break;
default:// third color scheme
PlotIndexSetInteger(0,PLOT_LINE_COLOR,0,LightGoldenrod);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,1,Orchid);
PlotIndexSetInteger(0,PLOT_LINE_COLOR,2,LimeGreen);
Print("Color scheme"+modified);
}
}
else
{
//--- set start position
limit=prev_calculated-1;
//--- now we set line color for every bar
for(int i=limit;i<rates_total;i++)
ColorBuffer[i]=getIndexOfColor(i);
}
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


639 Custom Indicators

PlotIndexSetString
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the string type.

bool  PlotIndexSetString(
int  plot_index,  // plotting style index
int  prop_id,  // property identifier
string  prop_value  // value to be set
);

Parameters
plot_index
[in] Index of graphical plot

prop_id
[in] The value can be one of the values of the ENUM_PLOT_PROPERTY_STRING enumeration.

prop_value
[in] The value of the property.

Return Value

If successful, returns true, otherwise false.

© 2000-2010, MetaQuotes Software Corp.


640 Custom Indicators

PlotIndexGetInteger
The function sets the value of the corresponding property of the corresponding indicator line. The
indicator property must be of the int, color, bool or char type. There are 2 variants of the function.

Call indicating identifier of the property.

int  PlotIndexGetInteger(
int  plot_index,  // plotting style index
int  prop_id,  // property identifier
);

Call indicating the identifier and modifier of the property.

int  PlotIndexGetInteger(
int  plot_index,  // plotting index
int  prop_id,  // property identifier
int  prop_modifier  // property modifier
)

Parameters
plot_index
[in] Index of the graphical plotting

prop_id
[in] The value can be one of the values of the ENUM_PLOT_PROPERTY_INTEGER enumeration.

prop_modifier
[in] Modifier of the specified property. Only level properties require a modifier.

Note

Function is designed to extract the settings of drawing of the appropriate indicator line. The
function works in tandem with the function PlotIndexSetInteger to copy the drawing properties of
one line to another.

Example: an indicator that colors candles depending on the day of the week. Colors for each day are
set in a program way.

© 2000-2010, MetaQuotes Software Corp.


641 Custom Indicators

#property indicator_separate_window
#property indicator_buffers 5
#property indicator_plots 1
//---- plot ColorCandles
#property indicator_label1 "ColorCandles"
#property indicator_type1 DRAW_COLOR_CANDLES
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- indicator buffers
double OpenBuffer[];
double HighBuffer[];
double LowBuffer[];
double CloseBuffer[];
double ColorCandlesColors[];
color ColorOfDay[6]={CLR_NONE,MediumSlateBlue,
DarkGoldenrod,ForestGreen,BlueViolet,Red};
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
void OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,OpenBuffer,INDICATOR_DATA);
SetIndexBuffer(1,HighBuffer,INDICATOR_DATA);
SetIndexBuffer(2,LowBuffer,INDICATOR_DATA);
SetIndexBuffer(3,CloseBuffer,INDICATOR_DATA);
SetIndexBuffer(4,ColorCandlesColors,INDICATOR_COLOR_INDEX);
//--- set number of colors in color buffer

© 2000-2010, MetaQuotes Software Corp.


642 Custom Indicators

PlotIndexSetInteger(0,PLOT_COLOR_INDEXES,6);
//--- set colors for color buffer
for(int i=1;i<6;i++)
PlotIndexSetInteger(0,PLOT_LINE_COLOR,i,ColorOfDay[i]);
//--- set accuracy
IndicatorSetInteger(INDICATOR_DIGITS,_Digits);
printf("We have %u colors of days",PlotIndexGetInteger(0,PLOT_COLOR_INDEXES));
//---
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//---
int i;
MqlDateTime t;
//----
if(prev_calculated==0) i=0;
else i=prev_calculated-1;
//----
while(i<rates_total)
{
OpenBuffer[i]=open[i];
HighBuffer[i]=high[i];
LowBuffer[i]=low[i];
CloseBuffer[i]=close[i];
//--- set color for every candle
TimeToStruct(time[i],t);
ColorCandlesColors[i]=t.day_of_week;
//---
i++;
}
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


643 Object Functions

Object Functions
This is the group of functions intended for working with graphic objects relating to any specified
chart.

Function Action

ObjectCreate Creates an object of the specified type in a


specified chart

ObjectName Returns the name of an object of the


corresponding type in the specified chart
(specified chart subwindow)

ObjectDelete Removes the object with the specified name


from the specified chart (from the specified
chart subwindow)

ObjectsDeleteAll Removes all objects of the specified type from


the specified chart (from the specified chart
subwindow)

ObjectFind Searches for an object with the specified ID by


the name

ObjectGetTimeByValue Returns the time value for the specified object


price value

ObjectGetValueByTime Returns the price value of an object for the


specified time

ObjectMove Changes the coordinates of the specified object


anchor point

ObjectsTotal Returns the number of objects of the specified


type in the specified chart (specified chart
subwindow)

ObjectGetDouble Returns the double value of the corresponding


object property

ObjectGetInteger Returns the integer value of the corresponding


object property

ObjectGetString Returns the string value of the corresponding


object property

ObjectSetDouble Sets the value of the corresponding object


property

ObjectSetInteger Sets the value of the corresponding object


property

ObjectSetString Sets the value of the corresponding object


property

© 2000-2010, MetaQuotes Software Corp.


644 Object Functions

Every graphical object should have a name unique within one chart, including its subwindows.
Changing of a name of a graphic object generates two events: event of deletion of an object with the
old name, and event of creation of an object with a new name.

After an object is created or an object property is modified it is recommended to call the


ChartRedraw() function, which commands the client terminal to forcibly draw a chart (and all visible
objects in it).

© 2000-2010, MetaQuotes Software Corp.


645 Object Functions

ObjectCreate
The function creates an object with the specified name, type, and the initial coordinates in the
specified chart subwindow. During creation up to 30 coordinates can be specified.

bool  ObjectCreate(
long  chart_id,  // chart identifier
string  name,  // object name
int  type,  // object type
int  nwin,  // window index
datetime  time1,  // time of the first anchor point
double  price1,  // price of the first anchor point
...
datetime  timeN=0,  // time of the N-th anchor point
double  priceN=0,  // price of the N-th anchor point
...
datetime  time30=0,  // time of the 30th anchor point
double  price30=0  // price of the 30th anchor point
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object. The name must be unique within a chart, including its subwindows.

type
[in] Object type. The value can be one of the values of the ENUM_OBJECT enumeration.

nwin
[in] Number of the chart subwindow. 0 means the main chart window. The specified subwindow
must exist, otherwise the function returns false.

time1
[in] The time coordinate of the first anchor.

price1
[in] The price coordinate of the first anchor point.

timeN=0
[in] The time coordinate of the N-th anchor point.

priceN=0
[in] The price coordinate of the N-th anchor point.

time30=0
[in] The time coordinate of the thirtieth anchor point.

price30=0
[in] The price coordinate of the thirtieth anchor point.

© 2000-2010, MetaQuotes Software Corp.


646 Object Functions

Return Value

Returns true or false depending on whether the object is created or not. To read more about the
error call GetLastError(). If the object has been created already, the function tries to change its
coordinates.

Note

The numbering of the chart subwindows (if there are subwindows with indicators in the chart) starts
with 1. The main chart window of the chart is and always has index 0.

A large number of anchor points (to 30) provides for future use.At the same time limit only 30
possible anchor points for the graphics due to the fact that when you call the number of parameters
must not exceed 64.

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


647 Object Functions

ObjectName
The function returns the name of the corresponding object in the specified chart, in the specified
subwindow, of the specified type.

string  ObjectName(
long  chart_id,  // chart identifier
int  pos,  // number in the list of objects
int  nwin=-1,  // window index
int  type=-1  // object type
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

pos
[in] Ordinal number of the object according to the specified filter by the number and type of the
subwindow.

nwin=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the
subwindows of the chart, including the main window.

type=-1
[in] Type of the object. The value can be one of the values of the ENUM_OBJECT enumeration. -1
means all types.

Return Value

Name of the object is returned in case of success.

Note

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


648 Object Functions

ObjectDelete
The function removes the object with the specified name from the specified chart.

bool  ObjectDelete(
long  chart_id, // chart identifier
string  name  // object name
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of object to be deleted.

Return Value

Returns true if the removal was successful, otherwise returns false. To read more about the error
call GetLastError().

Note

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


649 Object Functions

ObjectsDeleteAll
Removes all objects from the specified chart, specified chart subwindow, of the specified type.

int  ObjectsDeleteAll(
long  chart_id, // chart identifier
int  nwin=-1,  // window index
int  type=-1  // object type
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

nwin=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the subwindows
of the chart, including the main window.

type=-1
[in] Type of the object. The value can be one of the values of the ENUM_OBJECT enumeration. -1
means all types.

Return Value

Returns the number of deleted objects. To read more about the error call GetLastError().

© 2000-2010, MetaQuotes Software Corp.


650 Object Functions

ObjectFind
The function searches for an object with the specified name in the chart with the specified ID.

int  ObjectFind(
long  chart_id,  // chart identifier
string  name  // object name
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] The name of the searched object.

Return Value

If successful the function returns the number of the subwindow (0 means the main window of the
chart), in which the object is found. If the object is not found, the function returns a negative
number. To read more about the error call GetLastError().

Note

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


651 Object Functions

ObjectGetTimeByValue
The function returns the time value for the specified price value of the specified object.

datetime  ObjectGetTimeByValue(
long  chart_id,  // chart identifier
string  name,  // object name
double  value,  // Price
int  line_id   // Line
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

value
[in] Price value.

line_id
[in] Line identifier.

Return Value

The time value for the specified price value of the specified object.

Note

Since the object can have several values in one price coordinate (ellipse, triangle, channels, etc.),
in this case, the line ID must be specified.

© 2000-2010, MetaQuotes Software Corp.


652 Object Functions

ObjectGetValueByTime
The function returns the price value for the specified time value of the specified object.

double  ObjectGetValueByTime(
long  chart_id,  // chart identifier
string  name,  // object name
datetime  time,  // Time
int  line_id  // Line
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

time
[in] Time value.

line_id
[in] Line ID.

Return Value

The price value for the specified time value of the specified object.

Note

Since the object can have several values in one time coordinate (ellipse, triangle, channels, etc), in
this case, the line ID must be specified.

© 2000-2010, MetaQuotes Software Corp.


653 Object Functions

ObjectMove
The function changes coordinates of the specified anchor point of the object.

bool  ObjectMove(
long  chart_id,  // chart identifier
string  name,  // object name
int  point_index,  // anchor point number
datetime  time,  // Time
double  price  // Price
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

point_index
[in] Index of the anchor point. The number of anchor points depends on the type of object.

time

[in] Time coordinate of the selected anchor point.

price
[in] Price coordinate of the selected anchor point.

Return Value

If successful, returns true, in case of failure returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


654 Object Functions

ObjectsTotal
The function returns the number of objects in the specified chart, specified subwindow, of the
specified type.

int  ObjectsTotal(
long  chart_id,  // chart identifier
int  nwin=-1,  // window index
int  type=-1  // object type
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

nwin=-1
[in] Number of the chart subwindow. 0 means the main chart window, -1 means all the
subwindows of the chart, including the main window.

type=-1
[in] Type of the object. The value can be one of the values of the ENUM_OBJECT enumeration. -1
means all types.

Return Value

The number of objects.

© 2000-2010, MetaQuotes Software Corp.


655 Object Functions

ObjectSetDouble
The function sets the value of the corresponding object property. The object property must be of the
double type. There are 2 variants of the function.

Setting property value, without modifier

bool  ObjectSetDouble(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
double  prop_value   // value
);

Setting a property value indicating the modifier

bool  ObjectSetDouble(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
int  prop_modifier,  // modifier
double  prop_value   // value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_DOUBLE enumeration.

prop_modifier
[in] Modifier of the specified property. Most properties do not require a modifier.

prop_value
[in] The value of the property.

Return Value

Returns true if the value is successfully set to the property, otherwise returns false. To read more
about the error call GetLastError().

Example of creating a Fibonacci object and adding a new level in it

//| Script program start function |


//+------------------------------------------------------------------+
void OnStart()
{

© 2000-2010, MetaQuotes Software Corp.


656 Object Functions

//--- auxiliary arrays


double high[],low[],price1,price2;
datetime time[],time1,time2;
//--- Copy the open prices - 100 latest bars are enough
int copied=CopyHigh(Symbol(),0,0,100,high);
if(copied<=0)
{
Print("Failed to copy the values of the High price series");
return;
}
//--- Copy the close price - 100 latest bars are enough
copied=CopyLow(Symbol(),0,0,100,low);
if(copied<=0)
{
Print("Failed to copy the values of the Low price series");
return;
}
//--- Copy the open time for the last 100 bars
copied=CopyTime(Symbol(),0,0,100,time);
if(copied<=0)
{
Print("Failed to copy the values of the price series of Time");
return;
}
//--- Organize access to the copied data as to timeseries - backwards
ArraySetAsSeries(high,true);
ArraySetAsSeries(low,true);
ArraySetAsSeries(time,true);

//--- Coordinates of the first anchor point of the Fibo object


price1=high[70];
time1=time[70];
//--- Coordinates of the second anchor point of the Fibo object
price2=low[50];
time2=time[50];

//--- Time to create the Fibo object


bool created=ObjectCreate(0,"Fibo",OBJ_FIBO,0,time1,price1,time2,price2);
if(created) // If the object is created successfully
{
//--- set the color of Fibo levels
ObjectSetInteger(0,"Fibo",OBJPROP_LEVELCOLOR,Blue);
//--- by the way, how much Fibo levels do we have?
int levels=ObjectGetInteger(0,"Fibo",OBJPROP_LEVELS);
Print("Fibo levels before =",levels);
//---output to the Journal => number of level:value level_desription
for(int i=0;i<levels;i++)
{

© 2000-2010, MetaQuotes Software Corp.


657 Object Functions

Print(i,":",ObjectGetDouble(0,"Fibo",OBJPROP_LEVELVALUE,i),
" ",ObjectGetString(0,"Fibo",OBJPROP_LEVELTEXT,i));
}
//--- Try to increase the number of levels per unit
bool modified=ObjectSetInteger(0,"Fibo",OBJPROP_LEVELS,levels+1);
if(!modified) // failed to change the number of levels
{
Print("Failed to change the number of levels of Fibo, error",GetLastError());
}
//--- just inform
Print("Fibo levels after =",ObjectGetInteger(0,"Fibo",OBJPROP_LEVELS));
//--- set a value for a newly created level
bool added=ObjectSetDouble(0,"Fibo",OBJPROP_LEVELVALUE,levels,133);
if(added) // managed to set a value for the level
{
Print("Successfully set one more Fibo level");
//--- Also do not forget to set the level description
ObjectSetString(0,"Fibo",OBJPROP_LEVELTEXT,levels,"my level");
ChartRedraw(0);
//--- Get the actual value of the number of levels in the Fibo object
levels=ObjectGetInteger(0,"Fibo",OBJPROP_LEVELS);
Print("Fibo levels after adding =",levels);
//--- once again output all levels - just to make sure
for(int i=0;i<levels;i++)
{
Print(i,":",ObjectGetDouble(0,"Fibo",OBJPROP_LEVELVALUE,i),
" ",ObjectGetString(0,"Fibo",OBJPROP_LEVELTEXT,i));
}
}
else // Fails if you try to increase the number of levels in the Fibo object
{
Print("Failed to set one more Fibo level. Error",GetLastError());
}
}
}

See also
Object Types, Object Properties

© 2000-2010, MetaQuotes Software Corp.


658 Object Functions

ObjectSetInteger
The function sets the value of the corresponding object property. The object property must be of the
datetime, int, color, bool or char type. There are 2 variants of the function.

Setting property value, without modifier

bool  ObjectSetInteger(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
long  prop_value   // value
);

Setting a property value indicating the modifier

bool  ObjectSetInteger(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
int  prop_modifier,  // modifier
long  prop_value   // value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_INTEGER enumeration.

prop_modifier
[in] Modifier of the specified property. Most properties do not require a modifier.

prop_value
[in] The value of the property.

Return Value

Returns true if the value is successfully set to the property, otherwise returns false. To read more
about the error call GetLastError().

See also
Object Types, Object Properties

© 2000-2010, MetaQuotes Software Corp.


659 Object Functions

ObjectSetString
The function sets the value of the corresponding object property. The object property must be of the
string type. There are 2 variants of the function.

Setting property value, without modifier

bool  ObjectSetString(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
string  prop_value   // value
);

Setting a property value indicating the modifier

bool  ObjectSetString(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property
int  prop_modifier,  // modifier
string  prop_value   // value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_STRING enumeration.

prop_modifier
[in] Modifier of the specified property. Most properties do not require a modifier.

prop_value
[in] The value of the property.

Return Value

Returns true if the value is successfully set to the property, otherwise returns false. To read more
about the error call GetLastError().

Note

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


660 Object Functions

ObjectGetDouble
The function returns the value of the corresponding object property. The object property must be of
the double type. There are 2 variants of the function.

1. Immediately returns the property value.

double  ObjectGetDouble(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier=0  // property modifier, if required
);

2. Returns true or false, depending on the success of the function. If successful, the property
value is placed to a receiving variable passed by by reference by the last parameter.

bool  ObjectGetDouble(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier, // property modifier
double& double_var  // here we accept the property value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_DOUBLE enumeration.

prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier.

double_var
[out] Variable of the double type that received the value of the requested property.

Return Value

Value of the double type for the first calling variant.

For the second variant the function returns true, if this property is maintained and the value has
been placed into the double_var variable, otherwise returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


661 Object Functions

ObjectGetInteger
The function returns the value of the corresponding object property. The object property must be of
the datetime, int, color, bool or char type. There are 2 variants of the function.

1. Immediately returns the property value.

long  ObjectGetInteger(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier=0 // property modifier, if required
);

2. Returns true or false, depending on the success of the function. If successful, the property
value is placed to a receiving variable passed by by reference by the last parameter.

bool  ObjectGetInteger(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier, // property modifier
long&  long_var  // here we accept the property value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_INTEGER enumeration.

prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier.

long_var
[out] Variable of the long type that receives the value of the requested property.

Return Value

The long value for the first calling variant.

For the second variant the function returns true, if this property is maintained and the value has
been placed into the long_var variable, otherwise returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


662 Object Functions

ObjectGetString
The function returns the value of the corresponding object property. The object property must be of
the string type. There are 2 variants of the function.

1. Immediately returns the property value.

string  ObjectGetString(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier=0 // property modifier, if required
);

2. Returns true or false, depending on the success of the function. If successful, the property
value is placed to a receiving variable passed by by reference by the last parameter.

bool  ObjectGetString(
long  chart_id,  // chart identifier
string  name,  // object name
int  prop_id,  // property identifier
int  prop_modifier, // property modifier
string& string_var  // here we accept the property value
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

name
[in] Name of the object.

prop_id
[in] ID of the object property. The value can be one of the values of the
ENUM_OBJECT_PROPERTY_STRING enumeration.

prop_modifier
[in] Modifier of the specified property. For the first variant, the default modifier value is equal to
0. Most properties do not require a modifier.

string_var
[out] Variable of the string type that receives the value of the requested properties.

Return Value

String value for the first version of the call.

For the second version of the call returns true, if this property is maintained and the value has been
placed into the string_var variable, otherwise returns false. To read more about the error call
GetLastError().

Note

© 2000-2010, MetaQuotes Software Corp.


663 Object Functions

When an object is renamed, two events are formed simultaneously. These events can be handled in
an Expert Advisor or indicator by the OnChatEvent() function:
an event of deletion of an object with the old name;
an event of creation of an object with a new name.

© 2000-2010, MetaQuotes Software Corp.


664 Technical Indicators

Technical Indicator Functions


All functions like iMA, iAC, iMACD, iIchimoku etc. created a copy of the corresponding technical
indicator in the global cache of the client terminal. If a copy of the indicator with such parameters
already exists, the new copy is not created, and the counter of references to the existing copy
increases.

These functions return the handle of the appropriate copy of the indicator. Further, using this
handle, you can receive data calculated by the corresponding indicator. The corresponding buffer data
(technical indicators contain calculated data in their internal buffers, which can vary from 1 to 5,
depending on the indicator) can be copied to a mql5-program using the CopyBuffer() function.

There is a universal method for creating any technical indicator using the IndicatorCreate()
function. This function accepts the following data as input parameters:

symbol name;
timeframe;
type of the indicator to create;
number of input parameters of the indicator;
an array of MqlParam type containing all the necessary input parameters.

The computer memory can be freed from an indicator that is no more utilized, using the
IndicatorRelease() function, to which the indicator handle is passed.

Custom Indicators can contain up to 512 indicator buffers, and the buffer data also can be obtained
by using the CopyBuffer() function, with the handle returned by function iCustom().

Note. Repeated call of the indicator function with the same parameters within one mql5-program
does not lead to a multiple increase of the reference counter; the counter will be increased only once
by 1. However, it's recommended to get the indicators handles in function OnInit() or in the class
constructor (better in OnInit(), since there is no function to free handles), and further use these
handles in other functions. The reference counter decreases when a mql5-program is deinitialized.

All indicator functions have at least 2 parameters - symbol and period. The NULL value of the
symbol means the current symbol, the 0 value of the period means the current timeframe.

Function Returns the handle of the indicator:

iAC Accelerator Oscillator

iAD Accumulation/Distribution

iADX Average Directional Index

iADXWilder Average Directional Index by Welles Wilder

iAlligator Alligator

iAMA Adaptive Moving Average

iAO Awesome Oscillator

iATR Average True Range

© 2000-2010, MetaQuotes Software Corp.


665 Technical Indicators

iBearsPower Bears Power

iBands Bollinger Bands

iBullsPower Bulls Power

iCCI Commodity Channel Index

iChaikin Chaikin Oscillator

iCustom Custom indicator

iDEMA Double Exponential Moving Average

iDeMarker DeMarker

iEnvelopes Envelopes

iForce Force Index

iFractals Fractals

iFRAMA Fractal Adaptive Moving Average

iGator Gator Oscillator

iIchimoku Ichimoku Kinko Hyo

iBWMFI Market Facilitation Index by Bill Williams

iMomentum Momentum

iMFI Money Flow Index

iMA Moving Average

iOsMA Moving Average of Oscillator (MACD histogram)

iMACD Moving Averages Convergence-Divergence

iOBV On Balance Volume

iSAR Parabolic Stop And Reverse System

iRSI Relative Strength Index

iRVI Relative Vigor Index

iStdDev Standard Deviation

iStochastic Stochastic Oscillator

iTEMA Triple Exponential Moving Average

iTriX Triple Exponential Moving Averages Oscillator

iWPR Williams' Percent Range

iVIDyA Variable Index DYnamic Average

iVolumes Volumes

© 2000-2010, MetaQuotes Software Corp.


666 Technical Indicators

iAC
The function creates Accelerator Oscillator in a global cache of the client terminal and returns its
handle. It has only one buffer.

int  iAC(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period  // period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES enumeration values, 0 means
the current timeframe.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


667 Technical Indicators

iAD
The function returns the handle of the Accumulation/Distribution indicator. It has only one buffer.

int  iAD(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
ENUM_APPLIED_VOLUME  applied_volume  // volume type for calculation
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES enumeration values, 0 means
the current timeframe.

applied_volume
[in] The volume used. Can be any of ENUM_APPLIED_VOLUME values.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


668 Technical Indicators

iADX
The function returns the handle of the Average Directional Movement Index indicator.

int  iADX(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  adx_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

adx_period
[in] Period to calculate the index.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - MAIN_LINE, 1 - PLUSDI_LINE, 2 - MINUSDI_LINE.

© 2000-2010, MetaQuotes Software Corp.


669 Technical Indicators

iADXWilder
The function returns the handle of Average Directional Movement Index by Welles Wilder.

int  iADXWilder(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  adx_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

adx_period
[in] Period to calculate the index.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - MAIN_LINE, 1 - PLUSDI_LINE, 2 - MINUSDI_LINE.

© 2000-2010, MetaQuotes Software Corp.


670 Technical Indicators

iAlligator
The function returns the handle of the Alligator indicator.

int  iAlligator(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  jaw_period,  // period for the calculation of jaws
int  jaw_shift,  // horizontal shift of jaws
int  teeth_period,  // period for the calculation of teeth
int  teeth_shift,  // horizontal shift of teeth
int  lips_period,  // period for the calculation of lips
int  lips_shift,  // horizontal shift of lips
ENUM_MA_METHOD  ma_method,  // type of smoothing
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

jaw_period
[in] Averaging period for the blue line (Alligator's Jaw)

jaw_shift
[in] The shift of the blue line relative to the price chart. It should be remembered that the line
shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining
buffer values using the CopyBuffer() function,the shift value will have no effect.

teeth_period
[in] Averaging period for the red line (Alligator's Teeth).

teeth_shift
[in] The shift of the red line relative to the price chart. It should be remembered that the line
shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining
buffer values using the CopyBuffer() function,the shift value will have no effect.

lips_period
[in] Averaging period for the green line (Alligator's lips).

lips_shift
[in] The shift of the green line relative to the price chart. It should be remembered that the line
shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining
buffer values using the CopyBuffer() function,the shift value will have no effect.

ma_method

© 2000-2010, MetaQuotes Software Corp.


671 Technical Indicators

[in] The method of averaging. Can be any of the ENUM_MA_METHOD values.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - GATORJAW_LINE, 1 - GATORTEETH_LINE, 2 -


GATORLIPS_LINE.

© 2000-2010, MetaQuotes Software Corp.


672 Technical Indicators

iAMA
The function returns the handle of the Adaptive Moving Average indicator. It has only one buffer.

int  iAMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ama_period,  // average period for AMA
int  fast_ma_period,  // fast MA period
int  slow_ma_period,  // slow MA period
int  ama_shift,  // horizontal shift of the indicator
ENUM_APPLIED_PRICE  applied_price  // type of the price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ama_period
[in] The calculation period, on which the efficiency coefficient is calculated.

fast_ma_period
[in] Fast period for the smoothing coefficient calculation for a rapid market.

slow_ma_period
[in] Slow period for the smoothing coefficient calculation in the absence of trend.

ama_shift
[in] Shift of the indicator relative to the price chart.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


673 Technical Indicators

iAO
The function returns the handle of the Awesome oscillator indicator. It has only one buffer.

int  iAO(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period  // period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


674 Technical Indicators

iATR
The function returns the handle of the Average True Range indicator. It has only one buffer.

int  iATR(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] The value of the averaging period for the indicator calculation.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


675 Technical Indicators

iBearsPower
The function returns the handle of the Bears Power indicator. It has only one buffer.

int  iBearsPower(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] The value of the averaging period for the indicator calculation.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


676 Technical Indicators

iBands
The function returns the handle of the Bollinger Bands indicator.

int  iBands(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  bands_period, // period for average line calculation
int  bands_shift,  // horizontal shift of the indicator
double  deviation,  // number of standard deviations
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

bands_period
[in] The averaging period of the main line of the indicator.

bands_shift
[in] The shift the indicator relative to the price chart. It should be remembered that the line shift
is only visual, and values in the indicator buffer are stored without the shift. When obtaining
buffer values using the CopyBuffer() function,the shift value will have no effect.

deviation
[in] Deviation from the main line.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - BASE_LINE, 1 - UPPER_BAND, 2 - LOWER_BAND

© 2000-2010, MetaQuotes Software Corp.


677 Technical Indicators

iBullsPower
The function returns the handle of the Bulls Power indicator. It has only one buffer.

int  iBullsPower(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period, // period
int  ma_period,  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] The averaging period for the indicator calculation.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


678 Technical Indicators

iCCI
The function returns the handle of the Commodity Channel Index indicator. It has only one buffer.

int  iCCI(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] The averaging period for the indicator calculation.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


679 Technical Indicators

iChaikin
The function returns the handle of the Chaikin Oscillator indicator. It has only one buffer.

int  iChaikin(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  fast_ma_period,  // fast period
int  slow_ma_period,  // slow period
ENUM_MA_METHOD  ma_method,  // smoothing type
ENUM_APPLIED_VOLUME  applied_price  // type of volume
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

fast_ma_period
[in] Fast averaging period for calculations.

slow_ma_period
[in] Slow averaging period for calculations.

ma_method
[in] Smoothing type. Can be one of the averaging constants of ENUM_MA_METHOD.

applied_volume
[in] The volume used. Can be one of the constants of ENUM_APPLIED_VOLUME.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


680 Technical Indicators

iCustom
The function returns the handle of a specified custom indicator.

int  iCustom(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
string  name  // folder/custom indicator_name
...  // list of indicator input parameters
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

name
[in] The name of the custom indicator, with path relative to the root directory of indicators
(MQL5/Indicators/). If an indicator is located in a subdirectory, for example, in MQL5/Indicators/
Examples, its name must be specified like: "Examples\\indicator_name" (it is necessary to use a
double slash instead of the single slash as a separator).

...
[in] input-parameters of a custom indicator, separated by commas. Type and order of parameters
must match. If there is no parameters specified, then default values will be used.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

A custom indicator must be compiled (with extension EX5) and located in the directory MQL5/
Indicators of the client terminal or its subdirectory.

If the first call form is used in the indicator, then at the custom indicator start you can additionally
indicate data for calculation in its "Parameters" tab. If the "Apply to" parameter is not selected
explicitly, the default calculation is based on the values of "Close" prices.

© 2000-2010, MetaQuotes Software Corp.


681 Technical Indicators

When you call a custom indicator from mql5-program, the Applied_Price parameter or a handle of
another indicator should be passed last, after all input variables of the custom indicator.

Example:

#property indicator_separate_window
#property indicator_buffers 1
#property indicator_plots 1
//---- plot Label1
#property indicator_label1 "Label1"
#property indicator_type1 DRAW_LINE
#property indicator_color1 Red
#property indicator_style1 STYLE_SOLID
#property indicator_width1 1
//--- input parameters
input int MA_Period=21;
input int MA_Shift=0;
input ENUM_MA_METHOD MA_Method=MODE_SMA;
//--- indicator buffers
double Label1Buffer[];
//--- Handle of the Custom Moving Average.mq5 custom indicator
int MA_handle;
//+------------------------------------------------------------------+
//| Custom indicator initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- indicator buffers mapping
SetIndexBuffer(0,Label1Buffer,INDICATOR_DATA);
ResetLastError();
MA_handle=iCustom(NULL,0,"Custom Moving Average",
MA_Period,
MA_Shift,
MA_Method,

© 2000-2010, MetaQuotes Software Corp.


682 Technical Indicators

PRICE_CLOSE // using the close prices


);
Print("MA_handle =",MA_handle," error =",GetLastError());
//---
return(0);
}
//+------------------------------------------------------------------+
//| Custom indicator iteration function |
//+------------------------------------------------------------------+
int OnCalculate(const int rates_total,
const int prev_calculated,
const datetime &time[],
const double &open[],
const double &high[],
const double &low[],
const double &close[],
const long &tick_volume[],
const long &volume[],
const int &spread[])
{
//--- Copy the values of the indicator Custom Moving Average to our indicator buffer
int copy=CopyBuffer(MA_handle,0,0,rates_total,Label1Buffer);
Print("copy =",copy," rates_total =",rates_total);
//--- If our attempt has failed - Report this
if(copy<=0)
Print("An attempt to get the values if Custom Moving Average has failed");
//--- return value of prev_calculated for next call
return(rates_total);
}
//+------------------------------------------------------------------+

© 2000-2010, MetaQuotes Software Corp.


683 Technical Indicators

iDEMA
The function returns the handle of the Double Exponential Moving Average indicator. It has only one
buffer.

int  iDEMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
int  ma_shift,  // horizontal shift
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period (bars count) for calculations.

ma_shift
[in] Shift of the indicator relative to the price chart.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


684 Technical Indicators

iDeMarker
The function returns the handle of the DeMarker indicator. It has only one buffer.

int  iDeMarker(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period (bars count) for calculations.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


685 Technical Indicators

iEnvelopes
The function returns the handle of the Envelopes indicator.

int  iEnvelopes(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // period for the average line calculation
int  ma_shift,  // horizontal shift of the indicator
ENUM_MA_METHOD  ma_method,  // type of smoothing
ENUM_APPLIED_PRICE  applied_price,  // type of price or handle
double  deviation  // deviation of boundaries from the midline (in percents)
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the main line.

ma_shift
[in] The shift of the indicator relative to the price chart. It should be remembered that the line
shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining
buffer values using the CopyBuffer() function,the shift value will have no effect.

ma_method
[in] Smoothing type. Can be one of the values of ENUM_MA_METHOD.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

deviation
[in] The deviation from the main line (in percents).

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers: 0 - UPPER_LINE, 1 - LOWER_LINE.

© 2000-2010, MetaQuotes Software Corp.


686 Technical Indicators

iForce
The function returns the handle of the Force Index indicator. It has only one buffer.

int  iForce(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
ENUM_MA_METHOD  ma_method,  // smoothing type
ENUM_APPLIED_VOLUME applied_volume // volume type for calculation
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the indicator calculations.

ma_method
[in] Smoothing type. Can be one of the values of ENUM_MA_METHOD.

applied_volume
[in] The volume used. Can be one of the values of ENUM_APPLIED_VOLUME.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


687 Technical Indicators

iFractals
The function returns the handle of the Fractals indicator.

int  iFractals(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period  // period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - UPPER_LINE, 1 - LOWER_LINE.

© 2000-2010, MetaQuotes Software Corp.


688 Technical Indicators

iFrAMA
The function returns the handle of the Fractal Adaptive Moving Average indicator. It has only one
buffer.

int  iFrAMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
int  ma_shift,  // horizontal shift on the chart
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Period (bars count) for the indicator calculations.

ma_shift
[in] Shift of the indicator in the price chart.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


689 Technical Indicators

iGator
The function returns the handle of the Gator indicator. The Oscillator shows the difference between
the blue and red lines of Alligator (upper histogram) and difference between red and green lines (lower
histogram).

int  iGator(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  jaw_period,  // period for the calculation of the jaws
int  jaw_shift,  // jaws horizontal shift
int  teeth_period,  // period for the calculation of the teeth
int  teeth_shift,  // teeth horizontal shift
int  lips_period,  // period for the calculation of the lips
int  lips_shift,  // lips horizontal shift
ENUM_MA_METHOD  ma_method,  // type of smoothing
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

jaw_period
[in] Averaging period for the blue line (Alligator's Jaw).

jaw_shift
[in] The shift of the blue line relative to the price chart. It isn't directly connected with the visual
shift of the indicator histogram.

teeth_period
[in] Averaging period for the red line (Alligator's Teeth).

teeth_shift
[in] The shift of the red line relative to the price chart. It isn't directly connected with the visual
shift of the indicator histogram.

lips_period
[in] Averaging period for the green line (Alligator's lips).

lips_shift
[in] The shift of the green line relative to the price charts. It isn't directly connected with the
visual shift of the indicator histogram.

ma_method
[in] Smoothing type. Can be one of the values of ENUM_MA_METHOD.

© 2000-2010, MetaQuotes Software Corp.


690 Technical Indicators

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

Buffer numbers: 0 - UPPER_HISTOGRAM, 1 - color buffer of the upper histogram, 2 -


LOWER_HISTOGRAM, 3 - color buffer of the lower histogram.

© 2000-2010, MetaQuotes Software Corp.


691 Technical Indicators

iIchimoku
The function returns the handle of the Ichimoku Kinko Hyo indicator.

int  iIchimoku(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  tenkan_sen,  // period of Tenkan-sen
int  kijun_sen,  // period of Kijun-sen
int  senkou_span_b  // period of Senkou Span B
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

tenkan_sen
[in] Averaging period for Tenkan Sen.

kijun_sen
[in] Averaging period for Kijun Sen.

senkou_span_b
[in] Averaging period for Senkou Span B.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers: 0 - TENKANSEN_LINE, 1 - KIJUNSEN_LINE, 2 - SENKOUSPANA_LINE, 3 -


SENKOUSPANB_LINE, 4 - CHINKOUSPAN_LINE.

© 2000-2010, MetaQuotes Software Corp.


692 Technical Indicators

iBWMFI
The function returns the handle of the Market Facilitation Index indicator. It has only one buffer.

int  iBWMFI(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
ENUM_APPLIED_VOLUME  applied_volume  // volume type for calculation
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

applied_volume
[in] The volume used. Can be one of the constants of ENUM_APPLIED_VOLUME.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


693 Technical Indicators

iMomentum
The function returns the handle of the Momentum indicator. It has only one buffer.

int  iMomentum(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  mom_period, // averaging period
ENUM_APPLIED_PRICE   applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

mom_period
[in] Averaging period (bars count) for the calculation of the price change.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


694 Technical Indicators

iMFI
The function returns the handle of the Money Flow Index indicator.

int  iMFI(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
ENUM_APPLIED_VOLUME  applied_volume  // volume type for calculation
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period (bars count) for the calculation.

applied_volume
[in] The volume used. Can be any of the ENUM_APPLIED_VOLUME values.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


695 Technical Indicators

iMA
The function returns the handle of the Moving Average indicator. It has only one buffer.

int  iMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
int  ma_shift,  // horizontal shift
ENUM_MA_METHOD  ma_method,  // smoothing type
ENUM_APPLIED_PRICE   applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the calculation of the moving average.

ma_shift
[in] Shift of the indicator relative to the price chart.

ma_method
[in] Smoothing type. Can be one of the ENUM_MA_METHOD values.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


696 Technical Indicators

iOsMA
The function returns the handle of the Moving Average of Oscillator indicator. The OsMA oscillator
shows the difference between values of MACD and its signal line. It has only one buffer.

int  iOsMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  fast_ema_period,  // period for Fast Moving Average
int  slow_ema_period,  // period for Slow Moving Average
int  signal_period,  // averaging period for their difference
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

fast_ema_period
[in] Period for Fast Moving Average calculation.

slow_ema_period
[in] Period for Slow Moving Average calculation.

signal_period
[in] Averaging period for signal line calculation.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

In some systems this oscillator is also known as MACD histogram.

© 2000-2010, MetaQuotes Software Corp.


697 Technical Indicators

iMACD
The function returns the handle of the Moving Averages Convergence/Divergence indicator. In
systems where ОsМА is called MACD Histogram, this indicator is shown as two lines. In the client
terminal the Moving Averages Convergence/Divergence looks like a histogram.

int  iMACD(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  fast_ema_period,  // period for Fast average calculation
int  slow_ema_period,  // period for Slow average calculation
int  signal_period,  // period for their difference averaging
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

fast_ema_period
[in] Period for Fast Moving Average calculation.

slow_ema_period
[in] Period for Slow Moving Average calculation.

signal_period
[in] Period for Signal line calculation.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - MAIN_LINE, 1 - SIGNAL_LINE.

© 2000-2010, MetaQuotes Software Corp.


698 Technical Indicators

iOBV
The function returns the handle of the On Balance Volume indicator. It has only one buffer.

int  iOBV(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
ENUM_APPLIED_VOLUME   applied_volume  // volume type for calculation
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

applied_volume
[in] The volume used. Can be any of the ENUM_APPLIED_VOLUME values.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


699 Technical Indicators

iSAR
The function returns the handle of the Parabolic Stop and Reverse system indicator. It has only one
buffer.

int  iSAR(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
double  step,  // step increment
double  maximum  // maximal stop level
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

step
[in] The stop level increment, usually 0.02.

maximum
[in] The maximal stop level, usually 0.2.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


700 Technical Indicators

iRSI
The function returns the handle of the Relative Strength Index indicator. It has only one buffer.

int  iRSI(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the RSI calculation.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


701 Technical Indicators

iRVI
The function returns the handle of the Relative Vigor Index indicator.

int  iRVI(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the RVI calculation.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers are the following: 0 - MAIN_LINE, 1 - SIGNAL_LINE.

© 2000-2010, MetaQuotes Software Corp.


702 Technical Indicators

iStdDev
The function returns the handle of the Standard Deviation indicator. It has only one buffer.

int  iStdDev(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
int  ma_shift,  // horizontal shift
ENUM_MA_METHOD  ma_method,  // smoothing type
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period for the indicator calculations.

ma_shift
[in] Shift of the indicator relative to the price chart.

ma_method
[in] Type of averaging. Can be any of the ENUM_MA_METHOD values.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


703 Technical Indicators

iStochastic
The function returns the handle of the Stochastic Oscillator indicator.

int  iStochastic(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  Kperiod,  // K-period (number of bars for calculations)
int  Dperiod,  // D-period (period of first smoothing)
int  slowing,  // final smoothing
ENUM_MA_METHOD  ma_method,  // type of smoothing
ENUM_STO_PRICE  price_field  // stochastic calculation method
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

Kperiod
[in] Averaging period (bars count) for the %K line calculation.

Dperiod
[in] Averaging period (bars count) for the %D line calculation.

slowing
[in] Slowing value.

ma_method
[in] Type of averaging. Can be any of the ENUM_MA_METHOD values.

price_field
[in] Parameter of price selection for calculations. Can be one of the ENUM_STO_PRICE values.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

Note

The buffer numbers: 0 - MAIN_LINE, 1 - SIGNAL_LINE.

© 2000-2010, MetaQuotes Software Corp.


704 Technical Indicators

iTEMA
The function returns the handle of the Triple Exponential Moving Average indicator. It has only one
buffer.

int  iTEMA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
int  ma_shift,  // horizontal shift of indicator
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period (bars count) for calculation.

ma_shift
[in] Shift of indicator relative to the price chart.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


705 Technical Indicators

iTriX
The function returns the handle of the Triple Exponential Moving Averages Oscillator indicator. It has
only one buffer.

int  iTriX(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  ma_period,  // averaging period
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

ma_period
[in] Averaging period (bars count) for calculations.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


706 Technical Indicators

iWPR
The function returns the handle of the Larry Williams' Percent Range indicator. It has only one buffer.

int  iWPR(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  calc_period  // averaging period
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

calc_period
[in] Period (bars count) for the indicator calculation.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


707 Technical Indicators

iVIDyA
The function returns the handle of the Variable Index Dynamic Average indicator. It has only one
buffer.

int  iVIDyA(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
int  cmo_period,  // period for Chande Momentum
int  ema_period,  // EMA smoothing period
int  ma_shift,  // horizontal shift on the price chart
ENUM_APPLIED_PRICE  applied_price  // type of price or handle
);

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

cmo_period
[in] Period (bars count) for the Chande Momentum Oscillator calculation.

ema_period
[in] EMA period (bars count) for smoothing factor calculation.

ma_shift
[in] Shift of the indicator relative to the price chart.

applied_price
[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of
another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


708 Technical Indicators

iVolumes
The function returns the handle of the Volumes indicator. It has an only one buffer.

int  iVolumes(
string  symbol,  // symbol name
ENUM_TIMEFRAMES  period,  // period
ENUM_APPLIED_VOLUME  applied_volume  // volume type for calculation
)

Parameters
symbol
[in] The symbol name of the security, the data of which should be used to calculate the indicator.
The NULL value means the current symbol.

period
[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current
timeframe.

applied_volume
[in] The volume used. Can be any of the ENUM_APPLIED_VOLUME values.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


709 Working with events

Event Functions
This group contains functions for working with custom events and timer events. Besides this group,
there are special functions for handling predefined events.

Function Action

EventSetTimer Starts the timer event generator with the


specified periodicity for the current chart

EventKillTimer Stops the generation of events by the timer in


the current chart

EventChartCustom Generates a custom event for the specified


chart

See also
Types of Chart Events

© 2000-2010, MetaQuotes Software Corp.


710 Working with events

EventSetTimer
The function indicates to the client terminal, that events from the timer must be generated with the
specified periodicity for the chart, to which the Expert Advisor is attached.

void  EventSetTimer(
int  seconds  // number of seconds
);

Parameters
seconds
[in] Number of seconds that determine the frequency of the timer event occurrence.

Return Value

No return value.

Note

Normally, this function must be called from the OnInit() function or from a class constructor. In
order to handle events coming from the timer, the Expert Advisor must have the OnTimer()
function.

Every Expert Advisor, as well as every indicator works with its own timer and receives events only
from it. As soon as a mql5 program stops operating, the timer is destroyed forcibly if it was created
but hasn't been disabled by the EventKillTimer() function.

For each program no more than one timer can be run.

© 2000-2010, MetaQuotes Software Corp.


711 Working with events

EventKillTimer
Specifies the client terminal that is necessary to stop the generation of events from Timer.

void  EventKillTimer();

Return Value

No return value.

Note

Typically, this function must be called from a function OnDeinit(), if the EventSetTimer() function
has been called from OnInit(). This function can also be called form the class destructor, if the
EventSetTimer() function has been called in the constructor of this class.

Every Expert Advisor, as well as every indicator works with its own timer and receives events only
from it. As soon as a mql5 program stops operating, the timer is destroyed forcibly if it was created
but hasn't been disabled by the EventKillTimer() function

© 2000-2010, MetaQuotes Software Corp.


712 Working with events

EventChartCustom
The function generates a custom event for the specified chart.

void  EventChartCustom(
long  chart_id,  // identifier of the event receiving chart
ushort  custom_event_id,  // event identifier
long  lparam,  // parameter of type long
double  dparam,  // parameter of type double
string  sparam  // string parameter of the event
);

Parameters
chart_id
[in] Chart identifier. 0 means the current chart.

custom_event_id
[in] ID of the user events. This identifier is automatically added to the value
CHARTEVENT_CUSTOM and converted to the integer type.

lparam
[in] Event parameter of the long type passed to the OnChartEvent function.

dparam
[in] Event parameter of the double type passed to the OnChartEvent function.

sparam
[in] Event parameter of the string type passed to the OnChartEvent function. If the string is
longer than 63 characters, it is truncated.

Return Value

No return value.

Note

An Expert Advisor or indicator attached to the specified chart handles the event using the function
OnChartEvent(int event_id, long& lparam, double& dparam, string& sparam);

Example:

//+------------------------------------------------------------------+
//| ButtonClickExpert.mq5 |
//| Copyright 2009, MetaQuotes Software Corp. |
//| http://www.mql5.com |
//+------------------------------------------------------------------+
#property copyright "2009, MetaQuotes Software Corp."
#property link "http://www.mql5.com"
#property version "1.00"

string buttonID="Button";
string labelID="Info";

© 2000-2010, MetaQuotes Software Corp.


713 Working with events

int broadcastEventID=5000;
//+------------------------------------------------------------------+
//| Expert initialization function |
//+------------------------------------------------------------------+
int OnInit()
{
//--- Create a button to send custom events
ObjectCreate(0,buttonID,OBJ_BUTTON,0,100,100);
ObjectSetInteger(0,buttonID,OBJPROP_COLOR,White);
ObjectSetInteger(0,buttonID,OBJPROP_BGCOLOR,Gray);
ObjectSetInteger(0,buttonID,OBJPROP_XDISTANCE,100);
ObjectSetInteger(0,buttonID,OBJPROP_YDISTANCE,100);
ObjectSetInteger(0,buttonID,OBJPROP_XSIZE,200);
ObjectSetInteger(0,buttonID,OBJPROP_YSIZE,50);
ObjectSetString(0,buttonID,OBJPROP_FONT,"Arial");
ObjectSetString(0,buttonID,OBJPROP_TEXT,"Button");
ObjectSetInteger(0,buttonID,OBJPROP_FONTSIZE,10);
ObjectSetInteger(0,buttonID,OBJPROP_SELECTABLE,0);

//--- Create a label for displaying information


ObjectCreate(0,labelID,OBJ_LABEL,0,100,100);
ObjectSetInteger(0,labelID,OBJPROP_COLOR,Red);
ObjectSetInteger(0,labelID,OBJPROP_XDISTANCE,100);
ObjectSetInteger(0,labelID,OBJPROP_YDISTANCE,50);
ObjectSetString(0,labelID,OBJPROP_FONT,"Trebuchet MS");
ObjectSetString(0,labelID,OBJPROP_TEXT,"No information");
ObjectSetInteger(0,labelID,OBJPROP_FONTSIZE,20);
ObjectSetInteger(0,labelID,OBJPROP_SELECTABLE,0);

//---
return(0);
}
//+------------------------------------------------------------------+
//| Expert deinitialization function |
//+------------------------------------------------------------------+
void OnDeinit(const int reason)
{
//---
ObjectDelete(0,buttonID);
ObjectDelete(0,labelID);
}
//+------------------------------------------------------------------+
//| Expert tick function |
//+------------------------------------------------------------------+
void OnTick()
{
//---

© 2000-2010, MetaQuotes Software Corp.


714 Working with events

}
//+------------------------------------------------------------------+
void OnChartEvent(const int id,
const long &lparam,
const double &dparam,
const string &sparam)
{
//--- Check the event by pressing a mouse button
if(id==CHARTEVENT_OBJECT_CLICK)
{
string clickedChartObject=sparam;
//--- If you click on the object with the name buttonID
if(clickedChartObject==buttonID)
{
//--- State of the button - pressed or not
bool selected=ObjectGetInteger(0,buttonID,OBJPROP_STATE);
//--- log a debug message
Print("Button pressed =",selected);
int customEventID; // Number of the custom event to send
string message; // Message to be sent in the event
//--- If the button is pressed
if(selected)
{
message="Button pressed";
customEventID=CHARTEVENT_CUSTOM+1;
}
else // Button is not pressed
{
message="Button in not pressed";
customEventID=CHARTEVENT_CUSTOM+999;
}
//--- Send a custom event "our" chart
EventChartCustom(0,customEventID-CHARTEVENT_CUSTOM,0,0,message);
///--- Send a message to all open charts
BroadcastEvent(ChartID(),0,"Broadcast Message");
//--- Debug message
Print("Sent an event with ID =",customEventID);
}
ChartRedraw();// Forced redraw all chart objects
}

//--- Check the event belongs to the user events


if(id>CHARTEVENT_CUSTOM)
{
if(id==broadcastEventID)
{
Print("Got broadcast message from a chart with id ="+lparam);
}

© 2000-2010, MetaQuotes Software Corp.


715 Working with events

else
{
//--- We read a text message in the event
string info=sparam;
Print("Handle the user event with the ID =",id);
//--- Display a message in a label
ObjectSetString(0,labelID,OBJPROP_TEXT,sparam);
ChartRedraw();// Forced redraw all chart objects
}
}
}
//+------------------------------------------------------------------+
//| sends broadcast event to all open charts |
//+------------------------------------------------------------------+
void BroadcastEvent(long lparam,double dparam,string sparam)
{
int eventID=broadcastEventID-CHARTEVENT_CUSTOM;
long currChart=ChartFirst();
int i=0;
while(i<CHARTS_MAX // We have certainly no more than CHARTS_MAX open charts
{
EventChartCustom(currChart,eventID,lparam,dparam,sparam);
currChart=ChartNext(currChart); // We have received a new chart from the previous
if(currChart==0) break; // Reached the end of the charts list
i++;// Do not forget to increase the counter
}
}
//+------------------------------------------------------------------+

See also
Events of the client terminal, Event handler functions

© 2000-2010, MetaQuotes Software Corp.


716 Standard Library

Standard Library
This group of chapters contains the technical details of the standard library MQL5 and descriptions
of all its key components.

Standard library MQL5 written in MQL5 and is designed to facilitate writing programs (indicators,
scripts, experts) to end users.Library provides convenient access to most of the internal functions
MQL5.

Standard library MQL5 placed in the working directory of the terminal in the folder Include.

Section Location

Base class Include\

Classes of data Include\Arrays\

Classes for file operations Include\Files\

Classes for string operations Include\Strings\

Classes for graphic objects Include\Objects\

Class for working with chart Include\Charts\

Technical indicators Include\Indicators\

© 2000-2010, MetaQuotes Software Corp.


717 Standard Library

Basic Class CObject


Class CObject is the base class for constructing a standard library MQL5.

Description

Class CObject provides all its descendants to be part of a linked list. Also identifies a number of
virtual methods for further implementation in descendant classes.

Declaration
class CObject

Title
#include <Object.mqh>

Class Methods

Attributes

Prev Gets the value of the previous item

Prev Sets the value of the previous item

Next Gets the value of the subsequent element

Next Sets the next element

Compare methods

Compare Returns the result of comparison with another


object

Input/output

Save Writes object to a file

Load Reads the object from the file

Type Returns the type of object

© 2000-2010, MetaQuotes Software Corp.


718 Standard Library

Prev
Gets a pointer to the previous list item.

CObject*  Prev()

Return Value

Pointer to the previous list item. If an item is listed first, then return NULL.

Example:

//--- example for CObject::Prev()


#include <Object.mqh>
//---
void OnStart()
{
CObject *object_first,*object_second;
//---
object_first=new CObject;
if(object_first==NULL)
{
printf("Object create error");
return;
}
object_second=new CObject;
if(object_second==NULL)
{
printf("Object create error");
delete object_first;
return;
}
//--- set interconnect
object_first.Next(object_second);
object_second.Prev(object_first);
//--- use prev object
CObject *object=object_second.Prev();
//--- delete objects
delete object_first;
delete object_second;
}

© 2000-2010, MetaQuotes Software Corp.


719 Standard Library

Prev
Sets the pointer to the previous list item.

void  Prev(
CObject*  object  // Pointer to the previous list item
)

Parameters
object
[in] New value pointer to the previous list item.

Example:

//--- example for CObject::Prev(CObject*)


#include <Object.mqh>
//---
void OnStart()
{
CObject *object_first,*object_second;
//---
object_first=new CObject;
if(object_first==NULL)
{
printf("Object create error");
return;
}
object_second=new CObject;
if(object_second==NULL)
{
printf("Object create error");
delete object_first;
return;
}
//--- set interconnect
object_first.Next(object_second);
object_second.Prev(object_first);
//--- use objects
//--- ...
//--- delete objects
delete object_first;
delete object_second;
}

© 2000-2010, MetaQuotes Software Corp.


720 Standard Library

Next
Gets a pointer to the next element of the list.

CObject*  Next()

Return Value

Pointer to the next item in the list. If the last item in the list, returns NULL.

Example:

//--- example for CObject::Next()


#include <Object.mqh>
//---
void OnStart()
{
CObject *object_first,*object_second;
//---
object_first=new CObject;
if(object_first==NULL)
{
printf("Object create error");
return;
}
object_second=new CObject;
if(object_second==NULL)
{
printf("Object create error");
delete object_first;
return;
}
//--- set interconnect
object_first.Next(object_second);
object_second.Prev(object_first);
//--- use next object
CObject *object=object_first.Next();
//--- delete objects
delete object_first;
delete object_second;
}

© 2000-2010, MetaQuotes Software Corp.


721 Standard Library

Next
Sets the pointer to the next element of the list.

void  Next(
CObject*  object  // Pointer to the next list item
)

Parameters
object
[in] New value pointer to the next list item.

Example:

//--- example for CObject::Next(CObject*)


#include <Object.mqh>
//---
void OnStart()
{
CObject *object_first,*object_second;
//---
object_first=new CObject;
if(object_first==NULL)
{
printf("Object create error");
return;
}
object_second=new CObject;
if(object_second==NULL)
{
printf("Object create error");
delete object_first;
return;
}
//--- set interconnect
object_first.Next(object_second);
object_second.Prev(object_first);
//--- use objects
//--- ...
//--- delete objects
delete object_first;
delete object_second;
}

© 2000-2010, MetaQuotes Software Corp.


722 Standard Library

Compare
Compares the data item in the list with data on another element of the list.

virtual int  Compare(


CObject const *  node,  // Node to compare with
int  mode=0  // Compare mode
) const

Parameters
node
[in] Pointer to a list item to compare

mode=0
[in] Variant Comparison

Return Value

0 - in case the list items are equal, -1 - if the list item is less than the item in the list for
comparison (node), 1 - if the list item more than item in the list for comparison (node).

Note

Method Compare () in class CObject always returns 0 and does not perform any action.If you want to
compare data derived class, the method Compare (...) Should be implemented.The mode parameter
should be used when implementing multivariate comparison.

Example:

//--- example for CObject::Compare(...)


#include <Object.mqh>
//---
void OnStart()
{
CObject *object_first,*object_second;
//---
object_first=new CObject;
if(object_first==NULL)
{
printf("Object create error");
return;
}
object_second=new CObject;
if(object_second==NULL)
{
printf("Object create error");
delete object_first;
return;
}
//--- set interconnect
object_first.Next(object_second);

© 2000-2010, MetaQuotes Software Corp.


723 Standard Library

object_second.Prev(object_first);
//--- compare objects
int result=object_first.Compare(object_second);
//--- delete objects
delete object_first;
delete object_second;
}

© 2000-2010, MetaQuotes Software Corp.


724 Standard Library

Save
Saves data element list in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (), binary

Return Value

true - if successfully completed, false - if an error.

Note

Method Save (int) in class CObject always returns true and does not perform any action. If you want
to save the data derived class in the file, the method Save (int) should be implemented.

Example:

//--- example for CObject::Save(int)


#include <Object.mqh>
//---
void OnStart()
{
int file_handle;
CObject *object=new CObject;
//---
if(object!=NULL)
{
printf("Object create error");
return;
}
//--- set objects data
//--- . . .
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!object.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete object;
FileClose(file_handle);
//---
return;
}

© 2000-2010, MetaQuotes Software Corp.


725 Standard Library

FileClose(file_handle);
}
delete object;
}

© 2000-2010, MetaQuotes Software Corp.


726 Standard Library

Load
Loads data item in the list from a file.

virtual bool  Load(


int  file_handle  // handle to file
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (), binary

Return Value

true – if successfully completed, false - if an error.

Note

Method Load (int) in class CObject always returns true and does not perform any action. If you want
to load the data derived class from a file, the method Load (int) should be implemented.

Example:

//--- example for CObject::Load(int)


#include <Object.mqh>
//---
void OnStart()
{
int file_handle;
CObject *object=new CObject;
//---
if(object!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!object.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete object;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}

© 2000-2010, MetaQuotes Software Corp.


727 Standard Library

//--- use object


//--- . . .
delete object;
}

© 2000-2010, MetaQuotes Software Corp.


728 Standard Library

Type
Gets the type identifier.

virtual int  Type() const

Return Value

Type identifier (for CObject - 0).

Example:

//--- example for CObject::Type()


#include <Object.mqh>
//---
void OnStart()
{
CObject *object=new CObject;
//---
object=new CObject;
if(object ==NULL)
{
printf("Object create error");
return;
}
//--- get objects type
int type=object.Type();
//--- delete object
delete object;
}

© 2000-2010, MetaQuotes Software Corp.


729 Standard Library

Data Structures
This section contains the technical details of working with various data structures (arrays, linked
lists, etc.) and description of the relevant components of the standard library MQL5.

Using classes of data structures, will save time when creating custom data stores of various formats
(including composite data structures).

Standard library MQL5 (in terms of data sets) is placed in the working directory of the terminal in
the folder Include \ Arrays

Data Arrays
Use of classes of dynamic arrays of data will save time when creating a custom data stores of
various formats (including multidimensional arrays).

Standard library MQL5 (in terms of arrays of data) is placed in the working directory of the terminal
in the folder Include \ Arrays.

Class Description

Base class of dynamic data array CArray Base class of dynamic data array

CArrayChar Dynamic array of variables of type char or uchar

CArrayShort Dynamic array of variables of type short or


ushort

CArrayInt Dynamic array of variables of type int or uint

CArrayLong Dynamic array of variables of type long or ulong

CArrayFloat Dynamic array of variables of type float

CArrayDouble Dynamic array of variables of type double

CArrayString Dynamic array of variables of type string

Base class of object array CArrayObj Dynamic array of pointers CObject

Dase class of list CList Provides the ability to work with a list of
instances of CObject and his successors

© 2000-2010, MetaQuotes Software Corp.


730 Standard Library

CArray
CArray class is the base class a dynamic array of variables.

Description

Class CArray provides the ability to work with a dynamic array of variables in the part of the
attributes of management of memory allocation, sorting, and working with files.

Declaration
class CArray : public CObject

Title
#include <Arrays\Array.mqh>

Class Methods

Attributes

Step Gets the step increment size of the array

Step Set the increment size of the array

Total Gets the number of elements in the array

Available Gets the number of free elements of the array


are available without additional memory
allocation

Max Gets the maximum possible size of the array


without memory reallocation

IsSorted Gets sign sorted array to the specified option

SortMode Gets the version of the sorting array

Clear methods

Clear Deletes all of the array elements without


memory release

Sort methods

Sort Sorts an array to the specified option

Input/output

Save Saves data array in the file

Load Loads data array from a file

© 2000-2010, MetaQuotes Software Corp.


731 Standard Library

Step
Gets the step increment size of the array.

int  Step() const

Return Value

Increment size of the array.

Example:

//--- example for CArray::Step()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get resize step
int step=array.Step();
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


732 Standard Library

Step
Sets the increment size of the array.

bool  Step(
int  step  // step
)

Parameters
step
[in] The new value of step increments in the size of the array.

Return Value

true if successful, false - if there was an attempt to establish a step less than or equal to zero.

Example:

//--- example for CArray::Step(int)


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- set resize step
bool result=array.Step(1024);
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


733 Standard Library

Total
Gets the number of elements in the array.

int  Total() const;

Return Value

Number of elements in the array.

Example:

//--- example for CArray::Total()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- check total
int total=array.Total();
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


734 Standard Library

Available
Gets the number of free elements of the array are available without additional memory allocation.

int  Available() const

Return Value

Number of free elements of the array are available without additional memory allocation.

Example:

//--- example for CArray::Available()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- check available
int available=array.Available();
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


735 Standard Library

Max
Gets the maximum possible size of the array without memory reallocation.

int  Max() const

Return Value

The maximum possible size of the array without reallocation memory.

Example:

//--- example for CArray::Max()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- check maximum size
int max=array.Max();
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


736 Standard Library

IsSorted
Gets sign sorted array to the specified option.

bool  IsSorted(
int  mode=0  // Sorting mode
) const

Parameters
mode=0
[in] Tested version of the sort.

Return Value

Flag of the sorted list. If the list is sorted by the specified version - true, otherwise - false.

Note

Symptom sorted array can not be changed directly. Symptom sorted set method Sort () and reset
any methods to add / insert except InsertSort (...).

Example:

//--- example for CArray::IsSorted()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- check sorted
if(array.IsSorted())
{
//--- use methods for sorted array
//--- ...
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


737 Standard Library

SortMode
Gets the version of the sorting array.

int  SortMode() const;

Return Value

Sorting mode.

Example:

//--- example for CArray::SortMode()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- check sort mode
int sort_mode=array.SortMode();
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


738 Standard Library

Clear
Deletes all of the array elements without memory release.

void  Clear()

Return Value

None.

Example:

//--- example for CArray::Clear()


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- use array
//--- ...
//--- clear array
array.Clear();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


739 Standard Library

Sort
Sorts an array to the specified option.

void  Sort(
int  mode=0  // Sorting mode
)

Parameters
mode=0
[in] Mode of array sorting.

Return Value

No.

Note

Sorting an array is always ascending.For arrays of primitive data types (CArrayChar, CArrayShort,
etc.), the parameter mode is not used.For the array CArrayObj, multivariate sort should be
implemented in the method Sort (int) derived class.

Example:

//--- example for CArray::Sort(int)


#include <Arrays\Array.mqh>
//---
void OnStart()
{
CArray *array=new CArray;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- sorting by mode 0
array.Sort(0);
//--- use array
//--- ...
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


740 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArray::Save(int)


#include <Arrays\Array.mqh>
//---
void OnStart()
{
int file_handle;
CArray *array=new CArray;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


741 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArray::Load(...)


#include <Arrays\Array.mqh>
//---
void OnStart()
{
int file_handle;
CArray *array=new CArray;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


742 Standard Library

CArrayChar
CArrayChar class is a class of dynamic array of variables of type char or uchar.

Description

Class CArrayChar provides the ability to work with a dynamic array of variables of type char or
uchar.In the class implemented the ability to add / insert / delete elements in an array, sort array,
searching in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayChar : public CArray

Title
#include <Arrays\ArrayChar.mqh>

Class Methods

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Modify methods

Update Changes the element at the specified position


array

© 2000-2010, MetaQuotes Software Corp.


743 Standard Library

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array methods

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


744 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayChar::Reserve(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


745 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayChar::Resize(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


746 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayChar::Shutdown()


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


747 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
char  element  // Element to add
)

Parameters
element
[in] value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayChar::Add(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


748 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const char&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayChar::AddArray(const char &[])


#include <Arrays\ArrayChar.mqh>
//---
char src[];
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


749 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayChar*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayChar-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayChar::AddArray(const CArrayChar*)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayChar *src=new CArrayChar;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


750 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


751 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
char  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayChar::Insert(char,int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


752 Standard Library

InsertArray
Inserts an array of elements from another array with the specified position.

bool  InsertArray(
const char&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayChar::InsertArray(const char &[],int)


#include <Arrays\ArrayChar.mqh>
//---
char src[];
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


753 Standard Library

InsertArray
Inserts an array of elements from another array with the specified position.

bool  InsertArray(
CArrayChar*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayChar-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayChar::InsertArray(const CArrayChar*,int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayChar *src=new CArrayChar;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


754 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


755 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const char&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayChar::AssignArray(const char &[])


#include <Arrays\ArrayChar.mqh>
//---
char src[];
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


756 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayChar*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayChar-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayChar::AssignArray(const CArrayChar*)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayChar *src =new CArrayChar;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


757 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


758 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
char  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayChar::Update(int,char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,'A'))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


759 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Value
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayChar::Shift(int,int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


760 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] Position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayChar::Delete(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


761 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Positions of the last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayChar::DeleteRange(int,int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


762 Standard Library

At
Gets the element from the given position in the array.

char  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, CHAR_MAX-if there was an attempt to get an element
of not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, CHAR_MAX may be a valid value of an array element, so having a value, always check the
last error code.

Example:

//--- example for CArrayChar::At(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
char result=array.At(i);
if(result==CHAR_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- error of reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


763 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


764 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const char&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayChar::CompareArray(const char &[])


#include <Arrays\ArrayChar.mqh>
//---
char src[];
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


765 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const CArrayChar*  src  // Pointer to the sources
) const

Parameters
src
[in] Pointer to an instance of class CArrayChar-source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayChar::CompareArray(const CArrayChar*)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayChar *src=new CArrayChar;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


766 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
char  element  // Element to insert
)

Parameters
element
[in] Value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayChar::InsertSort(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort('A'))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


767 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::Search(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


768 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchGreat(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


769 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchLess(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


770 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array

int  SearchGreatOrEqual(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchGreatOrEqual(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


771 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchLessOrEqual(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


772 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchFirst(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


773 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
char  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayChar::SearchLast(char)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast('A')!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


774 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true – if successfully completed, false - if an error.

Example:

//--- example for CArrayChar::Save(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
int file_handle;
CArrayChar *array=new CArrayChar;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


775 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true – if successfully completed, false - if an error.

Example:

//--- example for CArrayChar::Load(int)


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
int file_handle;
CArrayChar *array=new CArrayChar;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=’%c’",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


776 Standard Library

}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


777 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayChar - 77).

Example:

//--- example for CArrayChar::Type()


#include <Arrays\ArrayChar.mqh>
//---
void OnStart()
{
CArrayChar *array=new CArrayChar;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


778 Standard Library

CArrayShort
CArrayShort class is a class of dynamic array of variables of type short or ushort.

Description

Class CArrayShort provides the ability to work with a dynamic array of variables of type short or
ushort.In the class implemented the ability to add / insert / delete elements in an array, sort array,
searching in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayShort : public CArray

Title
#include <Arrays\ArrayShort.mqh>

Class Methods

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

Update Changes the element at the specified position


array

© 2000-2010, MetaQuotes Software Corp.


779 Standard Library

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


780 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayShort::Reserve(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


781 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayShort::Resize(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


782 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayShort::Shutdown()


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


783 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
short  element  // Element to add
)

Parameters
element
[in] Value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayShort::Add(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


784 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const short&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayShort::AddArray(const short &[])


#include <Arrays\ArrayShort.mqh>
//---
short src[];
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


785 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayShort*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayShort-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayShort::AddArray(const CArrayShort*)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayShort *src=new CArrayShort;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


786 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


787 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
short  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayShort::Insert(short,int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


788 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
const short&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayShort::InsertArray(const short &[],int)


#include <Arrays\ArrayShort.mqh>
//---
short src[];
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


789 Standard Library

InsertArray
Inserts an array of elements from another array ukazannogy position.

bool  InsertArray(
CArrayShort*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayShort-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayShort::InsertArray(const CArrayShort*,int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayShort *src=new CArrayShort;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


790 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


791 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const short&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayShort::AssignArray(const short &[])


#include <Arrays\ArrayShort.mqh>
//---
short src[];
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


792 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayShort*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayShort-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayShort::AssignArray(const CArrayShort*)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayShort *src =new CArrayShort;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


793 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


794 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
short  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayShort::Update(int,short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,100))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


795 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Positions
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayShort::Shift(int,int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


796 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] Position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayShort::Delete(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


797 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of the lase element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayShort::DeleteRange(int,int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


798 Standard Library

At
Gets the element from the given position in the array.

short  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, SHORT_MAX-if there was an attempt to get an element
of not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, SHORT_MAX may be a valid value of an array element, so having a value, always check
the last error code.

Example:

//--- example for CArrayShort::At(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
short result=array.At(i);
if(result==SHORT_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- error of reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


799 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


800 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const short&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayShort::CompareArray(const short &[])


#include <Arrays\ArrayShort.mqh>
//---
short src[];
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


801 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const CArrayShort*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayShort-source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayShort::CompareArray(const CArrayShort*)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayShort *src=new CArrayShort;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


802 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
short  element  // Element to insert
)

Parameters
element
[in] Value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayShort::InsertSort(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(100))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


803 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::Search(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


804 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchGreat(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


805 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchLess(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


806 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchGreatOrEqual(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


807 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchLessOrEqual(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


808 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchFirst(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


809 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
short  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayShort::SearchLast(short)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast(100)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


810 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayShort::Save(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
int file_handle;
CArrayShort *array=new CArrayShort;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(i);
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


811 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


812 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayShort::Load(int)


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
int file_handle;
CArrayShort *array=new CArrayShort;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=%d",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


813 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


814 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayShort - 82).

Example:

//--- example for CArrayShort::Type()


#include <Arrays\ArrayShort.mqh>
//---
void OnStart()
{
CArrayShort *array=new CArrayShort;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


815 Standard Library

CArrayInt
CArrayInt class is a class of dynamic array of variables of type int or uint.

Description

Class CArrayInt provides the ability to work with a dynamic array of variables of type int or uint.In
the class implemented the ability to add / insert / delete elements in an array, sort array, searching
in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayInt : public CArray

Title
#include <Arrays\ArrayInt.mqh>

Class Methods

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

Update Changes the element at the specified position


array

© 2000-2010, MetaQuotes Software Corp.


816 Standard Library

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


817 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayInt::Reserve(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


818 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Number
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayInt::Resize(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


819 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayInt::Shutdown()


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


820 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
int  element  // Element to add
)

Parameters
element
[in] value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayInt::Add(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


821 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const int&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayInt::AddArray(const int &[])


#include <Arrays\ArrayInt.mqh>
//---
int src[];
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


822 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayInt*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayInt-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayInt::AddArray(const CArrayInt*)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayInt *src=new CArrayInt;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


823 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


824 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
int  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayInt::Insert(int,int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


825 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
const int&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayInt::InsertArray(const int &[],int)


#include <Arrays\ArrayInt.mqh>
//---
int src[];
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


826 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
CArrayInt*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayInt-source elements to insert.

pos
[in] Position in the array to insert.

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayInt::InsertArray(const CArrayInt*,int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayInt *src=new CArrayInt;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


827 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


828 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const int&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayInt::AssignArray(const int &[])


#include <Arrays\ArrayInt.mqh>
//---
int src[];
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


829 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayInt*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayInt-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayInt::AssignArray(const CArrayInt*)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayInt *src =new CArrayInt;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}

© 2000-2010, MetaQuotes Software Corp.


830 Standard Library

//--- arrays is identical


//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


831 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
int  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change.

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayInt::Update(int,int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,10000))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


832 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayInt::Shift(int,int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


833 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] Position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayInt::Delete(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


834 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of the last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayInt::DeleteRange(int,int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


835 Standard Library

At
Gets the element from the given position in the array.

int  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, INT_MAX-if there was an attempt to get an element of
not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, INT_MAX could be a valid value of an array element, so having a value, always check the
last error code.

Example:

//--- example for CArrayInt::At(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
int result=array.At(i);
if(result==INT_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- error of reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


836 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


837 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const int&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayInt::CompareArray(const int &[])


#include <Arrays\ArrayInt.mqh>
//---
int src[];
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


838 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const CArrayInt*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayInt-source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayInt::CompareArray(const CArrayInt*)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayInt *src=new CArrayInt;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


839 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
int  element  // Element to insert
)

Parameters
element
[in] value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayInt::InsertSort(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(10000))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


840 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::Search(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


841 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::SearchGreat(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


842 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::SearchLess(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


843 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
int  element  // Element to search
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::SearchGreatOrEqual(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


844 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::SearchLessOrEqual(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


845 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt:: SearchFirst(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


846 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
int  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayInt::SearchLast(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast(10000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


847 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayInt::Save(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
int file_handle;
CArrayInt *array=new CArrayInt;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(i);
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


848 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


849 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayInt::Load(int)


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
int file_handle;
CArrayInt *array=new CArrayInt;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=%d",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


850 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


851 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayInt - 82).

Example:

//--- example for CArrayInt::Type()


#include <Arrays\ArrayInt.mqh>
//---
void OnStart()
{
CArrayInt *array=new CArrayInt;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


852 Standard Library

CArrayLong
CArrayLong class is a class of dynamic array of variables of type long or ulong.

Description

Class CArrayLong provides the ability to work with a dynamic array of variables of type long or
ulong.In the class implemented the ability to add / insert / delete elements in an array, sort array,
searching in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayLong : public CArray

Title
#include <Arrays\ArrayLong.mqh>

Class Method

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

Update Changes the element at the specified position


array

© 2000-2010, MetaQuotes Software Corp.


853 Standard Library

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


854 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayLong::Reserve(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


855 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayLong::Resize(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


856 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayLong::Shutdown()


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


857 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
long  element  // Element to add
)

Parameters
element
[in] Value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayLong::Add(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


858 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const long&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayLong::AddArray(const long &[])


#include <Arrays\ArrayLong.mqh>
//---
long src[];
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


859 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayLong*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayLong-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayLong::AddArray(const CArrayLong*)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayLong *src=new CArrayLong;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


860 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


861 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
long  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayLong::Insert(long,int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


862 Standard Library

InsertArray
Inserts an array of elements from another array ukazannogy position.

bool  InsertArray(
const long&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayLong::InsertArray(const long &[],int)


#include <Arrays\ArrayLong.mqh>
//---
long src[];
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


863 Standard Library

InsertArray
Inserts an array of elements from another array ukazannogy position.

bool  InsertArray(
CArrayLong*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayLong-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayLong::InsertArray(const CArrayLong*,int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayLong *src=new CArrayLong;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


864 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


865 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const long&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayLong::AssignArray(const long &[])


#include <Arrays\ArrayLong.mqh>
//---
long src[];
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


866 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayLong*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayLong-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayLong::AssignArray(const CArrayLong*)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayLong *src =new CArrayLong;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


867 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


868 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
long  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayLong::Update(int,long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,1000000))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


869 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayLong::Shift(int,int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


870 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] Position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayLong::Delete(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


871 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of the last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayLong::DeleteRange(int,int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


872 Standard Library

At
Gets the element from the given position in the array.

long  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, LONG_MAX if there was an attempt to get an element
of not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, LONG_MAX may be a valid value of an array element, so having a value, always check the
last error code.

Example:

//--- example for CArrayLong::At(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
long result=array.At(i);
if(result==LONG_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- Error reading from the array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


873 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


874 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const long&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayLong::CompareArray(const long &[])


#include <Arrays\ArrayLong.mqh>
//---
long src[];
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


875 Standard Library

CompareArrayconst
Compares array with another array.

bool  CompareArrayconst(
const CArrayLong*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayLong-source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayLong::CompareArray(const CArrayLong*)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayLong *src=new CArrayLong;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


876 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
long  element  // Element to insert
)

Parameters
element
[in] Value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayLong::InsertSort(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(1000000))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


877 Standard Library

Search
Searches for an element equal to the model in sorted array.

int  Search(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::Search(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


878 Standard Library

SearchGreat
Searches for an element of larger sample, in sorted array.

int  SearchGreat(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchGreat(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


879 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchLess(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


880 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the model in sorted array.

int  SearchGreatOrEqual(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchGreatOrEqual(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


881 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the model in sorted array.

int  SearchLessOrEqual(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchLessOrEqual(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


882 Standard Library

SearchFirst
Finds the first element equal to the model in sorted array.

int  SearchFirst(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchFirst(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


883 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
long  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayLong::SearchLast(long)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast(1000000)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


884 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true – if successfully completed, false - if an error.

Example:

//--- example for CArrayLong::Save(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
int file_handle;
CArrayLong *array=new CArrayLong;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(i);
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


885 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


886 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true – if successfully completed, false - if an error.

Example:

//--- example for CArrayLong::Load(int)


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
int file_handle;
CArrayLong *array=new CArrayLong;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=%I64",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


887 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


888 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayLong - 84).

Example:

//--- example for CArrayLong::Type()


#include <Arrays\ArrayLong.mqh>
//---
void OnStart()
{
CArrayLong *array=new CArrayLong;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


889 Standard Library

CArrayFloat
CArrayFloat class is a class of dynamic array of variables of type float.

Description

Class CArrayFloat provides the ability to work with a dynamic array of variables of type float.In the
class implemented the ability to add / insert / delete elements in an array, sort array, searching in
sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayFloat : public CArray

Title
#include <Arrays\ArrayFloat.mqh>

Class Methods

Attributes

Delta Set the comparison tolerance

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

© 2000-2010, MetaQuotes Software Corp.


890 Standard Library

Update Changes the element at the specified position


array

Shift Moves an item from a given position in the


array to the specified offset

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


891 Standard Library

Delta
Set tolerance comparison.

void  Delta(
float  delta  // Tolerance
)

Parameters
delta
[in] the new value of the admission of comparison.

Return Value

None

Note

Admission of comparison used in the search. Values are considered equal if their difference is less
than or equal to tolerance. The default tolerance is 0.0.

Example:

//--- example for CArrayFloat::Delta(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- set compare variation
array.Delta(0.001);
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


892 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayFloat::Reserve(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


893 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayFloat::Resize(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


894 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayFloat::Shutdown()


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


895 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
float  element  // Element to add
)

Parameters
element
[in] Value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayFloat::Add(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


896 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const float&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayFloat::AddArray(const float &[])


#include <Arrays\ArrayFloat.mqh>
//---
float src[];
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


897 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayFloat*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayFloat-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayFloat::AddArray(const CArrayFloat*)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayFloat *src=new CArrayFloat;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


898 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


899 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
float  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayFloat::Insert(float,int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


900 Standard Library

InsertArray
Inserts an array of elements from another array with the specified position.

bool  InsertArray(
const float&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayFloat::InsertArray(const float &[],int)


#include <Arrays\ArrayFloat.mqh>
//---
float src[];
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


901 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
CArrayFloat*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayFloat-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayFloat::InsertArray(const CArrayFloat*,int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayFloat *src=new CArrayFloat;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


902 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


903 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const float&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayFloat::AssignArray(const float &[])


#include <Arrays\ArrayFloat.mqh>
//---
float src[];
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


904 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayFloat*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayFloat-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayFloat::AssignArray(const CArrayFloat*)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayFloat *src =new CArrayFloat;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


905 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


906 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
float  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayFloat::Update(int,float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,100.0))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


907 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayFloat::Shift(int,int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


908 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] Position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayFloat::Delete(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


909 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayFloat::DeleteRange(int,int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


910 Standard Library

At
Gets the element from the given position in the array.

float  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, FLT_MAX if there was an attempt to get an element of
not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, FLT_MAX may be a valid value of an array element, so having a value, always check the
last error code.

Example:

//--- example for CArrayFloat::At(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
float result=array.At(i);
if(result==FLT_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- error reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


911 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


912 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const float&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayFloat::CompareArray(const float &[])


#include <Arrays\ArrayFloat.mqh>
//---
float src[];
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


913 Standard Library

AssignArrayconst
Copies the array elements from another array.

bool  AssignArrayconst(
const CArrayFloat*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayFloat-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayFloat::CompareArray(const CArrayFloat*)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayFloat *src=new CArrayFloat;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


914 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
float  element  // Element to insert
)

Parameters
element
[in] Value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayFloat::InsertSort(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(100.0))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


915 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::Search(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


916 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::SearchGreat(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


917 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat:: SearchLess(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


918 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::SearchGreatOrEqual(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


919 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::SearchLessOrEqual(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


920 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::SearchFirst(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


921 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
float  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayFloat::SearchLast(float)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


922 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayFloat::Save(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
int file_handle;
CArrayFloat *array=new CArrayFloat;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(i);
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


923 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


924 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayFloat::Load(int)


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
int file_handle;
CArrayFloat *array=new CArrayFloat;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=%f",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


925 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


926 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayFloat - 87).

Example:

//--- example for CArrayFloat::Type()


#include <Arrays\ArrayFloat.mqh>
//---
void OnStart()
{
CArrayFloat *array=new CArrayFloat;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


927 Standard Library

CArrayDouble
CArrayDouble class is a class of dynamic array of variables of type double.

Description

Class CArrayDouble provides the ability to work with a dynamic array of variables of type double.In
the class implemented the ability to add / insert / delete elements in an array, sort array, searching
in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayDouble : public CArray

Title
#include <Arrays\ArrayDouble.mqh>

Class Methods

Attributes

Delta Set the comparison tolerance

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a full memory release

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

© 2000-2010, MetaQuotes Software Corp.


928 Standard Library

Update Changes the element at the specified position


array

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


929 Standard Library

Delta
Set tolerance comparison.

void  Delta(
double  delta  // Tolerance
)

Parameters
delta
[in] The new value of the admission of comparison.

Return Value

No

Note

Admission of comparison used in the search. Values are considered equal if their difference is less
than or equal to tolerance. The default tolerance is 0.0.

Example:

//--- example for CArrayDouble::Delta(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- set compare variation
array.Delta(0.001);
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


930 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayDouble::Reserve(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


931 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayDouble::Resize(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


932 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayDouble::Shutdown()


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


933 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
double  element  // Element to add
)

Parameters
element
[in] value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayDouble::Add(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(i))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


934 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const double&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayDouble::AddArray(const double &[])


#include <Arrays\ArrayDouble.mqh>
//---
double src[];
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


935 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayDouble*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayDouble-source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayDouble::AddArray(const CArrayDouble*)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayDouble *src=new CArrayDouble;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


936 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


937 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
double  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayDouble::Insert(double,int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(i,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


938 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
const double&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayDouble::InsertArray(const double &[],int)


#include <Arrays\ArrayDouble.mqh>
//---
double src[];
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


939 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
CArrayDouble*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayDouble-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayDouble::InsertArray(const CArrayDouble*,int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayDouble *src=new CArrayDouble;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


940 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


941 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const double&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayDouble::AssignArray(const double &[])


#include <Arrays\ArrayDouble.mqh>
//---
double src[];
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


942 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayDouble*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayDouble-source element to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayDouble::AssignArray(const CArrayDouble*)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayDouble *src =new CArrayDouble;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


943 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


944 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
double  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value.

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayDouble::Update(int,double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,100.0))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


945 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayDouble::Shift(int,int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


946 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayDouble::Delete(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


947 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayDouble::DeleteRange(int,int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


948 Standard Library

At
Gets the element from the given position in the array.

double  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, DBL_MAX if there was an attempt to get an element of
not existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, DBL_MAX may be a valid value of an array element, so having a value, always check the
last error code.

Example:

//--- example for CArrayDouble::At(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
double result=array.At(i);
if(result==DBL_MAX && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- Error reading from the array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


949 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


950 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const double&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayDouble::CompareArray(const double &[])


#include <Arrays\ArrayDouble.mqh>
//---
double src[];
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


951 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const CArrayDouble*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayDouble-source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayDouble::CompareArray(const CArrayDouble*)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayDouble *src=new CArrayDouble;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


952 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
double  element  // Element to insert
)

Parameters
element
[in] value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayDouble::InsertSort(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(100.0))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


953 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::Search(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


954 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::SearchGreat(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


955 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble:: SearchLess(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


956 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::SearchGreatOrEqual(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


957 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::SearchLessOrEqual(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


958 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::SearchFirst(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


959 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
double  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayDouble::SearchLast(double)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast(100.0)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


960 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayDouble::Save(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
int file_handle;
CArrayDouble *array=new CArrayDouble;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(i);
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


961 Standard Library

}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


962 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayDouble::Load(int)


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
int file_handle;
CArrayDouble *array=new CArrayDouble;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=%f",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


963 Standard Library

}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


964 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayDouble - 87).

Example:

//--- example for CArrayDouble::Type()


#include <Arrays\ArrayDouble.mqh>
//---
void OnStart()
{
CArrayDouble *array=new CArrayDouble;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


965 Standard Library

CArrayString
CArrayString class is a class of dynamic array of variables of type string.

Description

Class CArrayString provides the ability to work with a dynamic array of variables of type string.In
the class implemented the ability to add / insert / delete elements in an array, sort array, searching
in sorted array.In addition, the implemented methods of work with the file.

Declaration
class CArrayString : public CArray

Title
#include <Arrays\ArrayString.mqh>

Class Methods

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Sets a new (smaller) size of the array

Add methods

Add Adds an element to the end of the array

AddArray Adds to the end of the array elements from


another array

AddArray Adds to the end of the array elements from


another array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

AssignArray Copies the array elements from another array

Update methods

Update Changes the element at the specified position


array

© 2000-2010, MetaQuotes Software Corp.


966 Standard Library

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

CompareArray Compares array with another array

Sorted array opetations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

Type Gets the type identifier of the array

© 2000-2010, MetaQuotes Software Corp.


967 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayString::Reserve(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reserve memory
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


968 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

true if successful, false - if there was an attempt to set the size of less than or equal to zero.

Note

Changing the size of the array allows optimal use of memory.Superfluous elements on the right lost.
To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayString::Resize(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


969 Standard Library

Shutdown
Clears the array with a full memory release.

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Example:

//--- example for CArrayString::Shutdown()


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


970 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
string  element  // Element to add
)

Parameters
element
[in] value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Example:

//--- example for CArrayString::Add(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(IntegerToString(i)))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


971 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const string&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayString::AddArray(const string &[])


#include <Arrays\ArrayString.mqh>
//---
string src[];
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


972 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayString*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayString - the source of elements to add.

Return Value

true if successful, false - if you can not add items.

Example:

//--- example for CArrayString::AddArray(const CArrayString*)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayString *src=new CArrayString;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array
delete src;

© 2000-2010, MetaQuotes Software Corp.


973 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


974 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
string  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] Value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayString::Insert(string,int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(IntegerToString(i),0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


975 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
const string&  src[],  // Source array
int  pos  // Position
)

Parameters
src[]
[in] Reference to an array of source elements to insert

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayString::InsertArray(const string &[],int)


#include <Arrays\ArrayString.mqh>
//---
string src[];
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


976 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
CArrayString*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayString - the source of elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Example:

//--- example for CArrayString::InsertArray(const CArrayString*,int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayString *src=new CArrayString;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- insert another array
if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;

© 2000-2010, MetaQuotes Software Corp.


977 Standard Library

return;
}
//--- delete source array
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


978 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const string&  src[]  // Source array
)

Parameters
src[]
[in] Reference to an array of source elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayString::AssignArray(const string &[])


#include <Arrays\ArrayString.mqh>
//---
string src[];
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


979 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayString*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayString - source of elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Example:

//--- example for CArrayString::AssignArray(const CArrayString*)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayString *src =new CArrayString;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{
printf("Array assigned error");
delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array

© 2000-2010, MetaQuotes Software Corp.


980 Standard Library

delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


981 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
string  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Example:

//--- example for CArrayString::Update(int, string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,"ABC"))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


982 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayString::Shift(int,int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


983 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Example:

//--- example for CArrayString::Delete(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete element
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


984 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Example:

//--- example for CArrayString::DeleteRange(int,int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


985 Standard Library

At
Gets the element from the given position in the array.

string  At(
int  pos  // Position
) const

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element in case of success, "- if there was an attempt to get an element of not
existing positions (the last error ERR_OUT_OF_RANGE).

Note

Of course, "" may be a valid value of an array element, so having a value, always check the last
error code.

Example:

//--- example for CArrayString::At(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
string result=array.At(i);
if(result=="" && GetLastError()==ERR_OUT_OF_RANGE)
{
//--- Error reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


986 Standard Library

//--- delete array


delete array;
}

© 2000-2010, MetaQuotes Software Corp.


987 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const string&  src[]  // Source array
) const

Parameters
src[]
[in] Reference to an array of source elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayString::CompareArray(const string &[])


#include <Arrays\ArrayString.mqh>
//---
string src[];
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- compare with another array
int result=array.CompareArray(src);
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


988 Standard Library

CompareArray
Compares array with another array.

bool  CompareArrays(
const CArrayString*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayString - the source of elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayString::CompareArray(const CArrayString*)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayString *src=new CArrayString;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- add source arrays elements
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


989 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
string  element  // Element to insert
)

Parameters
element
[in] value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Example:

//--- example for CArrayString::InsertSort(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort("ABC"))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


990 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString::Search(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.Search("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


991 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString::SearchGreat(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreat("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


992 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString:: SearchLess(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLess("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


993 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString:: SearchGreatOrEqual(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchGreatOrEqual("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


994 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString:: SearchLessOrEqual(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLessOrEqual("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


995 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString:: SearchFirst(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchFirst("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


996 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
string  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayString:: SearchLast(string)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- search element
if(array.SearchLast("ABC")!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


997 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayString::Save(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
int file_handle;
CArrayString *array=new CArrayString;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
array.Add(IntegerToString(i));
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);

© 2000-2010, MetaQuotes Software Corp.


998 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


999 Standard Library

Load
Loads data array from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayString::Load(int)


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
int file_handle;
CArrayString *array=new CArrayString;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrays elements
for(int i=0;i<array.Total();i++)
{
printf("Element[%d]=’%s’",i,array.At(i));

© 2000-2010, MetaQuotes Software Corp.


1000 Standard Library

}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1001 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayString - 89).

Example:

//--- example for CArrayString::Type()


#include <Arrays\ArrayString.mqh>
//---
void OnStart()
{
CArrayString *array=new CArrayString;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1002 Standard Library

CArrayObj
CArrayObj class is a class of dynamic array of pointers to instances of CObject and his heirs.

Description

Class CArrayObj provides the ability to work with a dynamic array of pointers to instances of
CObject and his heirs. This gives the possibility to work as a multidimensional dynamic arrays of
primitive data types, and the more difficult for organized data structures.

In the class implemented the ability to add / insert / delete elements in an array, sort array,
searching in sorted array. In addition, the implemented methods of work with the file.

There are certain subtleties of the class CArrayObj.

Declaration
class CArrayObj : public CArray

Title
#include <Arrays\ArrayObj.mqh>

Class Method

Attributes

FreeMode Gets the flag memory management

FreeMode Sets the flag memory management

Memory control

Reserve Allocates memory to increase the size of the


array

Resize Sets a new (smaller) size of the array

Shutdown Clears the array with a total exemption memory


array (not element).

Add methods

Add Adds an element to the end of the array

AddArray Adds an element to the end of the array

Insert Inserts an element in the array to the specified


position

InsertArray Inserts an array of elements from another array


with the specified position

AssignArray Copies the array elements from another array

Update methods

© 2000-2010, MetaQuotes Software Corp.


1003 Standard Library

Update Changes the element at the specified position


array

Shift Moves an item from a given position in the


array to the specified offset

Delete methods

Detach Gets the element from the specified position


and removing it from the array

Delete Removes the element from the specified


position array

DeleteRange Deletes a group of elements from the specified


position array

Clear Removes all elements of the array without the


release of the memory array

Access methods

At Gets the element from the specified position


array

Compare methods

CompareArray Compares array with another array

Sorted array operations

InsertSort Inserts element in a sorted array

Search Searches for an element equal to the model in


sorted array

SearchGreat Searches for an element of more samples in


sorted array

SearchLess Searches for an element less than the sample in


the sorted array

SearchGreatOrEqual Searches for an element greater than or equal


to the model in sorted array

SearchLessOrEqual Searches for an element less than or equal to


the model in sorted array

SearchFirst Finds the first element equal to the model in


sorted array

SearchLast Finds the last element equal to the model in


sorted array

Input/output

Save Saves data array in the file

Load Loads data array from a file

© 2000-2010, MetaQuotes Software Corp.


1004 Standard Library

Type Gets the type identifier of the array

Practical application of arrays are descendants of class CObject (including all classes of the standard
library).

For example, consider the options for two-dimensional array:

#include <Arrays\ArrayDouble.mqh>
#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
int i,j;
int first_size=10;
int second_size=100;
//--- create array
CArrayObj *array=new CArrayObj;
CArrayDouble *sub_array;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create subarrays
for(i=0;i<first_size;i++)
{
sub_array=new CArrayDouble;
if(sub_array==NULL)
{
delete array;
printf("Object create error");
return;
}
//--- fill array
for(j=0;j<second_size;j++)
{
sub_array.Add(i*j);
}
array.Add(sub_array);
}
//--- create array OK
for(i=0;i<first_size;i++)
{
sub_array=array.At(i);
for(j=0;j<second_size;j++)

© 2000-2010, MetaQuotes Software Corp.


1005 Standard Library

{
double element=sub_array.At(j);
//--- use array element
}
}
delete array;
}

Subtleties

The class has a mechanism to control dynamic memory, so be careful when working with elements
of the array.

Mechanism of memory management can be switched on / off using the method FreeMode (bool). By
default, the mechanism is enabled.

Accordingly, there are two options for dealing with the class CArrayObj:

1. Mechanism of memory management is enabled. (default)

In this case, CArrayObj take responsibility for freeing the memory elements after their removal
from the array. In this program the user should not free the array elements.

Example:

int i;
//--- Create an array
CArrayObj *array=new CArrayObj;
//--- Fill array elements
for(i=0;i<10;i++) array.Add(new CObject);
//--- Do something
for(i=0;i<array.Total();i++)
{
CObject *object=array.At(i);
//--- Action with an element
. . .
}
//--- Remove the array with the elements
delete array;

2. Mechanism of memory management is turned off.

In this case, CArrayObj not otvetstvechaet for freeing the memory elements after their removal
from the array. In this program the user must free the array elements.

Example:

int i;
//--- Create an array
CArrayObj *array=new CArrayObj;

© 2000-2010, MetaQuotes Software Corp.


1006 Standard Library

//--- Disable the mechanism of memory management


array.FreeMode(false);
//--- Fill array elements
for(i=0;i<10;i++) array.Add(new CObject);
//--- Do something
for(i=0;i<array.Total();i++)
{
CObject *object=array.At(i);
//--- Action with an element
. . .
}
//--- Remove array elements
while(array.Total()) delete array.Detach();
//--- Remove empty array
delete array;

© 2000-2010, MetaQuotes Software Corp.


1007 Standard Library

FreeMode
Gets the flag memory management.

bool  FreeMode() const

Return Value

Flag of memory management.

Example:

//--- example for CArrayObj::FreeMode()


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get free mode flag
bool array_free_mode=array.FreeMode();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1008 Standard Library

FreeMode
Sets the flag memory management.

void  FreeMode(
bool  mode  // New flag
)

Parameters
mode
[in] New value of the flag memory management.

Return Value

None.

Note

Setting the flag memory management - an important point in the use of class CArrayObj.Since the
array elements are pointers to dynamic objects, it is important to determine what to do with them
when removing from the array.

If the flag is set, removing an element from the array, the element is automatically deleted by the
operator delete.If the flag is not set, it is assumed that a pointer to the deleted object is still
somewhere in the user program and will be relieved of it (the program) then.

If the user resets the flag memory management, the user must understand their responsibility for
the removal of the array before the completion of the program, because otherwise, is not freed
memory occupied by the elements when they create new operator.

When large amounts of data, it could lead, eventually, even to break your terminal.If the user does
not reset the flag memory management, there is another "reef".

Using pointers, array, stored somewhere in the local variables, after removing the array will lead to
a critical error and crashes the program user.By default, the memory management flag is set, ie the
class of the array is responsible for freeing the memory elements.

Example:

//--- example for CArrayObj::FreeMode(bool)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- reset free mode flag
array.FreeMode(false);

© 2000-2010, MetaQuotes Software Corp.


1009 Standard Library

//--- use array


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1010 Standard Library

Reserve
Allocates memory to increase the size of the array.

bool  Reserve(
int  size  // Number
)

Parameters
size
[in] The number of additional elements of the array.

Return Value

true if successful, false - if there was an attempt to seek the amount is less than or equal to zero,
or if the array did not increase.

Note

To reduce memory fragmentation, increase the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayObj::Reserve(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
if(!array.Reserve(1024))
{
printf("Reserve error");
delete array;
return;
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1011 Standard Library

Resize
Sets a new (smaller) size of the array.

bool  Resize(
int  size  // Size
)

Parameters
size
[in] New size of the array.

Return Value

To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Note

Changing the size of array allows to use memory in the optimal way. Excess element located to the
right are lost. The memory for lost elements is released or not depending on the mode of memory
management.

To reduce fragmentation of memory, change the size of the array is made with a step previously
given through the method of Step (int), or 16 (default).

Example:

//--- example for CArrayObj::Resize(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- resize array
if(!array.Resize(10))
{
printf("Resize error");
delete array;
return;
}
//--- delete array
delete array;

© 2000-2010, MetaQuotes Software Corp.


1012 Standard Library

© 2000-2010, MetaQuotes Software Corp.


1013 Standard Library

Clear
Removes all elements of the array without the release of the memory array.

void  Clear()

Return Value

No.

Note

If enabled memory management, memory, deleted items are exempt.

Example:

//--- example for CArrayObj::Clear()


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- clear array
array.Clear();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1014 Standard Library

Shutdown
Clears the array with a total exemption memory array (not element).

bool  Shutdown()

Return Value

true if successful, false - if an error occurred.

Note

If enabled memory management, memory, deleted items are exempt.

Example:

//--- example for CArrayObj::Shutdown()


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shutdown array
if(!array.Shutdown())
{
printf("Shutdown error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1015 Standard Library

CreateElement
Creates a new array element at the specified position.

bool  CreateElement(
int  index  // Position
)

Parameters
index
[in] position in which you want to create a new element.

Return Value

true if successful, false - if you can not create element.

Note

Method CreateElement (int) in class CArrayObj always returns false and does not perform any
action. If necessary, in a derived class, method CreateElement (int) should be implemented.

Example:

//--- example for CArrayObj::CreateElement(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
int size=100;
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- fill array
array.Reserve(size);
for(int i=0;i<size;i++)
{
if(!array.CreateElement(i))
{
printf("Element create error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;

© 2000-2010, MetaQuotes Software Corp.


1016 Standard Library

© 2000-2010, MetaQuotes Software Corp.


1017 Standard Library

Add
Adds an element to the end of the array.

bool  Add(
CObject*  element  // Element to add
)

Parameters
element
[in] value of the element to add to the array.

Return Value

true if successful, false - if you can not add an element.

Note

Element is not added to the array if the value for transmit invalid pointer (such as NULL).

Example:

//--- example for CArrayObj::Add(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add 100 arrays elements
for(int i=0;i<100;i++)
{
if(!array.Add(new CObject))
{
printf("Element addition error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1018 Standard Library

AddArray
Adds to the end of the array elements from another array.

bool  AddArray(
const CArrayObj *  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayDouble - source of elements to add.

Return Value

true if successful, false - if you can not add items.

Note

Adding elements of the array in the array is actually copying the pointers.Therefore, when calling
the method, there is a "reef" - that there may be a pointer to a dynamic object in more than one
variable.

//--- example
extern bool make_error;
extern int error;
extern CArrayObj *src;
//--- Create a new instance CArrayObj
//--- Default memory management is turned on
CArrayObj *array=new CArrayObj;
//--- Add (copy) the elements of the array-istochika
if(array!=NULL)
bool result=array.AddArray(src);
if(make_error)
{
//--- Commit wrongdoing
switch(error)
{
case 0:
//--- Remove the array-source, without checking its flag memory management
delete src;
//--- Result:
//--- May appeal
//--- For "bitomu" pointer in the array receiver
break;
case 1:
//--- Disable the mechanism of memory management in an array of source
if(src.FreeMode()) src.FreeMode(false);
//--- But do not remove the array-source
//--- Result:
//--- After removal of the array, the receiver may appeal

© 2000-2010, MetaQuotes Software Corp.


1019 Standard Library

//--- For "bitomu" pointer in the array-source


break;
case 2:
//--- Disable the mechanism of memory management in an array of source
src.FreeMode(false);
//--- Disable the mechanism of memory management in an array receiver
array.FreeMode(false);
//--- Result:
//--- After the completion of the program, obtain a "memory leak"
break;
}
}
else
{
//--- Disable the mechanism of memory management in an array of source
if(src.FreeMode()) src.FreeMode(false);
//--- Remove the array-source
delete src;
//--- Result:
//--- Treatment for an array-recepient be correct
//--- Delete the array, the receiver will delete its elements
}

Example:

//--- example for CArrayObj::AddArray(const CArrayObj*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayObj *src=new CArrayObj;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- reset free mode flag
src.FreeMode(false);
//--- fill source array

© 2000-2010, MetaQuotes Software Corp.


1020 Standard Library

//--- . . .
//--- add another array
if(!array.AddArray(src))
{
printf("Array addition error");
delete src;
delete array;
return;
}
//--- delete source array without elements
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1021 Standard Library

Insert
Inserts an element in the array to the specified position.

bool  Insert(
CObject*  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] value of the element to be inserted into an array

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not insert the element.

Note

Element is not added to the array if the value for transmit invalid pointer (such as NULL).

Example:

//--- example for CArrayObj::Insert(CObject*,int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- insert elements
for(int i=0;i<100;i++)
{
if(!array.Insert(new CObject,0))
{
printf("Insert error");
delete array;
return;
}
}
//--- use array
//--- . . .
//--- delete array

© 2000-2010, MetaQuotes Software Corp.


1022 Standard Library

delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1023 Standard Library

InsertArray
Inserts an array of elements from another array specified position.

bool  InsertArray(
const CArrayObj*  src,  // Pointer to the source
int  pos  // Position
)

Parameters
src
[in] Pointer to an instance of class CArrayObj-source elements to insert.

pos
[in] Position in the array to insert

Return Value

true if successful, false - if you can not paste items.

Note

See: CArrayObj::AddArray(const CArrayObj*).

Example:

//--- example for CArrayObj::InsertArray(const CArrayObj*,int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayObj *src=new CArrayObj;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- reset free mode flag
src.FreeMode(false);
//--- fill source array
//--- . . .
//--- insert another array

© 2000-2010, MetaQuotes Software Corp.


1024 Standard Library

if(!array.InsertArray(src,0))
{
printf("Array inserting error");
delete src;
delete array;
return;
}
//--- delete source array without elements
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1025 Standard Library

AssignArray
Copies the array elements from another array.

bool  AssignArray(
const CArrayObj*  src  // Pointer to the source
)

Parameters
src
[in] Pointer to an instance of class CArrayObj - source of elements to copy.

Return Value

true if successful, false - if you can not copy the items.

Note

If the challenge AssignArray array receiver is not empty, all its elements will be removed from the
array and, if the flag memory management, memory, deleted items will be released.Array-receiver
is an exact copy of the array source. Additionally see CArrayObj::AddArray(const CArrayObj*).

Example:

//--- example for CArrayObj::AssignArray(const CArrayObj*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayObj *src=new CArrayObj;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- reset free mode flag
src.FreeMode(false);
//--- fill source array
//--- . . .
//--- assign another array
if(!array.AssignArray(src))
{

© 2000-2010, MetaQuotes Software Corp.


1026 Standard Library

printf("Array assigned error");


delete src;
delete array;
return;
}
//--- arrays is identical
//--- delete source array without elements
delete src;
//--- use array
//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1027 Standard Library

Update
Changes the element at the specified position array.

bool  Update(
int  pos,  // Position
CObject*  element  // Value
)

Parameters
pos
[in] Position of the element in the array to change

element
[in] New value element

Return Value

true if successful, false - if you can not change the element.

Note

The element does not change if we as a parameter to pass an invalid pointer (ie NULL). If enabled
memory management, memory placeholder released.

Example:

//--- example for CArrayObj::Update(int,CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- update element
if(!array.Update(0,new CObject))
{
printf("Update error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1028 Standard Library

Shift
Moves an item from a given position in the array to the specified offset.

bool  Shift(
int  pos,  // Position
int  shift  // Shift
)

Parameters
pos
[in] Position of the moved element array

shift
[in] The value of displacement (both positive and negative).

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CArrayObj::Shift(int,int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- shift element
if(!array.Shift(10,-5))
{
printf("Shift error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1029 Standard Library

Detach
Remove an item from a given position in the array.

CObject*  Detach(
int  pos  // Position
)

Parameters
pos
[in] Position of the seized item in the array.

Return Value

Pointer to the removal of elements in case of success, NULL - if you can not remove the element.

Note

When removed from the array element is not removed in any state of the flag memory
management. Pointer to the array element withdrawn from the ingredients of the release after use.

Example:

//--- example for CArrayObj::Detach(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
CObject *object=array.Detach(0);
if(object==NULL)
{
printf("Detach error");
delete array;
return;
}
//--- use element
//--- . . .
//--- delete element
delete object;
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1030 Standard Library

Delete
Removes the element from the given position in the array.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] position removes the element in the array.

Return Value

true if successful, false - if you can not remove the element.

Note

If enabled memory management, memory, deleted items are exempt.

Example:

//--- example for CArrayObj::Delete(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
if(!array.Delete(0))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1031 Standard Library

DeleteRange
Deletes a group of elements from a given position in the array.

bool  DeleteRange(
int  from,  // Position of the first element
int  to  // Position of last element
)

Parameters
from
[in] Position of the first removes the element in the array.

to
[in] Position of the last deleted element in the array.

Return Value

true if successful, false - if you can not remove elements.

Note

If enabled memory management, memory, deleted items are exempt.

Example:

//--- example for CArrayObj::DeleteRange(int,int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- delete elements
if(!array.DeleteRange(0,10))
{
printf("Delete error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1032 Standard Library

At
Gets the element from the given position in the array.

CObject*  At(
int  pos  // Position
)

Parameters
pos
[in] Position of the desired element in the array.

Return Value

The value of the element, if successful, NULL-if there was an attempt to get an element of non-
existent position.

Example:

//--- example for CArrayObj::At(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add elements
//--- . . .
for(int i=0;i<array.Total();i++)
{
CObject *result=array.At(i);
if(result==NULL)
{
//--- Error reading from array
printf("Get element error");
delete array;
return;
}
//--- use element
//--- . . .
}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1033 Standard Library

CompareArray
Compares array with another array.

bool  CompareArray(
const CArrayObj*  src  // Pointer to the source
) const

Parameters
src
[in] Pointer to an instance of class CArrayObj - the source of elements for comparison.

Return Value

true if arrays are equal, false - if not.

Example:

//--- example for CArrayObj::CompareArray(const CArrayObj*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- create source array
CArrayObj *src=new CArrayObj;
if(src==NULL)
{
printf("Object create error");
delete array;
return;
}
//--- fill source array
//--- . . .
//--- compare with another array
int result=array.CompareArray(src);
//--- delete arrays
delete src;
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1034 Standard Library

InsertSort
Inserts element in a sorted array.

bool  InsertSort(
CObject*  element  // Element to insert
)

Parameters
element
[in] Value of the element to be inserted into a sorted array

Return Value

true if successful, false - if you can not insert the element.

Note

Element is not added to the array if the value for transmit invalid pointer (such as NULL).

Example:

//--- example for CArrayObj::InsertSort(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- insert element
if(!array.InsertSort(new CObject))
{
printf("Insert error");
delete array;
return;
}
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1035 Standard Library

Search
Searches for an element equal to the sample in the sorted array.

int  Search(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj::Search(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.Search(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1036 Standard Library

SearchGreat
Searches for an element of more samples in sorted array.

int  SearchGreat(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj::SearchGreat(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchGreat(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1037 Standard Library

SearchLess
Searches for an element less than the sample in the sorted array.

int  SearchLess(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj:: SearchLess(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchLess(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1038 Standard Library

SearchGreatOrEqual
Searches for an element greater than or equal to the sample in the sorted array.

int  SearchGreatOrEqual(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj::SearchGreatOrEqual(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchGreatOrEqual(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1039 Standard Library

SearchLessOrEqual
Searches for an element less than or equal to the sample in the sorted array.

int  SearchLessOrEqual(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj:: SearchLessOrEqual(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchLessOrEqual(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1040 Standard Library

SearchFirst
Finds the first element equal to the sample in the sorted array.

int  SearchFirst(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj::SearchFirst(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchFirst(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1041 Standard Library

SearchLast
Finds the last element equal to the model in sorted array.

int  SearchLast(
CObject*  element  // Sample
) const

Parameters
element
[in] The sample element to search in the array.

Return Value

The position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CArrayObj:: SearchLast(CObject*)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- sort array
array.Sort();
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete array;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(array.SearchLast(sample)!=-1) printf("Element found");
else printf("Element not found");
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1042 Standard Library

Save
Saves data array in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to previously opened by FileOpen (...) function binary file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CArrayObj::Save(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
int file_handle;
CArrayObj *array=new CArrayObj;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- add arrays elements
//--- . . .
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1043 Standard Library

Load
Loads data array from a file.s

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle to open earlier, with the function FileOpen (...), binary file.

Return Value

true - if successfully completed, false - if an error.

Note

When reading from the file array to create each element of the method is called CArrayObj::
CreateElement(int).

Example:

//--- example for CArrayObj::Load(int)


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
int file_handle;
CArrayObj *array=new CArrayObj;
//---
if(array!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!array.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete array;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}

© 2000-2010, MetaQuotes Software Corp.


1044 Standard Library

//--- use arrays elements


//--- . . .
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1045 Standard Library

Type
Gets the type identifier of the array.

virtual int  Type() const

Return Value

ID type of the array (for CArrayObj - 7778).

Example:

//--- example for CArrayObj::Type()


#include <Arrays\ArrayObj.mqh>
//---
void OnStart()
{
CArrayObj *array=new CArrayObj;
//---
if(array==NULL)
{
printf("Object create error");
return;
}
//--- get array type
int type=array.Type();
//--- delete array
delete array;
}

© 2000-2010, MetaQuotes Software Corp.


1046 Standard Library

CList
CList Class is a class of dynamic list of instances of the class CObject and his heirs.

Description

Class CList provides the ability to work with a list of instances of CObject and his heirs. In the class
implemented the ability to add / insert / delete items in the list, sort the list, search in sorted list. In
addition, the implemented methods of work with the file.

There are some subtleties of working with the class CList. The class has a mechanism to control
dynamic memory, so be careful when working with elements of the list.

Subtleties of the mechanism of memory management similar to those described in CArrayObj.

Declaration
class CList : public CObject

Title

#include <Arrays\List.mqh>

Class Methods

Attributes

FreeMode Gets the flag memory management when


deleting list items.

FreeMode Sets the flag memory management when


deleting items in the list

Total Gets the number of elements in the list

IsSorted Gets flag sorted list

SortMode Gets the version of the sorting

Create methods

CreateElement Creates a new item to the list

Add methods

Add Adds element to the end of the list

Insert Inserts element in the list in the specified


position

Delete methods

DetachCurrent Remove an item from the current position of


the list without deleting it "physically"

DeleteCurrent Removes the element from the current position

© 2000-2010, MetaQuotes Software Corp.


1047 Standard Library

in the list

DeleteAtIndex Removes the element from the specified


position in the list

Clear Removes all list items

Navigation

IndexOf Gets the index of the list item

GetFirstNode Gets the first element of the list

GetPrevNode Gets the previous element list

GetCurrentNode Gets the current list item

GetNextNode Gets the next item in the list

GetLastNode Gets the last item

Ordering methods

Sort Sort list

MoveToIndex Moves the current item list to the specified


position

Exchange Changes elements of the list seats

Compare methods

CompareList Compares the list with another list

Search methods

Search Searches for an element equal to the model in


sorted list

Input/output

Save Saves data in the file list

Load Loads data from file list

Type Gets the type identifier list

© 2000-2010, MetaQuotes Software Corp.


1048 Standard Library

FreeMode
Gets the flag memory management when deleting list items.

bool  FreeMode() const

Return Value

Flag of memory management.

Example:

//--- example for CList::FreeMode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- get free mode flag
bool list_free_mode=list.FreeMode();
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1049 Standard Library

FreeMode
Sets the flag memory management when deleting list items.

void  FreeMode(
bool  mode  // New value
)

Parameters
mode
[in] New value of the flag memory management.

Note

Setting the flag memory management - an important point in the use of class CList.Since the
elements of the list are pointers to dynamic objects, it is important to determine what to do with
them when you delete from the list.If the flag is set, then when you delete an item from the list, the
item is automatically deleted by the operator delete.If the flag is not set, it is assumed that a
pointer to the deleted object is still somewhere in the user program and will be relieved of it (the
program) then.

If the user resets the flag memory management, the user must understand their responsibility for
the removal of items in the list before completing the program, because otherwise, is not freed
memory occupied by the elements when they create new operator.When large amounts of data, it
could lead, eventually, even to break your terminal.

If the user does not reset the flag memory management, there is another "reef".Using pointers-list
items that are stored somewhere in the local variables, after removing the list, will lead to a critical
error and crashes the program user.By default, the memory management flag is set, ie the class
list, is responsible for freeing the memory elements.

Example:

//--- example for CList::FreeMode(bool)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- reset free mode flag
list.FreeMode(false);
//--- use list
//--- . . .
//--- delete list
delete list;

© 2000-2010, MetaQuotes Software Corp.


1050 Standard Library

© 2000-2010, MetaQuotes Software Corp.


1051 Standard Library

Total
Gets the number of elements in the list.

int  Total() const

Return Value

Number of elements in the list.

Example:

//--- example for CList::Total()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- check total
int total=list.Total();
//--- use list
//--- ...
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1052 Standard Library

IsSorted
Gets the flag sorted list.

bool  IsSorted(
int  mode=0  // Sorting mode
) const

Parameters
mode=0
[in] Tested version sorting

Return Value

Flag of the sorted list. If the list is sorted by the specified option? true, otherwise? false.

Note

Flag of the sorted list can not be changed directly. Flag set by Sort (int) and resets any methods to
add / insert.

Example:

//--- example for CList::IsSorted()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- check sorted
if(list.IsSorted(0))
{
//--- use methods for sorted list
//--- ...
}
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1053 Standard Library

SortMode
Gets the version of the sort.

int  SortMode() const

Return Value

Option sorting, or -1 if the list is not sorted.

Example:

//--- example for CList::SortMode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- check sort mode
int sort_mode=list.SortMode();
//--- use list
//--- ...
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1054 Standard Library

CreateElement
Creates a new item to the list.

bool  CreateElement()

Return Value

Pointer to the newly created element, if successful, NULL - if you can not create element.

Note

Method CreateElement () in class CList always returns NULL and does not perform any actions. If
necessary, in a derived class, method CreateElement () should be implemented.

Example:

//--- example for CList::CreateElement(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
int size=100;
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- fill list
for(int i=0;i<size;i++)
{
CObject *object=list.CreateElement();
if(object==NULL)
{
printf("Element create error");
delete list;
return;
}
list.Add(object);
}
//--- use list
//--- . . .
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1055 Standard Library

Add
Adds an element to the end of the list.

bool  Add(
CObject*  element  // Element to add
)

Parameters
element
[in] Value of the element to add to the list.

Return Value

true if successful, false - if you can not add an element.

Note

Element is not added to the list, if the parameter does not pass valid pointer (ie NULL).

Example:

//--- example for CList::Add(Cobject*)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add 100 elements
for(int i=0;i<100;i++)
{
if(!list.Add(new CObject))
{
printf("Element addition error");
delete list;
return;
}
}
//--- use list
//--- . . .
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1056 Standard Library

Insert
Inserts element in the list in the specified position.

bool  Insert(
CObject*  element,  // Element to insert
int  pos  // Position
)

Parameters
element
[in] value of the element to insert in the list

pos
[in] Position in the list to insert

Return Value

true if successful, false - if you can not insert the element.

Note

Element is not added to the list, if the parameter does not pass valid pointer (ie NULL).

Example:

//--- example for CList::Insert(CObject*,int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- insert 100 elements
for(int i=0;i<100;i++)
{
if(!list.Insert(new CObject,0))
{
printf("Element insert error");
delete list;
return;
}
}
//--- use list
//--- . . .
//--- delete list

© 2000-2010, MetaQuotes Software Corp.


1057 Standard Library

delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1058 Standard Library

DetachCurrent
Extracts an element from the current position without its "physical" deleteion.

CObject*  DetachCurrent()

Return Value

Pointer to the removal of elements in case of success, NULL - if you can not remove the element.

Note

When removed from the list, the item is not removed in any state of the flag memory management.
Pointer to withdraw from the list of ingredients of the release element after use.

Example:

//--- example for CList::DetachCurrent()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.DetachCurrent();
if(object==NULL)
{
printf("Detach error");
delete list;
return;
}
//--- use element
//--- . . .
//--- delete element
delete object;
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1059 Standard Library

DeleteCurrent
Removes the element from the current position in the list.

bool  DeleteCurrent()

Return Value

true if successful, false - if you can not remove the element.

Note

If enabled memory management, memory, removes the element is released.

Example:

//--- example for CList::DeleteCurrent()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
if(!list.DeleteCurrent())
{
printf("Delete error");
delete list;
return;
}
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1060 Standard Library

Delete
Removes the element from the given position in the list.

bool  Delete(
int  pos  // Position
)

Parameters
pos
[in] position removes the element in the list.

Return Value

true if successful, false - if you can not remove the element.

Note

If enabled memory management, memory, removes the element is released.

Example:

//--- example for CList::Delete(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
if(!list.Delete(0))
{
printf("Delete error");
delete list;
return;
}
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1061 Standard Library

Clear
Removes all elements of the list.

void  Clear()

Note

If enabled memory management, memory, deleted items are exempt.

Example:

//--- example for CList::Clear()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
//--- clear list
list.Clear();
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1062 Standard Library

IndexOf
Gets the index of the list item.

int  IndexOf(
CObject*  element  // Pointer to the element
)

Parameters
element
[in] Pointer to the list item.

Return Value

Index item in the list, or -1.

Example:

//--- example for CList::IndexOf(CObject*)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
CObject *object=new CObject;
if(object==NULL)
{
printf("Element create error");
delete list;
return;
}
if(list.Add(object))
{
int pos=list.IndexOf(object);
}
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1063 Standard Library

GetFirstNode
Gets the first element of the list.

CObject*  GetFirstNode()

Return Value

Pointer to the first item in case of success, NULL - if you can not get a pointer.

Example:

//--- example for CList::GetFirstNode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.GetFirstNode();
if(object==NULL)
{
printf("Get node error");
delete list;
return;
}
//--- use element
//--- . . .
//--- do not delete element
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1064 Standard Library

GetPrevNode
Gets the previous element of the list.

CObject*  GetPrevNode()

Return Value

Pointer to the previous element, if successful, NULL - if you can not get a pointer.

Example:

//--- example for CList::GetPrevNode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.GetPrevNode();
if(object==NULL)
{
printf("Get node error");
delete list;
return;
}
//--- use element
//--- . . .
//--- do not delete element
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1065 Standard Library

GetCurrentNode
Gets the current list item.

CObject*  GetCurrentNode()

Return Value

Pointer to the current item, if successful, NULL - if you can not get a pointer.

Example:

//--- example for CList::GetCurrentNode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.GetCurrentNode();
if(object==NULL)
{
printf("Get node error");
delete list;
return;
}
//--- use element
//--- . . .
//--- do not delete element
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1066 Standard Library

GetNextNode
Gets the next item in the list.

CObject*  GetNextNode()

Return Value

Pointer to the next item if successful, NULL - if you can not get a pointer.

Example:

//--- example for CList::GetNextNode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.GetNextNode();
if(object==NULL)
{
printf("Get node error");
delete list;
return;
}
//--- use element
//--- . . .
//--- do not delete element
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1067 Standard Library

GetLastNode
Gets the last element of the list.

CObject*  GetLastNode()

Return Value

Pointer to the last element in the case of success, NULL - if you can not get a pointer.

Example:

//--- example for CList::GetLastNode()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add list elements
//--- . . .
CObject *object=list.GetLastNode();
if(object==NULL)
{
printf("Get node error");
delete list;
return;
}
//--- use element
//--- . . .
//--- do not delete element
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1068 Standard Library

Sort
Sorts a list.

void  Sort(
int  mode  // Sorting mode
)

Parameters
mode
[in] Sorting mode.

Return Value

No.

Note

Sorting the list is always in ascending order.

Example:

//--- example for CList::Sort(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- sorting by mode 0
list.Sort(0);
//--- use list
//--- ...
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1069 Standard Library

MoveToIndex
Moves the current item list to the specified position.

bool  MoveToIndex(
int  pos  // Position
)

Parameters
pos
[in] Position in the list to move.

Return Value

true if successful, false - if you can not move the item.

Example:

//--- example for CList::MoveToIndex(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- move current node to begin
list.MoveToIndex(0);
//--- use list
//--- . . .
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1070 Standard Library

Exchange
Changes elements of the list seats.

bool  Exchange(
CObject*  node1,  // List item
CObject*  node2  // List item
)

Parameters
node1
[in] List item

node2
[in] List item

Return Value

true if successful, false - if you can not change the elements in some places.

Example:

//--- example for CList::Exchange(CObject*,CObject*)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- exchange
list.Exchange(list.GetFirstNode(),list.GetLastNode());
//--- use list
//--- . . .
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1071 Standard Library

CompareList
Compares the list with another list.

bool  CompareList(
CList*  list  // With whom we compare
)

Parameters
list
[in] A pointer to an instance of class CList-source elements for comparison.

Return Value

true if the lists are equal, false - if not.

Example:

//--- example for CList::CompareList(const CList*)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- create source list
CList *src=new CList;
if(src==NULL)
{
printf("Object create error");
delete list;
return;
}
//--- fill source list
//--- . . .
//--- compare with another list
bool result=list.CompareList(src);
//--- delete lists
delete src;
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1072 Standard Library

Search
Searches for an element equal to the model in the sorted list.

CObject*  Search(
CObject*  element  // Sample
)

Parameters
element
[in] Sample cell to search for in the list.

Return Value

Pointer to the found item if successful, NULL - if the item was not found.

Example:

//--- example for CList::Search(CObject*)


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- add lists elements
//--- . . .
//--- sort list
list.Sort(0);
//--- create sample
CObject *sample=new CObject;
if(sample==NULL)
{
printf("Sample create error");
delete list;
return;
}
//--- set sample attributes
//--- . . .
//--- search element
if(list.Search(sample)!=NULL) printf("Element found");
else printf("Element not found");
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1073 Standard Library

Save
Saves data in the file list.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the previously opened using the function FileOpen (...) file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CList::Save(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
int file_handle;
CList *list=new CList;
//---
if(list!=NULL)
{
printf("Object create error");
return;
}
//--- add lists elements
//--- . . .
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!list.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
delete list;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- delete list
delete list;

© 2000-2010, MetaQuotes Software Corp.


1074 Standard Library

© 2000-2010, MetaQuotes Software Corp.


1075 Standard Library

Load
Loads list data from a file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] Handle of the previously open, with the function FileOpen (...), binary

Return Value

true - if successfully completed, false - if an error.

Note

When reading from the file list items to create each element of the method is called CList::
CreateElement ().

Example:

//--- example for CLoad::Load(int)


#include <Arrays\List.mqh>
//---
void OnStart()
{
int file_handle;
CList *list=new CList;
//---
if(list!=NULL)
{
printf("Object create error");
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!list.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
delete list;
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}

© 2000-2010, MetaQuotes Software Corp.


1076 Standard Library

//--- use list elements


//--- . . .
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1077 Standard Library

Type
Gets the type identifier list.

virtual int  Type()

Return Value

Type identifier list (for CList - 7779).

Example:

//--- example for CList::Type()


#include <Arrays\List.mqh>
//---
void OnStart()
{
CList *list=new CList;
//---
if(list==NULL)
{
printf("Object create error");
return;
}
//--- get list type
int type=list.Type();
//--- delete list
delete list;
}

© 2000-2010, MetaQuotes Software Corp.


1078 Standard Library

Graphic Objects
This section contains the technical details of working with classes of graphical objects and a
description of the relevant components of the standard library MQL5.

The use of classes of graphical objects, will save time when creating custom programs (scripts,
expert).

Standard library MQL5 (in terms of graphical objects) is placed in the working directory of the
terminal in the folder Include \ ChartObjects.

Class/Group Description

Base class for graphical object CChartObject Base class of a graphic object

Lines Group classes "Lines"

Channels Group classes "Channels"

Gann Tools Group classes "Gann"

Fibonacci Tools Group classes "Fibonacci"

Elliott Tools Group classes "Elliott"

Shapes Group classes "Shapes"

Arrows Group classes "Arrows"

Controls Group classes "Controls"

© 2000-2010, MetaQuotes Software Corp.


1079 Standard Library

CChartObject
CChartObject is a base class of graphic objects of chart type of the Standard MQL5 library.

Description

Class CChartObject provides the simplified access for all of its descendants to MQL5 API functions.

Declaration
class CChartObject : public CObject

Title
#include <ChartObjects\ChartObject.mqh>

Class Methods

Attributes

ChartId Gets the ID chart, who owns a graphic

Window Gets the number of windows in which the chart


is a graphic

Name Gets/sets the name of a graphic object

NumPoints Gets the number of anchor points

Assign

Attach Binds a graphic chart

SetPoint Sets the anchor point

Delete

Delete Deletes a graphic chart

Detach Untie a graphic chart

Shift

ShiftObject The relative movement of the object

ShiftPoint The relative movement of the object point

Object properties

Time Gets/sets the time coordinates of the object


point

Price Gets/sets the price coordinate of a point object

Color Gets/sets the color of the object

Style Gets/sets the line style object

Width Gets/sets the width of the line object

© 2000-2010, MetaQuotes Software Corp.


1080 Standard Library

BackGround Gets/sets the flag drawing object background

Selected Gets/sets the flag sit on an object

Selectable Gets/sets the flag selectable object

Description Gets/sets the text of the object

Timeframes Gets/sets the mask of flags visibility of the


object

CreateTime Gets the time object creation

Levels properties of the object

LevelsCount Gets/sets the number of levels of object

LevelColor Gets/sets the color of the line level

LevelStyle Gets/sets the line style level

LevelWidth Gets/sets the width of the line level

LevelValue Gets/sets the level

LevelDescription Gets/sets the text level

Access to MQL5 API functions

GetInteger Gets the value of the object properties

SetInteger Sets the object properties

GetDouble Gets the value of the object properties

SetDouble Sets the object properties

GetString Gets the value of the object properties

SetString Sets the object properties

Input/Output

Save Virtual method entry in the file

Load Virtual method of reading from a file

Type Virtual method of identification

© 2000-2010, MetaQuotes Software Corp.


1081 Standard Library

ChartId
Gets the ID chart, who owns a graphic object.

long  ChartId() const

Return Value

Id chart on which the graphic object. If object not found, it returns -1.

Example:

//--- example for CChartObject::ChartId


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get chart idintifier of chart object
long chatr_id=object.ChartId();
}

© 2000-2010, MetaQuotes Software Corp.


1082 Standard Library

Window
Gets the number of windows in which the chart is a graphic object.

int  Window() const

Return Value

Number of windows in which the chart is a graphic object (0 - main window). If object not found, it
returns -1.

Example:

//--- example for CChartObject::Window


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get window of chart object
int window=object.Window();
}

© 2000-2010, MetaQuotes Software Corp.


1083 Standard Library

Name (Get Method)


Gets the name of the graphic object.

string  Name() const

Return Value

Name of the graphic object tied to an instance of the class. If object not found, returns NULL.

Name (Set Method)


Sets the name of the graphic object.

bool  Name(
string  name  // new name
)

Parameters
name
[in] The new name of the graphic object.

Return Value

true if successful, false - if you can not change the name.

Example:

//--- example for CChartObject::Name


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get name of chart object
string object_name=object.Name();
if(object_name!="MyChartObject")
{
//--- set name of chart object
object.Name("MyChartObject");
}
}

© 2000-2010, MetaQuotes Software Corp.


1084 Standard Library

NumPoints
Gets the number of anchor points of a graphic object.

int  NumPoints() const

Return Value

Number of points linking a graphic object that is bound to an instance of the class. If not bound
object, it returns 0.

Example:

//--- example for CChartObject::NumPoints


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get points count of chart object
int points=object.NumPoints();
}

© 2000-2010, MetaQuotes Software Corp.


1085 Standard Library

Attach
Binds a graphical object to an instance of the class.

bool  Attach(
long  chart_id,  // Chart ID
string  name,  // Name of the object
int  window,  // Chart window
int  points  // Number of points
)

Parameters
chart_id
[out] Chart identifier.

name
[in] Name of the graphic object.

window
[in] Chart window number (0 – main window).

points
[in] Number of points anchor graphic object.

Return Value

true - if successful, false - if you can not bind object.

Example:

//--- example for CChartObject::Attach


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- attach chart object
if(!object.Attach(ChartID(),"MyObject",0,2))
{
printf("Object attach error");
return;
}
}

© 2000-2010, MetaQuotes Software Corp.


1086 Standard Library

SetPoint
Sets the new coordinates of this anchor point graphic object.

bool  SetPoint(
int  point,  // Point number
datetime  new_time,  // Time coordinate
double  new_price  // Price coordinate
)

Parameters
point
[in] Number anchor point graphic object.

new_time
[in] The new value of the coordinates of this point of time bindings.

new_price
[in] New value coordinates of the price specified anchor point.

Return Value

true - if successful, false - if you can not change the coordinates of the point.

Example:

//--- example for CChartObject::SetPoint


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
double price;
//---
if(object.NumPoints()>0)
{
//--- set point of chart object
object.SetPoint(0,CurrTime(),price);
}
}

© 2000-2010, MetaQuotes Software Corp.


1087 Standard Library

Delete
Removes a graphical object with the attached chart.

bool  Delete()

Return Value

true - if successful, false - if you can not remove the object.

Example:

//--- example for CChartObject::Delete


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- detach chart object
if(!object.Delete())
{
printf("Object delete error");
return;
}
}

© 2000-2010, MetaQuotes Software Corp.


1088 Standard Library

Detach
Untie graphic object.

bool  Detach()

Return Value

true - if successful, false - if you can not decouple the object.

Example:

//--- example for CChartObject::Detach


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- detach chart object
if(!object.Detach())
{
printf("Object detach error");
return;
}
}

© 2000-2010, MetaQuotes Software Corp.


1089 Standard Library

ShiftObject
Moves a graphic object.

bool  ShiftObject(
datetime  d_time,  // Increment of time coordinate
double  d_price  // Increment of price coordinate
)

Parameters
d_time
[in] Increment the coordinates of all points of time bindings

d_price
[in] Increment the coordinates of the prices of all waypoints.

Return Value

true - if successful, false - if you can not move the object.

Example:

//--- example for CChartObject::ShiftObject


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
datetime d_time;
double d_price;
//--- shift chart object
object.ShiftObject(d_time,d_price);
}

© 2000-2010, MetaQuotes Software Corp.


1090 Standard Library

ShiftPoint
Moves a specified point anchor graphic.

bool  ShiftPoint(
int  point,  // Point number
datetime  d_time,  // Increment of time coordinate
double  d_price  // Increment of price coordinate
)

Parameters
point
[in] Number anchor point graphic object.

d_time
[in] Increment the coordinates of time specified anchor point.

d_price
[in] Increment the coordinates of the price specified anchor point.

Return Value

true - if successful, false - if you can not move the point.

Example:

//--- example for CChartObject::ShiftPoint


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
datetime d_time;
double d_price;
//---
if(object.NumPoints()>0)
{
//--- shift point of chart object
object.ShiftPoint(0,d_time,d_price);
}
}

© 2000-2010, MetaQuotes Software Corp.


1091 Standard Library

Time (Get Method)


The coordinates of time specified anchor point graphic object.

datetime  Time(
int  point  // Point number
) const

Parameters
point
[in] Number anchor point graphic object.

Return Value

Coordinates of time specified anchor point graphic object that is bound to an instance of the class.
If not bound object or the object is not this point, it returns 0.

Time (Set Method)


Sets the coordinate of time specified anchor point graphic object.

bool  Time(
int  point,  // Point number
datetime  new_time  // Time
)

Parameters
point
[in] Number anchor point graphic object.

new_time
[in] The new value of the coordinates of this point of time anchor graphic object.

Return Value

true - if successful, false - if you can not change the coordinate of time.

Example:

//--- example for CChartObject::Time


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.NumPoints();i++)
{
//--- get time of point chart object
datetime point_time=object.Time(i);
if(point_time==0)

© 2000-2010, MetaQuotes Software Corp.


1092 Standard Library

{
//--- set time of point chart object
object.Time(i,TimeCurrent());
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1093 Standard Library

Price (Get Method)


Gets the coordinate of the price specified anchor point graphic object.

double  Price(
int  point  // Point number
) const

Parameters
point
[in] Number anchor point graphic object.

Return Value

Coordinate prices specified anchor point graphic object that is bound to an instance of the class. If
not bound object or the object is not this point, it returns EMPTY_VALUE.

Price (Set Method)


Sets the coordinate of the price specified anchor point graphic object.

bool  Price(
int  point,  // Point number
double  new_price  // Price
)

Parameters
point
[in] Number anchor point graphic object.

new_price
[in] News value coordinates of the price specified anchor point graphic object.

Return Value

true - if successful, false - if you can not change the coordinate prices.

Example:

//--- example for CChartObject::Price


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
double price;
//---
for(int i=0;i<object.NumPoints();i++)
{
//--- get price of point chart object
double point_price=object.Price(i);

© 2000-2010, MetaQuotes Software Corp.


1094 Standard Library

if(point_price!=price)
{
//--- set price of point chart object
object.Price(i,price);
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1095 Standard Library

Color (Get Method)


Gets the line color of the graphic object.

color  Color() const

Return Value

Color line of graphic object, assigned to the class instance. If there is no object assigned, it returns
CLR_NONE.

Color (Set Method)


Sets the color of the line for the graphic object.

bool  Color(
color  new_color  // New color
)

Parameters
new_color
[in] New value line color graphic object.

Return Value

true - if successful, false - if you can not change the color.

Example:

//--- example for CChartObject::Color


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get color of chart object
color object_color=object.Color();
if(object_color!=Red)
{
//--- set color of chart object
object.Color(Red);
}
}

© 2000-2010, MetaQuotes Software Corp.


1096 Standard Library

Style (Get Method)


Gets the line style graphic.

ENUM_LINE_STYLE  Style() const

Return Value

Style line of the graphic object, assigned to the class instance. If there is no object assigned, it
returns WRONG_VALUE.

Style (Set Method)


Sets the line style graphic.

bool  Style(
ENUM_LINE_STYLE  new_style  // Style
)

Parameters
new_style
[in] New value-style line drawing object.

Return Value

true - if successful, false - if you can not change the style.

Example:

//--- example for CChartObject::Style


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get style of chart object
ENUM_LINE_STYLE style=object.Style();
if(style!=STYLE_SOLID)
{
//--- set style of chart object
object.Style(STYLE_SOLID);
}
}

© 2000-2010, MetaQuotes Software Corp.


1097 Standard Library

Width (Get Method)


Gets the thickness of the line graphic object.

int  Width() const

Return Value

The thickness of the line graphic object that is bound to an instance of the class. If not bound
object, it returns -1.

Width (Set Method)


Sets the thickness of the line graphic object.

bool  Width(
int  new_width  // Thickness
)

Parameters
new_width
[in] The new value of the thickness of the line graphic object.

Return Value

true - if successful, false - if you can not change the thickness.

Example:

//--- example for CChartObject::Width


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get width of chart object
int width=object.Width();
if(width!=1)
{
//--- set width of chart object
object.Width(1);
}
}

© 2000-2010, MetaQuotes Software Corp.


1098 Standard Library

Background (Get Method)


Gets the flag drawing a graphic object in the background.

bool  Background() const

Return Value

Flag of drawing in the background, a graphic object that is bound to an instance of the class. If not
bound object returns false.

Background (Set Method)


Sets the flag drawing a graphic object in the background.

bool  Background(
bool  background  // Value of the flag
)

Parameters
background
[in] New value of the flag drawing a graphic object in the background.

Return Value

true - if successful, false - if you can not change the flag.

Example:

//--- example for CChartObject::Background


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get background flag of chart object
bool background_flag=object.Background();
if(!background_flag)
{
//--- set background flag of chart object
object.Background(true);
}
}

© 2000-2010, MetaQuotes Software Corp.


1099 Standard Library

Selected (Get Method)


Gets the flag "reprimand" graphic object.

bool  Selected() const

Return Value

Flag "slate", a graphic object that is bound to an instance of the class. If not bound object returns
false.

Selected (Set Method)


Sets the flag "reprimand" graphic object.

bool  Selected(
bool  selected  // Value of the flag
)

Parameters
selected
[in] New value of the flag "reprimand" graphic object.

Return Value

true - if successful, false - if you can not change the flag.

Example:

//--- example for CChartObject::Selected


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get selected flag of chart object
bool selected_flag=object.Selected();
if(selected_flag)
{
//--- set selected flag of chart object
object.Selected(false);
}
}

© 2000-2010, MetaQuotes Software Corp.


1100 Standard Library

Selectable (Get Method)


Gets the flag "selectable" graphic object.

bool  Selectable() const

Return Value

Flag "selectable", a graphic object that is bound to an instance of the class. If not bound object
returns false.

Selectable (Set Method)


Sets the flag "selectable" graphic object.

bool  Selectable(
bool  selectable  // Value of the flag
)

Parameters
selectable
[in] New value of the flag "selectable" graphic object.

Return Value

true - if successful, false - if you can not change the flag.

Example:

//--- example for CChartObject::Selectable


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get selectable flag of chart object
bool selectable_flag=object.Selectable();
if(selectable_flag)
{
//--- set selectable flag of chart object
object.Selectable(false);
}
}

© 2000-2010, MetaQuotes Software Corp.


1101 Standard Library

Description (Get Method)


Gets a description (text) graphic object.

string  Description() const

Return Value

Description (text) graphic object that is bound to an instance of the class. If no bound object, it
returns NULL.

Description (Set Method)


Sets the description (text) graphic object.

bool  Description(
string  text  // Text
)

Parameters
text
[in] New value descriptions (text) graphic object.

Return Value

true - if successful, false - if you can not change the description (text).

Example:

//--- example for CChartObject::Description


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get description of chart object
string description=object.Description();
if(description=="")
{
//--- set description of chart object
object.Description("MyObject");
}
}

© 2000-2010, MetaQuotes Software Corp.


1102 Standard Library

Timeframes (Get Method)


Gets the visibility flag graphic object.

int  Timeframes() const

Return Value

Flags visibility graphic object that is bound to an instance of the class. If not bound object, it
returns 0.

Timeframes (Set Method)


Sets the visibility flag graphic.

bool  Timeframes(
int  new_timeframes  // Visibility flags
)

Parameters
new_timeframes
[in] New flags visibility graphic object.

Return Value

true - if successful, false - if you can not change the flags of visibility.

Example:

//--- example for CChartObject::Timeframes


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get timeframes of chart object
int timeframes=object.Timeframes();
if(!(timeframes&OBJ_PERIOD_H1))
{
//--- set timeframes of chart object
object.Timeframes(timeframes|OBJ_PERIOD_H1);
}
}

© 2000-2010, MetaQuotes Software Corp.


1103 Standard Library

CreateTime
Gets the time to create graphical object.

datetime  CreateTime() const

Return Value

Time to create graphical object that is bound to an instance of the class. If not bound object, it
returns 0.

Example:

//--- example for CChartObject::CreateTime


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get create time of chart object
datetime create_time=object.CreateTime();
}

© 2000-2010, MetaQuotes Software Corp.


1104 Standard Library

LevelsCount (Get Method)


Gets the number of levels of graphical object.

int  LevelsCount() const

Return Value

Number of levels of graphical object that is bound to an instance of the class. If not bound object, it
returns 0.

LevelsCount (Set Method)


Sets the number of levels of graphical object.

bool  LevelsCount(
int  levels  // Number of levels
)

Parameters
levels
[in] the number of new levels of graphic object.

Return Value

true - if successful, false - if you can not change the number of levels.

Example:

//--- example for CChartObject::LevelsCount


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get levels count of chart object
int levels_count=object.LevelsCount();
//--- set levels count of chart object
object.LevelsCount(levels_count+1);
}

© 2000-2010, MetaQuotes Software Corp.


1105 Standard Library

LevelColor (Get Method)


Gets the line color specified level of graphic object.

color  LevelColor(
int  level  // Level number
) const

Parameters
level
[in] Number of levels of graphical object.

Return Value

Color Line level specified graphic object that is bound to an instance of the class. If not bound
object or the object is no specified level, it returns CLR_NONE.

LevelColor (Set Method)


Sets the line color specified level of graphic object.

bool  LevelColor(
int  level,  // Level number
color  new_color  // New color
)

Parameters
level
[in] Number of levels of graphical object.

new_color
[in] New value line color of the level of graphic object.

Return Value

true - if successful, false - if you can not change the color.

Example:

//--- example for CChartObject::LevelColor


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get level color of chart object
color level_color=object.LevelColor(i);
if(level_color!=Red)

© 2000-2010, MetaQuotes Software Corp.


1106 Standard Library

{
//--- set level color of chart object
object.LevelColor(i,Red);
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1107 Standard Library

LevelStyle (Get Method)


Gets the line style specified level of graphical object.

ENUM_LINE_STYLE  LevelStyle(
int  level  // Level number
) const

Parameters
level
[in] Number of levels of graphical object.

Return Value

Line style specified level graphical object that is bound to an instance of the class. If not bound
object or the object is no specified level of returns WRONG_VALUE.

LevelStyle (Set Method)


Sets the line style specified level of graphical object.

int  LevelStyle(
int  level,  // Level number
ENUM_LINE_STYLE  style  // Line Style
)

Parameters
level
[in] Number of levels of graphical object.

style
[in] New value-style line level specified graphical object.

Return Value

true - if successful, false - if you can not change the style.

Example:

//--- example for CChartObject::LevelStyle


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get level style of chart object
ENUM_LINE_STYLE level_style=object.LevelStyle(i);
if(level_style!=STYLE_SOLID)

© 2000-2010, MetaQuotes Software Corp.


1108 Standard Library

{
//--- set level style of chart object
object.LevelStyle(i,STYLE_SOLID);
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1109 Standard Library

LevelWidth (Get Method)


Gets the line thickness specified level of graphic object.

int  LevelWidth(
int  level  // Level number
) const

Parameters
level
[in] Number of levels of graphical object.

Return Value

The thickness of the lines of the level of graphical object that is bound to an instance of the class.
If not bound object or the object is no specified level, it returns -1.

LevelWidth (Set Method)


Finds the last element equal to the model in sorted array.

bool  LevelWidth(
int  level,  // Level number
int  new_width  // New width
)

Parameters
level
[in] Number of levels of graphical object.

new_width
[in] New value line thickness specified level graphical object.

Return Value

position of the found element, if successful, -1 - if the item was not found.

Example:

//--- example for CChartObject::LevelWidth


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get level width of chart object
int level_width=object.LevelWidth(i);
if(level_width!=1)

© 2000-2010, MetaQuotes Software Corp.


1110 Standard Library

{
//--- set level width of chart object
object.LevelWidth(i,1);
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1111 Standard Library

LevelValue (Get Method)


Gets the value of the level of graphic object.

double  LevelValue(
int  level  // Level number
) const

Parameters
level
[in] Number of levels of graphical object.

Return Value

The value of this level of graphical object that is bound to an instance of the class. If not bound
object or the object is no level specified, returns EMPTY_VALUE.

LevelValue (Set Method)


Sets the value of the specified level of graphic object.

bool  LevelValue(
int  level,  // Level number
double  new_value  // New value
)

Parameters
level
[in] Number of levels of graphical object.

new_value
[in] New value of the level of graphic object.

Return Value

true - if successful, false - if you can not change the level.

Example:

//--- example for CChartObject::LevelValue


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get level value of chart object
double level_value=object.LevelValue(i);
if(level_value!=0.1*i)

© 2000-2010, MetaQuotes Software Corp.


1112 Standard Library

{
//--- set level value of chart object
object.LevelValue(i,0.1*i);
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1113 Standard Library

LevelDescription (Get Method)


Gets a description (text) of the level of graphical object.

string  LevelDescription(
int  level   // Level number
) const

Parameters
level
[in] Number of levels of graphical object.

Return Value

Description (text) of the level of graphical object that is bound to an instance of the class. If not
bound object or the object is no specified level, returns NULL.

LevelDescription (Set Method)


Sets the description (text) of the level of graphical object.

bool  LevelDescription(
int  level ,  // Level number
string  text  // Text
)

Parameters
level
[in] Number of level of graphical object.

text
[in] New value of description (text) of the level of graphic object.

Return Value

true – if successful, false - if you can not change the description (text).

Example:

//--- example for CChartObject::LevelDescription


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get level description of chart object
string level_description=object.LevelDescription(i);
if(level_description=="")

© 2000-2010, MetaQuotes Software Corp.


1114 Standard Library

{
//--- set level description of chart object
object.LevelDescription(i,"Level_"+IntegerToString(i));
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1115 Standard Library

GetInteger
Provides simplified access to the functions of API MQL5 ObjectGetInteger() for integer-value
properties (of type bool, char, uchar, short, ushort, int, uint, ling, ulong, datetime, color) bound to an
instance of the class graphic.There are two versions of a function call:

Getting a property value without checking the correctness

long  GetInteger(
ENUM_OBJECT_PROPERTY_INTEGER  prop_id,  // Identifier of integer-property
int  modifier=-1  // Modifier
) const

Parameters
prop_id
[in] ID of double-graphic properties.

modifier=-1
[in] Modifier (index) double-features.

Return Value

If successfull, it returns the value of integer-type property, if error, it returns 0.

Getting a property value in verifying the correctness of such treatment

bool  GetInteger(
ENUM_OBJECT_PROPERTY_INTEGER  prop_id,  // Identifier of integer-property
int  modifier,  // Modifier
long&  value  // Link to variable
) const

Parameters
prop_id
[in] ID integer-graphic properties of the object.

modifier
[in] Modifier (index) integer-property.

value
[out] Reference to a variable to accommodate the integer-value properties.

Return Value

true - if successful, false - if you can not get integer-property.

Example:

//--- example for CChartObject::GetInteger


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()

© 2000-2010, MetaQuotes Software Corp.


1116 Standard Library

{
CChartObject object;
//--- get color of chart object by easy method
printf("Objects color is %s",ColorToString(object.GetInteger(OBJPROP_COLOR),true));
//--- get color of chart object by classic method
long color_value;
if(!object.GetInteger(OBJPROP_COLOR,0,color_value))
{
printf("Get integer property error %d",GetLastError());
return;
}
else
printf("Objects color is %s",color_value);
for(int i=0;i<object.LevelsCount();i++)
{
//--- get levels width by easy method
printf("Level %d width is %d",i,object.GetInteger(OBJPROP_LEVELWIDTH,i));
//--- get levels width by classic method
long width_value;
if(!object.GetInteger(OBJPROP_LEVELWIDTH,i,width_value))
{
printf("Get integer property error %d",GetLastError());
return;
}
else
printf("Level %d width is %d",i,width_value);
}
}

© 2000-2010, MetaQuotes Software Corp.


1117 Standard Library

SetInteger
Provides simplified access to the functions of API MQL5 ObjectSetInteger() to change the integer-
properties (with types bool, char, uchar, short, ushort, int, uint, ling, ulong, datetime, color) bound to
an instance of the class graphic.There are two versions of a function call:

Setting a property value that does not require a modifier

bool  SetInteger(
ENUM_OBJECT_PROPERTY_INTEGER   prop_id,  // Identifier of integer-property
long  value  // Value
)

Parameters
prop_id
[in] ID integer-graphic properties of the object.

value
[in] new mutable integer-value properties.

Setting a property value indicating the modifier

bool  SetInteger(
ENUM_OBJECT_PROPERTY_INTEGER   prop_id,  // Identifier of integer-property
int  modifier,  // Modifier
long  value  // Value
)

Parameters
prop_id
[in] ID integer-graphic properties of the object.

modifier
[in] Modifier (index) integer-property.

value
[in] new mutable integer-value properties.

Return Value

true - if successful, false - if you can not change the integer-property.

Example:

//--- example for CChartObject::SetInteger


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- set new color of chart object

© 2000-2010, MetaQuotes Software Corp.


1118 Standard Library

if(!object.SetInteger(OBJPROP_COLOR,Red))
{
printf("Set integer property error %d",GetLastError());
return;
}
for(int i=0;i<object.LevelsCount();i++)
{
//--- set levels width
if(!object.SetInteger(OBJPROP_LEVELWIDTH,i,i))
{
printf("Set integer property error %d",GetLastError());
return;
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1119 Standard Library

GetDouble
Provides simplified access to the functions of API MQL5 ObjectGetDouble() to get the values double-
properties (having type float and double) of the graphic object, assigned to the class instance. There
are two versions of a function call:

Getting a property value without checking the correctness

double  GetDouble(
ENUM_OBJECT_PROPERTY_DOUBLE  prop_id,  // Identifier of double-property
int  modifier=-1  // Modifier
) const

Parameters
prop_id
[in] ID of double-graphic properties.

modifier=-1
[in] Modifier (index) double-features.

Return Value

If successful, it returns the value of property of double type, if error, it returns EMPTY_VALUE.

Getting a property value in verifying the correctness of such treatment

bool  GetDouble(
ENUM_OBJECT_PROPERTY_DOUBLE  prop_id,  // Identifier of double-property
int  modifier,  // Modifier
double&  value  // Link to variable
) const

Parameters
prop_id
[in] ID of double-graphic properties.

modifier
[in] Modifier (index) double-features.

value
[out] Reference to a variable to accommodate the double-value properties.

Return Value

true - if successful, false - if you can not get a double-feature.

Example:

//--- example for CChartObject::GetDouble


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()

© 2000-2010, MetaQuotes Software Corp.


1120 Standard Library

{
CChartObject object;
//---
for(int i=0;i<object.LevelsCount();i++)
{
//--- get levels value by easy method
printf("Level %d value=%f",i,object.GetDouble(OBJPROP_LEVELVALUE,i));
//--- get levels value by classic method
double value;
if(!object.SetDouble(OBJPROP_LEVELVALUE,i,value))
{
printf("Get double property error %d",GetLastError());
return;
}
else
printf("Level %d value=%f",i,value);
}
}

© 2000-2010, MetaQuotes Software Corp.


1121 Standard Library

SetDouble
Provides simplified access to the functions of API MQL5 ObjectSetDouble() to change the double-
properties (having type float and double) bound to an instance of the class graphic object. There are
two versions of a function call:

Setting a property value that does not require a modifier

bool  SetDouble(
ENUM_OBJECT_PROPERTY_DOUBLE   prop_id,  // Identifier of double-property
double  value  // Value
)

Parameters
prop_id
[in] ID of double-graphic properties.

value
[in] New value mutable double-features.

Setting a property value indicating the modifier

bool  SetDouble(
ENUM_OBJECT_PROPERTY_DOUBLE   prop_id,  // Identifier of double-property
int  modifier,  // Modifier
double  value  // Value
)

Parameters
prop_id
[in] ID of double-graphic properties.

modifier
[in] Modifier (index) of double-property.

value
[in] New value mutable double-property.

Return Value

true - if successful, false - if you can not change the double-feature.

Example:

//--- example for CChartObject::SetDouble


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//---

© 2000-2010, MetaQuotes Software Corp.


1122 Standard Library

for(int i=0;i<object.LevelsCount();i++)
{
//--- set level value of chart object
if(!object.SetDouble(OBJPROP_LEVELVALUE,i,0.1*i))
{
printf("Set double property error %d",GetLastError());
return;
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1123 Standard Library

GetString
Provides simplified access to the functions of API MQL5 ObjectGetString() for string-value properties,
is bound to an instance of the class graphic object. There are two versions of a function call:

Getting a property value without checking the correctness

string  GetString(
ENUM_OBJECT_PROPERTY_STRING  prop_id,  // Identifier of string-property
int  modifier=-1  // Modifier
) const

Parameters
prop_id
[in] Identifier string-properties of graphic object.

modifier=-1
[in] Modifier (index) string-properties.

Return Value

Value of string-property.

Getting a property value in verifying the correctness of such treatment

bool  GetString(
ENUM_OBJECT_PROPERTY_STRING  prop_id,  // Identifier of string-property
int  modifier,  // Modifier
string&  value  // Link to variable
) const

Parameters
prop_id
[in] Identifier string-properties of graphic object.

modifier
[in] Modifier (index) string-properties.

value
[out] Reference to a variable to accommodate the string-value properties.

Return Value

true - if successful, false - if you can not get a string-property.

Example:

//--- example for CChartObject::GetString


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{

© 2000-2010, MetaQuotes Software Corp.


1124 Standard Library

CChartObject object;
string value;
//--- get name of chart object by easy method
printf("Object name is '%s'",object.GetString(OBJPROP_NAME));
//--- get name of chart object by classic method
if(!object.GetString(OBJPROP_NAME,0,value))
{
printf("Get string property error %d",GetLastError());
return;
}
else
printf("Object name is '%s'",value);
for(int i=0;i<object.LevelsCount();i++)
{
//--- get levels description by easy method
printf("Level %d description is '%s'",i,object.GetString(OBJPROP_LEVELTEXT,i));
//--- get levels description by classic method
if(!object.GetString(OBJPROP_LEVELTEXT,i,value))
{
printf("Get string property error %d",GetLastError());
return;
}
else
printf("Level %d description is '%s'",i,value);
}
}

© 2000-2010, MetaQuotes Software Corp.


1125 Standard Library

SetString
Provides simplified access to the functions of API MQL5 ObjectSetString() to change the properties of
string-tied to the instance of the class graphic object. There are two versions of a function call:

Setting a property value that does not require a modifier

bool  SetString(
ENUM_OBJECT_PROPERTY_STRING   prop_id,  // Identifier of string-property
string  value  // Value
)

Parameters
prop_id
[in] Identifier string-properties of graphic object.

value
[in] New value mutable string-properties.

Setting a property value indicating the modifier

bool  SetString(
ENUM_OBJECT_PROPERTY_STRING   prop_id,  // Identifier of string-property
int  modifier,  // Modifier
string  value  // Value
)

Parameters
prop_id
[in] Identifier string-properties of graphic object.

modifier
[in] Modifier (index) string-properties.

value
[in] New value mutable string-properties.

Return Value

true - if successful, false - if you can not change the string-property.

Example:

//--- example for CChartObject::SetString


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- set new name of chart object
if(!object.SetString(OBJPROP_NAME,"MyObject"))

© 2000-2010, MetaQuotes Software Corp.


1126 Standard Library

{
printf("Set string property error %d",GetLastError());
return;
}
for(int i=0;i<object.LevelsCount();i++)
{
//--- set levels description
if(!object.SetString(OBJPROP_LEVELTEXT,i,"Level_"+IntegerToString(i)))
{
printf("Set string property error %d",GetLastError());
return;
}
}
}

© 2000-2010, MetaQuotes Software Corp.


1127 Standard Library

Save
Saves parameters of the object in the file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the previously opened using the function FileOpen (...) file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CChartObject::Save


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
int file_handle;
CChartObject object=new CChartObject;
//--- set object parameters
//--- . . .
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!object.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
}

© 2000-2010, MetaQuotes Software Corp.


1128 Standard Library

Load
Loads the parameters of the object from the file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the previously opened using the function FileOpen (...) file.

Return Value

true - if successfully completed, false - if an error.

Example:

//--- example for CChartObject::Load


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
int file_handle;
CChartObject object;
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!object.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use object
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1129 Standard Library

Type
Gets the type identifier graphic object.

virtual int  Type() const

Return Value

ID type of object (for CChartObject - 0x8888).

Example:

//--- example for CChartObject::Type


#include <ChartObjects\ChartObject.mqh>
//---
void OnStart()
{
CChartObject object;
//--- get object type
int type=object.Type();
}

© 2000-2010, MetaQuotes Software Corp.


1130 Standard Library

Objects Lines
A group of graphic objects "Lines".

This section contains the technical details of working with a group of classes of graphical objects
"Lines" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectVLine Graphic object "Vertical Line"

CChartObjectHLine Graphic object "Horizontal Line"

CChartObjectTrend Graphic object "Trend Line"

CChartObjectTrendByAngle Graphic object "Trend Line by Angle"

CChartObjectCycles Graphic object "Cyclic Lines"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1131 Standard Library

CChartObjectVLine
Class CChartObjectVLine is a class for simplified access to "Vertical Line" graphic object properties.

Description

Class CChartObjectVLine provides access to "Vertical Line" object properties.

Declaration
class CChartObjectVLine : public CChartObject

Title
<ChartObjects\ChartObjectsLines.mqh>

Class Methods

Create

Create Creates graphic object "Vertical Line"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1132 Standard Library

Create
Creates graphic object "Vertical Line".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time  // Time coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time
[in] Time coordinate of the anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1133 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_VLINE for CChartObjectVline).

© 2000-2010, MetaQuotes Software Corp.


1134 Standard Library

CChartObjectHLine
Class CChartObjectHLine is a class for simplified access to "Horizontal Line" graphic object
properties.

Description

Class CChartObjectHLine provides access to "Horizonal Line" object properties.

Declaration
class CChartObjectHLine : public CChartObject

Title
<ChartObjects\ChartObjectsLines.mqh>

Class Methods

Create

Create Creates graphic object "Horizontal Line"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1135 Standard Library

Create
Creates graphic object "Horizontal Line".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
double  price  // Price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

price
[in] Price coordinate of the anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1136 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_HLINE for CChartObjectHLine).

© 2000-2010, MetaQuotes Software Corp.


1137 Standard Library

CChartObjectTrend
Class CChartObjectTrend is a class for simplified access to "Trend Line" graphic object properties.

Description

Class CChartObjectTrend provides access to "Trend Line" object properties.

Declaration
class CChartObjectTrend : public CChartObject

Title
<ChartObjects\ChartObjectsLines.mqh>

Class Methods

Create

Create Creates graphic object "Trend Line"

Properties

RayLeft Gets/Sets property "Ray Left"

RayRight Gets/Sets property "Ray Right"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1138 Standard Library

Create
Creates graphic object "Trend Line".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // 1st time coordinate
double  price1,  // 1st price coordinate
datetime  time2,  // 2nd time coordinate
double  price2  // 2nd price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1139 Standard Library

RayLeft (Get Method)


Gets the value of "Ray Left" property.

bool  RayLeft() const

Returned value

The value of "Ray Left" property, assigned to the class instance. If there is no object assigned, it
returns false.

RayLeft (Set Method)


Sets new flag value for the "Ray Left" property.

bool  RayLeft(
bool  ray  // flag
)

Parameters
ray
[in] New value of the "Ray Left" property.

Returned value

true if successful, false if flag hasn't changed error.

© 2000-2010, MetaQuotes Software Corp.


1140 Standard Library

RayRight (Get Method)


Gets the value of "Ray Right" property.

bool  RayRight() const

Returned value

The value of "Ray Right" property, assigned to the class instance. If there is no object assigned, it
returns false.

RayRight (Set Method)


Sets new flag value for the "Ray Right" property.

bool  RayRight(
bool  ray  // flag
)

Parameters
ray
[in] New value of the "Ray Right" property.

Returned value

true if successful, false if flag hasn't changed error.

© 2000-2010, MetaQuotes Software Corp.


1141 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...) .

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1142 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1143 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_TREND for CChartObjectTrend).

© 2000-2010, MetaQuotes Software Corp.


1144 Standard Library

CChartObjectTrendByAngle
Class CChartObjectTrendByAngle is a class for simplified access to "Trend Line by Angle" graphic
object properties.

Description

Class CChartObjectTrendByAngle provides access to "Trend Line by Angle" object properties.

Declaration
class CChartObjectTrendByAngle : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsLines.mqh>

Class Methods

Create

Create Creates graphic object "Trend Line by Angle"

Properties

Angle Gets/Sets property "Angle"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1145 Standard Library

Create
Creates graphic object "Trend Line by Angle"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // 1st time coordinate
double  price1,  // 1st price coordinate
datetime  time2,  // 2nd time coordinate
double  price2  // 2nd price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1146 Standard Library

Angle (Get Method)


Gets the value of "Angle" property.

double  Angle() const

Returned value

The value of "Angle" property, assigned to the class instance. If there is no object assigned, it
returns EMPTY_VALUE.

Angle (Set Method)


Sets new value for the "Angle" property.

bool  Angle(
double  angle  // Angle
)

Parameters
angle
[in] New value of the "Angle" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1147 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_TRENDBYANGLE for CChartObjectTrendByAngle).

© 2000-2010, MetaQuotes Software Corp.


1148 Standard Library

CChartObjectCycles
Class CChartObjectCycles is a class for simplified access to "Cyclic Lines" graphic object properties.

Description

Class CChartObjectCycles provides access to "Cyclic Lines" object properties.

Declaration
class CChartObjectCycles : public CChartObject

Title
<ChartObjects\ChartObjectsLines.mqh>

Class Methods

Create

Create Creates graphic object "Cycle Lines"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1149 Standard Library

Create
Creates graphic object "Cyclic Lines"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // 1st time coordinate
double  price1,  // 1st price coordinate
datetime  time2,  // 2nd time coordinate
double  price2  // 2nd price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1150 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_CYCLES for CChartObjectCycles).

© 2000-2010, MetaQuotes Software Corp.


1151 Standard Library

Objects Channels
A group of graphic objects "Channels".

This section contains the technical details of working with a group of classes of graphical objects
"Channels" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectChannel Graphic object "Equidistant Channel"

CChartObjectRegression Graphic object "Linear Regression Channel"

CChartObjectStdDevChannel Graphic object "Standard deviations Channel"

CChartObjectPitchfork Graphic object "Andrew's Pitchfork"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1152 Standard Library

CChartObjectChannel
The CChartObjectChannel is a class for simplified access to "Equidistant Channel" graphic object
properties.

Description

The class CChartObjectChannel provides access to "Equidistant Channel" object properties.

Declaration
class CChartObjectChannel : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsChannels.mqh>

Class Methods

Create

Create Creates graphic object "Equidistant Channel"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1153 Standard Library

Create
Creates graphic object "Equidistant Channel"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // Time coordinate
double  price1, 
datetime  time2, 
double  price2, 
datetime  time3, 
double  price3 
)

Parameters
chart_id
[in] Chart ID (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1154 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_CHANNEL for CChartObjectChannel).

© 2000-2010, MetaQuotes Software Corp.


1155 Standard Library

CChartObjectRegression
Class CChartObjectRegression is a class for simplified access to "Linear Regression Channel" graphic
object properties.

Description

Class CChartObjectRegression provides access to "Linear Regression Channel" object properties.

Declaration
class CChartObjectRegression : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsChannels.mqh>

Class Methods

Create

Create Creates graphic object "Linear Regression


Channel"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1156 Standard Library

Create
Creates graphic object "Linear Regression Channel"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // First time coordinate
datetime  time2  // Second time coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1157 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_REGRESSION for CChartObjectRegression).

© 2000-2010, MetaQuotes Software Corp.


1158 Standard Library

CChartObjectStdDevChannel
Class CChartObjectStdDevChannel is a class for simplified access to "Standard Deviation Channel"
graphic object properties.

Description

Class CChartObjectStdDevChannel provides access to "Standard Deviation Channel" object


properties.

Declaration
class CChartObjectStdDevChannel : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsChannels.mqh>

Class Methods

Create

Create Creates graphic object "Standard Deviation


Channel"

Properties

Deviations Gets/Sets property "Deviation"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1159 Standard Library

Create
Creates graphic object "Standard Deviation Channel"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
datetime  time2,  // Second time coordinate
double  deviation  // Deviation
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

deviation
[in] Numerical value for "Deviation" property.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1160 Standard Library

Deviation (Get Method)


Gets numerical value for "Deviation" property.

double  Deviation() const

Returned value

Numerical value of "Deviation" property, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

Deviation (Set Method)


Sets numerical value for "Deviation" property.

bool  Deviation(
double  deviation  // Deviation
)

Parameters
deviation
[in] New value for "Deviation" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1161 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...) .

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1162 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...) .

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1163 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_STDDEVCHANNEL for CChartObjectStdDevChannel).

© 2000-2010, MetaQuotes Software Corp.


1164 Standard Library

CChartObjectPitchfork
Class CChartObjectPitchfork is a class for simplified access to "Andrew's Pitchfork" graphic object
properties.

Description

Class CChartObjectPitchfork provides access to "Andrew's Pitchfork" object properties.

Declaration
class CChartObjectPitchfork : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsChannels.mqh>

Class Methods

Create

Create Creates graphic object "Andrew's Pitchfork"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1165 Standard Library

Create
Creates graphic object "Andrew's Pitchfork"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // 1st time coordinate
double  price1,  // 1st price coordinate
datetime  time2,  // ...
double  price2, 
datetime  time3, 
double  price3 
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point..

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the first anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1166 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_PITCHFORK for CChartObjectPitchfork).

© 2000-2010, MetaQuotes Software Corp.


1167 Standard Library

Gann Tools
A group of graphic objects "Gann Tools".

This section contains the technical details of working with a group of classes of graphical objects
"Gann Tools" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectGannLine Graphic object "Gann Line"

CChartObjectGannFan Graphic object "Gann Fan"

CChartObjectGannGrid Graphic object "Gann Grid"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1168 Standard Library

CChartObjectGannLine
Class CChartObjectGannLine is a class for simplified access to "Gann Line" graphic object
properties.

Description

Class CChartObjectGannLine provides access to "Gann Line" object properties.

Declaration
class CChartObjectGannLine : public CChartObjectTrendByAngle

Title
<ChartObjects\ChartObjectsGann.mqh>

Class Methods

Create

Create Creates graphic object "Gann Line"

Properties

PipsPerBar Gets/Sets property "Scale"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1169 Standard Library

Create
Creates graphic object "Gann Line".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  ppb  // Pips per bar
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

ppb
[in] Pips per bar.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1170 Standard Library

PipsPerBar (Get Method)


Gets the value of "Pips per bar" property.

double  PipsPerBar() const

Returned value

Value of "Pips per bar" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

PipsPerBar (Set Method)


Sets new value for "Pips per bar" property.

bool  PipsPerBar(
double  ppb  // Pips per bar
)

Parameters
ppb
[in] New value for "Pips per bar" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1171 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1172 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1173 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_GANNLINE for CChartObjectGannLine).

© 2000-2010, MetaQuotes Software Corp.


1174 Standard Library

CChartObjectGannFan
Class CChartObjectGannFan is a class for simplified access to "Gann Fan" graphic object properties.

Description

Class CChartObjectGannFan provides access to "Gann Fan" object properties.

Declaration
class CChartObjectGannFan : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsGann.mqh>

Class Methods

Create

Create Creates graphic object "Gann Fan"

Properties

PipsPerBar Gets/Sets property "Pips per bar"

Downtrend Gets/Sets property "Downtrend"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1175 Standard Library

Create
Creates graphic object "Gann Fan".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  ppb  // Pips per bar
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

ppb
[in] Pips per bar.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1176 Standard Library

PipsPerBar (Get Method)


Gets the value of "Pips per bar" property.

double  PipsPerBar() const

Returned value

Value of "Pips per bar" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

PipsPerBar (Set Method)


Sets new value for "Pips per bar" property.

bool  PipsPerBar(
double  ppb  // Pips per bar
)

Parameters
ppb
[in] New value for "Pips per bar" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1177 Standard Library

Downtrend (Get Method)


Gets the value of "Downtrend" property.

bool  Downtrend() const

Returned value

Value of the "Downtrend" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Downtrend (Set Method)


Sets new value of "Downtrend" property.

bool  Downtrend(
bool  downtrend  // Flag value
)

Parameters
downtrend
[in] New value for "Downtrend" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1178 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1179 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1180 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_GANNFAN for CChartObjectGannFan).

© 2000-2010, MetaQuotes Software Corp.


1181 Standard Library

CChartObjectGannGrid
Class CChartObjectGannGrid is a class for simplified access to "Gann Grid" graphic object
properties.

Description

Class CChartObjectGannGrid provides access to "Gann Grid" object properties.

Declaration
class CChartObjectGannGrid : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsGann.mqh>

Class Methods

Create

Create Creates graphic object "Gann Grid"

Properties

PipsPerBar Gets/Sets property "Pips per bar"

Downtrend Gets/Sets property "Downtrend"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1182 Standard Library

Create
Creates graphic object "Gann Grid".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  ppb  // Pips per bar
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

ppb
[in] Pips per bar.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1183 Standard Library

PipsPerBar (Get Method)


Gets the value of "Pips per bar" property.

double  PipsPerBar() const

Returned value

Value of "Pips per bar" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

PipsPerBar (Set Method)


Sets new value for "Pips per bar" property.

bool  PipsPerBar(
double  ppb  // Pips per bar
)

Parameters
ppb
[in] New value for "Pips per bar" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1184 Standard Library

Downtrend (Get Method)


Gets the value of "Downtrend" property.

bool  Downtrend() const

Returned value

Value of "Downtrend" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Downtrend (Set Method)


Sets new value of "Downtrend" property.

bool  Downtrend(
bool  downtrend  // Flag value
)

Parameters
downtrend
[in] New value for "Downtrend" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1185 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1186 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1187 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_GANNGRID for CChartObjectGannGrid).

© 2000-2010, MetaQuotes Software Corp.


1188 Standard Library

Fibonacci Tools
A group of graphic objects "Fibonacci Tools".

This section contains the technical details of working with a group of classes of graphical objects
"Fibonacci Tools" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectFibo Graphic object "Fibonacci Retracement"

CChartObjectFiboTimes Graphic object "Fibonacci Time Zones"

CChartObjectFiboFan Graphic object "Fibonacci Fan"

CChartObjectFiboArc Graphic object "Fibonacci Arc"

CChartObjectFiboChannel Graphic object "Fibonacci Channel"

CChartObjectFiboExpansion Graphic object "Fibonacci Expansion"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1189 Standard Library

CChartObjectFibo
Class CChartObjectFibo is a class for simplified access to "Fibonacci Retracement" graphic object
properties.

Description

Class CChartObjectFibo provides access to "Fibonacci Retracement" object properties.

Declaration
class CChartObjectFibo : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Retracement"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1190 Standard Library

Create
Creates graphic object "Fibonacci Retracement".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2  // Second price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1191 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_FIBO for CChartObjectFibo).

© 2000-2010, MetaQuotes Software Corp.


1192 Standard Library

CChartObjectFiboTimes
Class CChartObjectFiboTimes is a class for simplified access to "Fibonacci Time Zones" graphic
object properties.

Description

Class CChartObjectFiboTimes provides access to "Fibonacci Time Zones" object properties.

Declaration
class CChartObjectFiboTimes : public CChartObject

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Time Zones"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1193 Standard Library

Create
Creates graphic object "Fibonacci Time Zones".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2  // Second price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1194 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_FIBOTIMES for CChartObjectFiboTimes).

© 2000-2010, MetaQuotes Software Corp.


1195 Standard Library

CChartObjectFiboFan
Class CChartObjectFiboFan is a class for simplified access to "Fibonacci Fan" graphic object
properties.

Description

Class CChartObjectFiboFan provides access to "Fibonacci Fan" object properties.

Declaration
class CChartObjectFiboFan : public CChartObject

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Fan"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1196 Standard Library

Create
Creates graphic object "Fibonacci Fan".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2  // Second price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1197 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_FIBOFAN for CChartObjectFiboFan).

© 2000-2010, MetaQuotes Software Corp.


1198 Standard Library

CChartObjectFiboArc
Class CChartObjectFiboArc is a class for simplified access to "Fibonacci Arc" graphic object
properties.

Description

Class CChartObjectFiboArc provides access to "Fibonacci Arc" object properties.

Declaration
class CChartObjectFiboArc : public CChartObject

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Arc"

Properties

Scale Gets/Sets property "Scale"

Ellipse Gets/Sets property "Ellipse"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1199 Standard Library

Create
Creates graphic object "Fibonacci Arc"

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
double  scale  // Scale
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

scale
[in] Scale.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1200 Standard Library

Scale (Get Method)


Gets the value of "Scale" property.

double  Scale() const

Returned value

Value of "Scale" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

Scale (Set Method)


Sets new value for "Scale" property.

bool  Scale(
double  scale  // Scale
)

Parameters
scale
[in] New value for "Scale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1201 Standard Library

Ellipse (Get Method)


Gets the value of "Ellipse" property.

bool  Ellipse() const

Returned value

Value of "Ellipse" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Ellipse (Set Method)


Sets new flag value for "Ellipse" property.

bool  Ellipse(
bool  ellipse  // flag value
)

Parameters
ellipse
[in] New value for "Scale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1202 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1203 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1204 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_FIBOARC for CChartObjectFiboArc).

© 2000-2010, MetaQuotes Software Corp.


1205 Standard Library

CChartObjectFiboChannel
Class CChartObjectFiboChannel is a class for simplified access to "Fibonacci Channel" graphic object
properties.

Description

Class CChartObjectFiboChannel provides access to "Fibonacci Channel" object properties.

Declaration
class CChartObjectFiboChannel : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Channel"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1206 Standard Library

Create
Creates graphic object "Fibonacci Channel".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3  // Third price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1207 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_FIBOCHANNEL for CChartObjectFiboChannel).

© 2000-2010, MetaQuotes Software Corp.


1208 Standard Library

CChartObjectFiboExpansion
Class CChartObjectFiboExpansion is a class for simplified access to "Fibonacci Expansion" graphic
object properties.

Description

Class CChartObjectFiboExpansion provides access to "Fibonacci Expansion" object properties.

Declaration
class CChartObjectFiboExpansion : public CChartObjectTrend

Title
<ChartObjects\ChartObjectsFibo.mqh>

Class Methods

Create

Create Creates graphic object "Fibonacci Expansion"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1209 Standard Library

Create
Creates graphic object "Fibonacci Expansion".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3  // Third price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1210 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_EXPANSION for CChartObjectFiboExpansion).

© 2000-2010, MetaQuotes Software Corp.


1211 Standard Library

Elliott Tools
A group of graphic objects "Elliott Tools".

This section contains the technical details of working with a group of classes of graphical objects
"Elliott Tools" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectElliottWave3 Graphic object "Correcting Wave"

CChartObjectElliottWave5 Graphic object "Impulse Wave"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1212 Standard Library

CChartObjectElliottWave3
Class CChartObjectElliottWave3 is a class for simplified access to "Correcting Wave" graphic object
properties.

Description

Class CChartObjectElliottWave3 provides access to "Correcting Wave" object properties.

Declaration
class CChartObjectElliottWave3 : public CChartObject

Title
ChartObjects\ChartObjectsElliott.mqh>

Class Methods

Create

Create Creates graphic object "Correcting Wave"

Properties

Degree Gets/Sets property "Degree"

Lines Gets/Sets property "Lines"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1213 Standard Library

Create
Creates graphic object "Correcting Wave".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3  // Third price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Time coordinate of the third anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1214 Standard Library

Degree (Get Method)


Gets the value of "Degree" property.

ENUM_ELLIOT_WAVE_DEGREE  Degree() const

Returned value

Value of "Degree" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Degree (Set Method)


Sets new value for "Degree" property.

bool  Degree(
ENUM_ELLIOT_WAVE_DEGREE  degree  // property value
)

Parameters
degree
[in] New value for "Degree" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1215 Standard Library

Lines (Get Method)


Gets the value of "Lines" property.

bool  Lines() const

Returned value

Value of "Lines" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Lines (Set Method)


Sets new value for "Lines" property.

bool  Lines(
bool  lines  // flag value
)

Parameters
lines
[in] New value for "Lines" property.

Returned value

true if successful, false if flag hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1216 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1217 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1218 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_ELLIOTWAVE3 for CChartObjectElliottWave3).

© 2000-2010, MetaQuotes Software Corp.


1219 Standard Library

CChartObjectElliottWave5
Class CChartObjectElliottWave5 is a class for simplified access to "Impulse Wave" graphic object
properties.

Description

Class CChartObjectElliottWave5 provides access to "Impulse Wave" object properties.

Declaration
class CChartObjectElliottWave5 : public CChartObjectElliottWave3

Title
ChartObjects\ChartObjectsElliott.mqh>

Class Methods

Create

Create Creates graphic object "Impulse Wave"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1220 Standard Library

Create
Creates graphic object "Impulse Wave".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3,  // Third price coordinate
datetime  time4,  // Fourth time coordinate
double  price4,  // Fourth price coordinate
datetime  time5  // Fifth time coordinate
double  price5,  // Fifth price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

time4
[in] Time coordinate of the fourth anchor point.

© 2000-2010, MetaQuotes Software Corp.


1221 Standard Library

price4
[in] Price coordinate of the fourth anchor point.

time5
[in] Time coordinate of the fifth anchor point.

price5
[in] Price coordinate of the fifth anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1222 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_ELLIOTWAVE5 for CChartObjectElliottWave5).

© 2000-2010, MetaQuotes Software Corp.


1223 Standard Library

Objects Shapes
A group of graphic objects "Shapes".

This section contains the technical details of working with a group of classes of graphical objects
"Shapes" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectRectangle Graphic object "Rectangle"

CChartObjectTriangle Graphic object "Triangle"

CChartObjectEllipse Graphic object "Ellipse"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1224 Standard Library

CChartObjectRectangle
Class CChartObjectRectangle is a class for simplified access to "Rectangle" graphic object
properties.

Description

Class CChartObjectRectangle provides access to "Rectangle" object properties.

Declaration
class CChartObjectRectangle : public CChartObject

Title
<ChartObjects\ChartObjectsShapes.mqh>

Class Methods

Create

Create Creates graphic object "Rectangle"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1225 Standard Library

Create
Creates graphic object "Rectangle".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2  // Second price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

Returned value

true if successful, 0 if error

© 2000-2010, MetaQuotes Software Corp.


1226 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_RECTANGLE for CChartObjectRectangle).

© 2000-2010, MetaQuotes Software Corp.


1227 Standard Library

CChartObjectTriangle
Class CChartObjectTriangle is a class for simplified access to "Triangle" graphic object properties.

Description

Class CChartObjectTriangle provides access to "Triangle" object properties.

Declaration
class CChartObjectTriangle : public CChartObject

Title
<ChartObjects\ChartObjectsShapes.mqh>

Class Methods

Create

Create Creates graphic object "Triangle"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1228 Standard Library

Create
Creates graphic object "Triangle".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
long  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3  // Third price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error

© 2000-2010, MetaQuotes Software Corp.


1229 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_TRIANGLE for CChartObjectTriangle).

© 2000-2010, MetaQuotes Software Corp.


1230 Standard Library

CChartObjectEllipse
Class CChartObjectEllipse is a class for simplified access to "Ellipse" graphic object properties.

Description

Class CChartObjectEllipse provides access to "Ellipse" object properties.

Declaration
class CChartObjectEllipse : public CChartObject

Title
<ChartObjects\ChartObjectsShapes.mqh>

Class Methods

Create

Create Creates graphic object "Ellipse"

Input/output

Type Virtual method of identification

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1231 Standard Library

Create
Creates graphic object "Ellipse".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time1,  // First time coordinate
double  price1,  // First price coordinate
datetime  time2,  // Second time coordinate
double  price2,  // Second price coordinate
datetime  time3,  // Third time coordinate
double  price3  // Third price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time1
[in] Time coordinate of the first anchor point.

price1
[in] Price coordinate of the first anchor point.

time2
[in] Time coordinate of the second anchor point.

price2
[in] Price coordinate of the second anchor point.

time3
[in] Time coordinate of the third anchor point.

price3
[in] Price coordinate of the third anchor point.

Returned value

true if successful, false if error

© 2000-2010, MetaQuotes Software Corp.


1232 Standard Library

Type
Returns object type identifier of the graphic object.

int  Type() const

Returned value

Object type identifier (OBJ_ELLIPSE for CChartObjectEllipse).

© 2000-2010, MetaQuotes Software Corp.


1233 Standard Library

Objects Arrows
Group for graphic objects Arrows.

This section contains the technical details of working with a group of classes of graphical objects
"Arrow" and a description of the relevant components of the standard library MQL5. In essence, the
arrow - this is some icon to be displayed to the user, which matches a certain code. There are two
types of graphical objects "Arrow" to display icons on the charts:

Object "Arrow", which allows you to specify the code icon displayed object.
Group objects to display certain types of icons (and the corresponding certain fixed code).

Class for the arrow displays icons of arbitrary code

Class name Name of the object arrow

CChartObjectArrow Arrow

Classes for the arrow icon fixed code

Class name Name of the object arrow

CChartObjectArrowCheck Check

CChartObjectArrowDown Arrow Up

CChartObjectArrowUp Arrow Down

CChartObjectArrowStop Stop Sign

CChartObjectArrowThumbDown Thumbs Up

CChartObjectArrowThumbUp Thumbs Down

CChartObjectArrowLeftPrice Left Price Label

CChartObjectArrowRightPrice Right Price Label

See also
Object types, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1234 Standard Library

CChartObjectArrow
Class CChartObjectArrow is a class for simplified access to "Arrow" graphic object properties.

Description

Class CChartObjectArrow provides access to common properties of objects "Arrow" to all of its
descendants.

Declaration
class CChartObjectArrow : public CChartObject

Title
<ChartObjects\ChartObjectsArrow.mqh>

Class Methods

Create

Create Creates graphic object "Arrow"

Properties

ArrowCode Gets/Sets property "Arrow Code"

Anchor Gets/Sets property "Anchor"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1235 Standard Library

Create
Creates graphic object "Arrow".

bool  Create(
long  chart_id,  // Chart ID
string  name,  // Object Name
int  window,  // Chart Window
datetime  time,  // Time
double  price,  // Price
char  code  // Arrow Code
)

Parameters
chart_id
[in] Chart Identifier (0 – current chart).

name
[in] Object name (Should be unique).

window
[in] Chart window number (0 – base window).

time
[in] Time coordinate.

price
[in] Price coordinate.

code
[in] "Arrow" code (Wingdings).

Returned value

true – if successful, overwise false.

Example:

//--- example for CChartObjectArrow::Create


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
CChartObjectArrow arrow;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"Arrow",0,TimeCurrent(),price,181))
{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---

© 2000-2010, MetaQuotes Software Corp.


1236 Standard Library

return;
}
//--- use arrow
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1237 Standard Library

ArrowCode (Get Method)


Gets code of the symbol for "Arrow".

char  ArrowCode() const

Returned value

Symbol code of "Arrow" object, assigned to the class instance. If there is no object assigned, it
returns 0.

ArrowCode (Set Method)


Sets symbol code for "Arrow"

bool  ArrowCode(
char  code  // Code value
)

Parameters
code
[in] new value for "arrow" code (Wingdings).

Returned value

true – if successful, false – if code hasn't changed.

Example:

//--- example for CChartObjectArrow::ArrowCode


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
CChartObjectArrow arrow;
char code=181;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"Arrow",0,TimeCurrent(),price,code))
{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---
return;
}
//--- use arrow to possible changes code
//--- . . .
//--- get code of arrow
if(arrow.ArrowCode()!=code)
{
//--- set code of arrow

© 2000-2010, MetaQuotes Software Corp.


1238 Standard Library

arrow.ArrowCode(code);
}
//--- use arrow
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1239 Standard Library

Anchor (Get Method)


Gets anchor type of the "Anchor" object

ENUM_ARROW_ANCHOR  Anchor() const

Returned value

Anchor type of "Arrow" object, assigned to the class instance. If there is no object assigned, it
returns WRONG_VALUE.

Anchor (Set Method)


Sets color for graphic object

bool  Anchor(
ENUM_ARROW_ANCHOR  new_color  // new color
)

Parameters
new_color
[in] New value of color for line of the graphic object.

Returned value

true if successful, false if color hasn't changed.

Example:

//--- example for CChartObject::Anchor


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
CChartObjectArrow arrow;
ENUM_ARROW_ANCHOR anchor=ANCHOR_BOTTOM;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"Arrow",0,TimeCurrent(),price,181))
{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---
return;
}
//--- get anchor of arrow
if(arrow.Anchor()!=anchor)
{
//--- set anchor of arrow
arrow.Anchor(anchor);
}

© 2000-2010, MetaQuotes Software Corp.


1240 Standard Library

//--- use arrow


//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1241 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // file handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...) .

Returned value

true if successful, overwise false.

Example:

//--- example for CChartObjectArrow::Save


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
int file_handle;
CChartObjectArrow arrow;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"Arrow",0,TimeCurrent(),price,181))
{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---
return;
}
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_WRITE|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!arrow.Save(file_handle))
{
//--- file save error
printf("File save: Error %d!",GetLastError());
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
}

© 2000-2010, MetaQuotes Software Corp.


1242 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // file handle
)

Parameters
file_handle
[in] handle of the file already opened using by function FileOpen(...).

Returned value

true if successful, overwise false.

Example:

//--- example for CChartObjectArrow::Load


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
int file_handle;
CChartObjectArrow arrow;
//--- open file
file_handle=FileOpen("MyFile.bin",FILE_READ|FILE_BIN|FILE_ANSI);
if(file_handle>=0)
{
if(!arrow.Load(file_handle))
{
//--- file load error
printf("File load: Error %d!",GetLastError());
FileClose(file_handle);
//---
return;
}
FileClose(file_handle);
}
//--- use arrow
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1243 Standard Library

Type
Returns graphic object type identifier

virtual int  Type() const

Returned value

Object type identifier (for example OBJ_ARROW for CChartObjectArrow)

Example:

//--- example for CChartObjectArrow::Type


#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
CChartObjectArrow arrow;
//--- get arrow type
int type=arrow.Type();
}

© 2000-2010, MetaQuotes Software Corp.


1244 Standard Library

Arrows with fixed code


Classes "Arrows with fixed code" are classes for simplified access to the properties of the following
graphic objects:

Class name Arrow object name

CChartObjectArrowCheck "Arrow Check"

CChartObjectArrowDown "Arrow Down"

CChartObjectArrowUp "Arrow Up"

CChartObjectArrowStop "Arrow Stop"

CChartObjectArrowThumbDown "Good" ("Big finger up")

CChartObjectArrowThumbUp "Bad" ("Big finger down")

CChartObjectArrowLeftPrice "Left price" arrow

CChartObjectArrowRightPrice "Right price" arrow

Description

Classes "Arrows with fixed code" provides access to the object properties.

Declarations
class CChartObjectArrowCheck : public CChartObjectArrow;
class CChartObjectArrowDown : public CChartObjectArrow;
class CChartObjectArrowUp : public CChartObjectArrow;
class CChartObjectArrowStop : public CChartObjectArrow;
class CChartObjectArrowThumbDown : public CChartObjectArrow;
class CChartObjectArrowThumbUp : public CChartObjectArrow;
class CChartObjectArrowLeftPrice : public CChartObjectArrow;
class CChartObjectArrowRightPrice : public CChartObjectArrow;

Title
<ChartObjects\ChartObjectsArrow.mqh>

Class Methods

Create

Create Creates graphic object specified

Properties

ArrowCode "Gag" for method of code change

Input/output

Type Virtual method of identification

© 2000-2010, MetaQuotes Software Corp.


1245 Standard Library

See also

Object types, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1246 Standard Library

Create
Creates graphic object "Arrow with fixed code".

bool  Create(
long  chart_id,  // Chart ID
string  name,  // Object Name
int  window,  // Chart Window
datetime  time,  // Time
double  price  // Price
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] Unique name of the object to create.

window
[in] Chart window number (0 – base window).

time
[in] Time coordinate.

price
[in] Price coordinate.

Returned value

true if successful, false if error.

Example:

//--- example for CChartObjectArrowCheck::Create


//--- example for CChartObjectArrowDown::Create
//--- example for CChartObjectArrowUp::Create
//--- example for CChartObjectArrowStop::Create
//--- example for CChartObjectArrowThumbDown::Create
//--- example for CChartObjectArrowThumbUp::Create
//--- example for CChartObjectArrowLeftPrice::Create
//--- example for CChartObjectArrowRightPrice::Create
#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
//--- for example, take CChartObjectArrowCheck
CChartObjectArrowCheck arrow;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"ArrowCheck",0,TimeCurrent(),price))

© 2000-2010, MetaQuotes Software Corp.


1247 Standard Library

{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---
return;
}
//--- use arrow
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1248 Standard Library

ArrowCode
Prohibits code changes for "Arrow".

bool  ArrowCode(
char  code  // code value
)

Parameters
code
[in] any value

Returned value

Always false.

Example:

//--- example for CChartObjectArrowCheck::ArrowCode


//--- example for CChartObjectArrowDown::ArrowCode
//--- example for CChartObjectArrowUp::ArrowCode
//--- example for CChartObjectArrowStop::ArrowCode
//--- example for CChartObjectArrowThumbDown::ArrowCode
//--- example for CChartObjectArrowThumbUp::ArrowCode
//--- example for CChartObjectArrowLeftPrice::ArrowCode
//--- example for CChartObjectArrowRightPrice::ArrowCode
#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
//--- for example, take CChartObjectArrowCheck
CChartObjectArrowCheck arrow;
//--- set object parameters
double price=SymbolInfoDouble(Symbol(),SYMBOL_BID);
if(!arrow.Create(0,"ArrowCheck",0,TimeCurrent(),price))
{
//--- arrow create error
printf("Arrow create: Error %d!",GetLastError());
//---
return;
}
//--- set code of arrow
if(!arrow.ArrowCode(181))
{
//--- it is not error
printf("Arrow code can not be changed");
}
//--- use arrow
//--- . . .
}

© 2000-2010, MetaQuotes Software Corp.


1249 Standard Library

Type
Returns graphic object type identifier

virtual int  Type() const

Returned value

Object type identifier (OBJ_ARROW_CHECK for CChartObjectArrowCheck, OBJ_ARROW_DOWN for


CChartObjectArrowDown, OBJ_ARROW_UP for CChartObjectArrowUp, OBJ_ARROW_STOP for
CChartObjectArrowStop, OBJ_ARROW_THUMB_DOWN for CChartObjectArrowThumbDown,
OBJ_ARROW_THUMB_UP for CChartObjectArrowThumbUp, OBJ_ARROW_LEFT_PRICE for
CChartObjectArrowLeftPrice, OBJ_ARROW_RIGHT_PRICE for CChartObjectArrowRightPrice).

Example:

//--- example for CChartObjectArrowCheck::Type


//--- example for CChartObjectArrowDown::Type
//--- example for CChartObjectArrowUp::Type
//--- example for CChartObjectArrowStop::Type
//--- example for CChartObjectArrowThumbDown::Type
//--- example for CChartObjectArrowThumbUp::Type
//--- example for CChartObjectArrowLeftPrice::Type
//--- example for CChartObjectArrowRightPrice::Type
#include <ChartObjects\ChartObjectsArrows.mqh>
//---
void OnStart()
{
//--- for example, take CChartObjectArrowCheck
CChartObjectArrowCheck arrow;
//--- get arrow type
int type=arrow.Type();
}

© 2000-2010, MetaQuotes Software Corp.


1250 Standard Library

Object Controls
A group of graphic objects "Object Controls".

This section contains the technical details of working with a group of classes of graphical objects
"Object Controls" and a description of the relevant components of the standard library MQL5.

Class name Object

CChartObjectText Graphic object "Text"

CChartObjectLabel Graphic object "Text Label"

CChartObjectEdit Graphic object "Edit"

CChartObjectButton Graphic object "Button"

CChartObjectSubChart Graphic object "Chart"

CChartObjectBitmap Graphic object "Bitmap"

CChartObjectBmpLabel Graphic object "Bitmap Label"

See also
Object types, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1251 Standard Library

CChartObjectText
Class CChartObjectText is a class for simplified access to "Text" graphic object properties.

Description

Class CChartObjectText provides access to "Text" object properties.

Declaration
class CChartObjectText : public CChartObject

Title
<ChartObjects\ChartObjectsTxtControls.mqh>

Class Methods

Create

Create Creates graphic object "Text"

Properties

Angle Gets/Sets property "Angle"

Font Gets/Sets property "Font"

FontSize Gets/Sets property "FontSize"

Anchor Gets/Sets property "Anchor"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Object properties, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1252 Standard Library

Create
Creates graphic object "Text".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time,  // Time coordinate
double  price  // Price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time
[in] Time coordinate of the anchor point.

price
[in] Price coordinate of the anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1253 Standard Library

Angle (Get Method)


Gets the value of "Angle" property.

double  Angle() const

Returned value

Value of "Angle" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

Angle (Set Method)


Sets new value for "Angle" property.

bool  Angle(
double  angle  // new angle
)

Parameters
angle
[in] New value for "Angle" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1254 Standard Library

Font (Get Method)


Gets the value of "Font" property.

string  Font() const

Returned value

Value of "Font" property of the object, assigned to the class instance. If there is no object assigned,
it returns "".

Font (Set Method)


Sets new value for "Font" property.

bool  Font(
string  font  // new font
)

Parameters
font
[in] New value for "Font" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1255 Standard Library

FontSize (Get Method)


Gets the value of "FontSize" property.

int  FontSize() const

Returned value

Value of "FontSize" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

FontSize (Set Method)


Sets new value for "FontSize" property.

bool  FontSize(
int  size  // new font size
)

Parameters
size
[in] New value for "Font" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1256 Standard Library

Anchor (Get Method)


Gets the value of "Anchor" property.

ENUM_ANCHOR_POINT  Anchor() const

Returned value

Value of "Anchor" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Anchor (Set Method)


Sets new value for "Anchor" property.

bool  Anchor(
ENUM_ANCHOR_POINT  anchor  // new value
)

Parameters
anchor
[in] New value for "Anchor" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1257 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1258 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1259 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_TEXT for CChartObjectText).

© 2000-2010, MetaQuotes Software Corp.


1260 Standard Library

CChartObjectLabel
Class CChartObjectLabel is a class for simplified access to "Label" graphic object properties.

Description

Class CChartObjectLabel provides access to "Label" object properties.

Declaration
class CChartObjectLabel : public CChartObjectText

Title
<ChartObjects\ChartObjectsTxtControls.mqh>

Class Methods

Create

Create Creates graphic object "Label"

Properties

X_Distance Gets/Sets property "X_Distance"

Y_Distance Gets/Sets property "Y_Distance"

X_Size Gets/Sets property "X_Size"

Y_Size Gets/Sets property "Y_Size"

Corner Gets/Sets property "Corner"

Time "Gag" for Time Coordinate change

Price "Gag" for Price Coordinate change

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Object properties, Chart angle, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1261 Standard Library

Create
Creates graphic object "Label".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
int  X,  // X coordinate
int  Y,  // Y coordinate
int  sizeX,  // X size
int  sizeY  // Y size
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

X
[in] X coordinate.

Y
[in] Y coordinate.

sizeX
[in] X size.

sizeY
[in] Y size.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1262 Standard Library

X_Distance (Get Method)


Gets the value of "X_Distance" property.

int  X_Distance() const

Returned value

Value of "X_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

X_Distance (Set Method)


Sets new value for "X_Distance" property.

bool  X_Distance(
int  X  // new value
)

Parameters
X
[in] New value for "X_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1263 Standard Library

Y_Distance (Get Method)


Gets the value of "Y_Distance" property.

int  Y_Distance() const

Returned value

Value of "Y_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Y_Distance (Set Method)


Sets new value for "Y_Distance" property.

bool  Y_Distance(
int  Y  // new value
)

Parameters
Y
[in] New value for "Y_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1264 Standard Library

X_Size
Gets the value of "X_Size" property.

int  X_Size() const

Returned value

Value of "X_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1265 Standard Library

Y_Size
Gets the value of "Y_Size" property.

int  Y_Size() const

Returned value

Value of "Y_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1266 Standard Library

Corner (Get Method)


Gets the value of "Corner" property.

ENUM_BASE_CORNER  Corner() const

Returned value

Value of "Corner" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Corner (Set Method)


Sets new value for "Corner" property.

bool  Corner(
ENUM_BASE_CORNER  corner  // new value
)

Parameters
corner
[in] New value for "Corner" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1267 Standard Library

Time
Prohibits changes of the time coordinate.

bool  Time(
datetime  time  // any value
)

Parameters
time
[in] Any value of datetime type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1268 Standard Library

Price
Prohibits changes of the price coordinate.

bool  Price(
double  price  // any value
)

Parameters
price
[in] Any value of double type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1269 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1270 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1271 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_LABEL for CChartObjectLabel).

© 2000-2010, MetaQuotes Software Corp.


1272 Standard Library

CChartObjectEdit
Class CChartObjectEdit is a class for simplified access to "Edit" graphic object properties.

Description

Class CChartObjectEdit provides access to "Edit" object properties.

Declaration
class CChartObjectEdit : public CChartObjectLabel

Title
<ChartObjects\ChartObjectsTxtControls.mqh>

Class Methods

Create

Create Creates graphic object "Edit"

Properties

X_Size Gets property "X Size"

Y_Size Gets property "Y Size"

BackColor Gets/Sets property "Background Color"

Angle Gets/Sets property "Angle"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Object properties, Chart angle, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1273 Standard Library

Create
Creates graphic object "Edit".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
int  X,  // X coordinate
int  Y,  // Y coordinate
int  sizeX,  // X size
int  sizeY  // Y size
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

X
[in] X coordinate.

Y
[in] Y coordinate.

sizeX
[in] X size.

sizeY
[in] Y size.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1274 Standard Library

X_Size
Sets new value for "X_Size" property.

bool  X_Size(
int  size  // new size
)

Parameters
size
[in] New value for "X_Size" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1275 Standard Library

Y_Size
Sets new value for "Y_Size" property.

bool  Y_Size(
int  size  // new size
)

Parameters
size
[in] New value for "Y_Size" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1276 Standard Library

BackColor (Get Method)


Gets the value of "BackColor" property.

color  BackColor() const

Returned value

Value of "BackColor" property of the object, assigned to the class instance. If there is no object
assigned, it returns CLR_NONE.

BackColor (Set Method)


Sets new value for "BackColor" property.

bool  BackColor(
color  new_color  // new background color
)

Parameters
new_color
[in] New value for "BackColor" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1277 Standard Library

Angle
Prohibits changes of the "Angle" property.

bool  Angle(
double  angle  // any value
)

Parameters
angle
[in] Any value of double type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1278 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1279 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1280 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_EDIT for CChartObjectEdit).

© 2000-2010, MetaQuotes Software Corp.


1281 Standard Library

CChartObjectButton
Class CChartObjectButton is a class for simplified access to "Button" graphic object properties.

Description

Class CChartObjectButton provides access to "Button" object properties.

Declaration
class CChartObjectButton : public CChartObjectEdit

Title
<ChartObjects\ChartObjectsTxtControls.mqh>

Class Methods

Create

Create Inherited form class CChartObjectEdit

Properties

State Gets/Sets button state (Pressed/Depressed)

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Object properties, Chart angle, Methods of binding sites, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1282 Standard Library

State (Get Method)


Gets the value of "State" property.

bool  State() const

Returned value

Value of "State" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

State (Set Method)


Sets new value for "State" property.

bool  State(
bool  state  // new state value
)

Parameters
X
[in] New value for "State" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1283 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1284 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1285 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_BUTTON for CChartObjectButton).

© 2000-2010, MetaQuotes Software Corp.


1286 Standard Library

CChartObjectSubChart
Class CChartObjectSubChart is a class for simplified access to "Chart" graphic object properties.

Description

Class CChartObjectSubChart provides access to "Chart" object properties.

Declaration
class CChartObjectSubChart : public CChartObject

Title
<ChartObjects\ChartObjectsSubChart.mqh>

Class Methods

Create

Create Creates graphic object "Chart"

Properties

X_Distance Gets/Sets property "X_Distance"

Y_Distance Gets/Sets property "Y_Distance"

Corner Gets/Sets property "Corner"

X_Size Gets/Sets property "X_Size"

Y_Size Gets/Sets property "Y_Size"

Symbol Gets/Sets property "Symbol"

Period Gets/Sets property "Period"

Scale Gets/Sets property "Scale"

DateScale Gets/Sets property "Show date scale"

PriceScale Gets/Sets property "Show price scale"

Time "Gag" for time coordinate change

Price "Gag" for price coordinate change

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also

© 2000-2010, MetaQuotes Software Corp.


1287 Standard Library

Object types, Object properties, Chart angle, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1288 Standard Library

Create
Creates graphic object "SubChart".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
int  X,  // X coordinate
int  Y,  // Y coordinate
int  sizeX,  // X size
int  sizeY  // Y size
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

X
[in] X coordinate.

Y
[in] Y coordinate.

sizeX
[in] X size.

sizeY
[in] Y size.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1289 Standard Library

X_Distance (Get Method)


Gets the value of "X_Distance" property.

int  X_Distance() const

Returned value

Value of "X_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

X_Distance (Set Method)


Sets new value for "X_Distance" property.

bool  X_Distance(
int  X  // new value
)

Parameters
X
[in] New value for "X_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1290 Standard Library

Y_Distance (Get Method)


Gets the value of "Y_Distance" property.

int  Y_Distance() const

Returned value

Value of "Y_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Y_Distance (Set Method)


Sets new value for "Y_Distance" property.

bool  Y_Distance(
int  Y  // new value
)

Parameters
Y
[in] New value for "Y_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1291 Standard Library

Corner (Get Method)


Gets the value of "Corner" property.

ENUM_BASE_CORNER Corner() const

Returned value

Value of "Corner" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Corner (Set Method)


Sets new value for "Corner" property.

bool  Corner(
ENUM_BASE_CORNER  corner  // new value
)

Parameters
corner
[in] New value for "Corner" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1292 Standard Library

X_Size (Get Method)


Gets the value of "X_Size" property.

int  X_Size() const

Returned value

Value of "X_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

X_Size (Set Method)


Sets new value for "X_Size" property.

bool  X_Size(
int  X  // new value
)

Parameters
X
[in] New value for "X_Size" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1293 Standard Library

Y_Size (Get Method)


Gets the value of "Y_Size" property.

int  Y_Size() const

Returned value

Value of "Y_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Y_Size (Set Method)


Sets new value for "Y_Size" property.

bool  Y_Size(
int  Y  // new value
)

Parameters
Y
[in] New value for "Y_Size" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1294 Standard Library

Symbol (Get Method)


Gets the value of "Symbol" property.

string  Symbol() const

Returned value

Value of "Symbol" property of the object, assigned to the class instance. If there is no object
assigned, it returns "".

Symbol (Set Method)


Sets new value for "Symbol" property.

bool  Symbol(
string  symbol  // new symbol
)

Parameters
symbol
[in] New value for "Symbol" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1295 Standard Library

Period (Get Method)


Gets the value of "Period" property.

int  Period() const

Returned value

Value of "Period" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Period (Set Method)


Sets new value for "Period" property.

bool  Period(
int  period  // new period
)

Parameters
period
[in] New value for "Period" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1296 Standard Library

Scale (Get Method)


Gets the value of "Scale" property.

double  Scale() const

Returned value

Value of "Scale" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

Scale (Set Method)


Sets new value for "Scale" property.

bool  Scale(
double  scale  // new scale
)

Parameters
scale
[in] New value for "Scale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1297 Standard Library

DateScale (Get Method)


Gets the value of "DateScale" property.

bool  DateScale() const

Returned value

Value of "DateScale" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

DateScale (Set Method)


Sets new value for "DateScale" property.

bool  DateScale(
bool  scale  // new value
)

Parameters
scale
[in] New value for "DateScale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1298 Standard Library

PriceScale (Get Method)


Gets the value of "PriceScale" property.

bool  PriceScale() const

Returned value

Value of "PriceScale" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

PriceScale (Set Method)


Sets new value for "PriceScale" property.

bool  PriceScale(
bool  scale  // new value
)

Parameters
scale
[in] New value for "PriceScale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1299 Standard Library

Time
Prohibits changes of the time coordinate.

bool  Time(
datetime  time  // any value
)

Parameters
time
[in] Any value of datetime type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1300 Standard Library

Price
Prohibits changes of the price coordinate.

bool  Price(
double  price  // any value
)

Parameters
price
[in] Any value of double type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1301 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1302 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1303 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_CHART for CChartObjectSubChart).

© 2000-2010, MetaQuotes Software Corp.


1304 Standard Library

CChartObjectBitmap
Class CChartObjectBitmap is a class for simplified access to "Bitmap" graphic object properties.

Description

Class CChartObjectBitmap provides access to "Bitmap" object properties.

Declaration
class CChartObjectBitmap : public CChartObject

Title
<ChartObjects\ChartObjectsBmpControls.mqh>

Class Methods

Create

Create Creates graphic object "Bitmap"

Properties

BmpFile Gets/Sets property "BMP Filename"

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also
Object types, Object properties, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1305 Standard Library

Create
Creates graphic object "Bitmap".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
datetime  time,  // Time coordinate
double  price  // Price coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

time
[in] Time coordinate of the anchor point.

price
[in] Price coordinate of the anchor point.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1306 Standard Library

BmpFile (Get Method)


Gets the value of "BmpFile" property.

string  BmpFile() const

Returned value

Value of "BmpFile" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

BmpFile (Set Method)


Sets new value for "BmpFile" property.

bool  BmpFile(
string  name  // new file name
)

Parameters
X
[in] New value for "BmpFile" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1307 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1308 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1309 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_BITMAP for CChartObjectBitmap).

© 2000-2010, MetaQuotes Software Corp.


1310 Standard Library

CChartObjectBmpLabel
Class CChartObjectBmpLabel is a class for simplified access to "Bitmap Label" graphic object
properties.

Description

Class CChartObjectBmpLabel provides access to "Bitmap Label" object properties.

Declaration
class CChartObjectBmpLabel : public CChartObject

Title
<ChartObjects\ChartObjectsBmpControls.mqh>

Class Methods

Create

Create Creates graphic object "BmpLabel"

Properties

X_Distance Gets/Sets property "X_Distance"

Y_Distance Gets/Sets property "Y_Distance"

Corner Gets/Sets property "Corner"

X_Size Gets/Sets property "X_Size"

Y_Size Gets/Sets property "Y_Size"

BmpFileOn Gets/Sets property "BmpFileOn" for button


pressed state (On)

BmpFileOff Gets/Sets property "BmpFileOff" for button


depressed state (Off)

State Gets/Sets property "Button State" (Pressed/


Depressed)

Time "Gag" for time coordinate change

Price "Gag" for price coordinate change

Input/output

Save Virtual method for writing to file

Load Virtual method for reading from file

Type Virtual method of identification

See also

© 2000-2010, MetaQuotes Software Corp.


1311 Standard Library

Object types, Object properties, Chart angle, Graphic objects

© 2000-2010, MetaQuotes Software Corp.


1312 Standard Library

Create
Creates graphic object "BmpLabel".

bool  Create(
long  chart_id,  // Chart identifier
string  name,  // Object name
int  window,  // Chart window
int  X,  // X coordinate
int  Y  // Y coordinate
)

Parameters
chart_id
[in] Chart identifier (0 – current chart).

name
[in] An unique name of the object to create.

window
[in] Chart window number (0 – base window).

X
[in] X coordinate.

Y
[in] Y coordinate.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1313 Standard Library

X_Distance (Get Method)


Gets the value of "X_Distance" property.

int  X_Distance() const

Returned value

Value of "X_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

X_Distance (Set Method)


Sets new value for "X_Distance" property.

bool  X_Distance(
int  X  // new value
)

Parameters
X
[in] New value for "X_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1314 Standard Library

Y_Distance (Get Method)


Gets the value of "Y_Distance" property.

int  Y_Distance() const

Returned value

Value of "Y_Distance" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Y_Distance (Set Method)


Sets new value for "Y_Distance" property.

bool  Y_Distance(
int  Y  // new value
)

Parameters
Y
[in] New value for "Y_Distance" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1315 Standard Library

Corner (Get Method)


Gets the value of "Corner" property.

ENUM_BASE_CORNER Corner() const

Returned value

Value of "Corner" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Corner (Set Method)


Sets new value for "Corner" property.

bool  Corner(
ENUM_BASE_CORNER  corner  // new value
)

Parameters
corner
[in] New value for "Corner" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1316 Standard Library

X_Size
Gets the value of "X_Size" property.

int  X_Size() const

Returned value

Value of "X_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1317 Standard Library

Y_Size
Gets the value of "Y_Size" property.

int  Y_Size() const

Returned value

Value of "Y_Size" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1318 Standard Library

BmpFileOn (Get Method)


Gets the value of "BmpFileOn" property.

string  BmpFileOn() const

Returned value

Value of "BmpFileOn" property of the object, assigned to the class instance. If there is no object
assigned, it returns "".

BmpFileOn (Set Method)


Sets new value for "BmpFileOn" property.

bool  BmpFileOn(
string  name  // file name
)

Parameters
name
[in] New value for "BmpFileOn" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1319 Standard Library

BmpFileOff (Get Method)


Gets the value of "BmpFileOff" property.

string  BmpFileOff() const

Returned value

Value of "BmpFileOff" property of the object, assigned to the class instance. If there is no object
assigned, it returns "".

BmpFileOff (Set Method)


Sets new value for "BmpFileOff" property.

bool  BmpFileOff(
string  name  // file name
)

Parameters
name
[in] New value for "BmpFileOff" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1320 Standard Library

State (Get Method)


Gets the value of "State" property.

bool  State() const

Returned value

Value of "State" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

State (Set Method)


Sets new value for "State" property.

bool  State(
bool  state  // new state value
)

Parameters
X
[in] New value for "State" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1321 Standard Library

Time
Prohibits changes of the time coordinate.

bool  Time(
datetime  time  // any value
)

Parameters
time
[in] Any value of datetime type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1322 Standard Library

Price
Prohibits changes of the price coordinate.

bool  Price(
double  price  // any value
)

Parameters
price
[in] Any value of double type.

Returned value

always false.

© 2000-2010, MetaQuotes Software Corp.


1323 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1324 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1325 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (OBJ_BITMAP_LABEL for CChartObjectBmpLabel).

© 2000-2010, MetaQuotes Software Corp.


1326 Standard Library

CChart
Class CChart is a class for simplified access to "Chart" graphic object properties.

Description

Class CChart provides access to "Chart" object properties.

Declaration
class CChart : public CObject

Title
<Charts\Chart.mqh>

Class Methods

Access to protected data

ChartID Gets identifier of the chart.

General properties

Mode Gets/Sets the value of "Mode" property (bar,


candle or line).

Foreground Gets/Sets the value of "Foreground" property.

Shift Gets/Sets the value of "Shift" property.

ShiftSize Gets/Sets the value of "ShiftSize" property (in


percents).

AutoScroll Gets/Sets the value of "AutoScroll" property.

Scale Gets/Sets the value of "Scale" property.

ScaleFix Gets/Sets the value of "ScaleFix" property


(fixed chart scale or not).

ScaleFix_11 Gets/Sets the value of "ScaleFix_11" property


(chart scale is 1:1, or not).

FixedMax Gets/Sets the value of "FixedMax" property


(fixed maximal price).

FixedMin Gets/Sets the value of "FixedMin" property


(fixed minimal price).

ScalePPB Gets/Sets the value of "ScalePPB" property


(scale is "point per bar" or not).

PointsPerBar Gets/Sets the value of "PointsPerBar" property


(in points per bar).

Show properties

© 2000-2010, MetaQuotes Software Corp.


1327 Standard Library

ShowOHLC Gets/Sets the value of "ShowOHLC" property.

ShowLineBid Gets/Sets the value of "ShowLineBid" property.

ShowLineAsk Gets/Sets the value of "ShowLineAsk" property.

ShowLastLine Gets/Sets the value of "ShowLastLine"


property.

ShowPeriodSep Gets/Sets the value of "ShowPeriodSep"


property (show period separators).

ShowGrid Gets/Sets the value of "ShowGrid" property.

ShowVolumes Gets/Sets the value of "ColorVolumes" property


(color for volumes and levels of opened
positions).

ShowObjectDescr Gets/Sets the value of "ShowObjectDescr"


property (show description for graphic objects).

Colors properties

ColorBackground Gets/Sets the value of "ColorBackground"


property (background color of the chart).

ColorForeground Gets/Sets the value of "ColorForeground"


property (color of axes, scale and OHLC strings
of the chart).

ColorGrid Gets/Sets the value of "ColorGrid" property


(color of the grid).

ColorBarUp Gets/Sets the value of "ColorBarUp" property


(color for bull bars, its shadow and candle body
outlines).

ColorBarDown Gets/Sets the value of "ColorBarDown" property


(color for bear bars, its shadow and candle body
outlines).

ColorCandleBull Gets/Sets the value of "ColorCandleBull"


property (body color of the bull candle).

ColorCandleBear Gets/Sets the value of "ColorCandleBear"


property (body color of the bear candle).

ColorChartLine Gets/Sets the value of "ColorChartLine"


property (color for line chart and Doji candles).

ColorVolumes Gets/Sets the value of "ColorVolumes" property


(color for volumes and levels of opened
positions).

ColorLineBid Gets/Sets the value of "ColorLineBid" property


(color of Bid line).

ColorLineAsk Gets/Sets the value of "ColorLineAsk" property

© 2000-2010, MetaQuotes Software Corp.


1328 Standard Library

(color of Ask line).

ColorLineLast Gets/Sets the value of "ColorLineLast" property


(color of the last deal price line).

ColorStopLevels Gets/Sets the value of "ColorStopLevels"


property (color of the SL and TP levels).

Read only properties

VisibleBars Gets total number of visible chart bars.

WindowsTotal Gets total number of chart windows, including


the chart indicator subwindows.

WindowIsVisible Gets visibility flag of the specified chart


subwindow.

WindowHandle Gets window handle of the chart (HWND).

FirstVisibleBar Gets the number of the first visible bar of the


chart.

WidthInBars Gets window width in bars.

WidthInPixels Gets subwindow width in pixels.

HeightInPixels Gets subwindow height in pixels.

PriceMin Gets minimal price of the specified subwindow.

PriceMax Gets maximal price of the specified subwindow.

Properties

Attach Assigns the current chart to the class instance.

FirstChart Assigns the first chart of the client terminal to


the class instance.

NextChart Assigns the next chart of the client terminal to


the class instance.

Open Opens chart with specified parameters and


assign it to the class instance.

Detach Detaches chart from the class instance.

Close Closes chart, assigned to the class instance.

Navigation

Navigate Navigates the chart.

Access to MQL5 API

Symbol Gets symbol of the chart.

Period Gets period of the chart.

Redraw Redraws chart, assigned to the class instance.

© 2000-2010, MetaQuotes Software Corp.


1329 Standard Library

GetInteger The function returns the value of the


corresponding object property.

SetInteger Sets new value for the property of the integer


type.

GetDouble The function returns the value of the


corresponding object property.

SetDouble Sets new value for the property of the double


type.

GetString The function returns the value of the


corresponding object property.

SetString Sets new value for the property of the string


type.

SetSymbolPeriod Changes symbol and period of the chart,


assigned to the class instance.

ApplyTemplate Applies specified template to the chart.

ScreenShot Creates screenshot of the specified chart and


saves it to .gif file.

WindowOnDropped Gets chart subwindow number corresponding to


the object (expert or script) drop point.

PriceOnDropped Gets price coordinate corresponding to the


object (expert or script) drop point.

TimeOnDropped Gets time coordinate corresponding to the


object (expert or script) drop point.

XOnDropped Gets X coordinate corresponding to the object


(expert or script) drop point.

YOnDropped Gets Y coordinate corresponding to the object


(expert or script) drop point.

Input/Output

Save Saves object parameters to file.

Load Loads object parameters from file.

Type Gets graphic object type identifier.

© 2000-2010, MetaQuotes Software Corp.


1330 Standard Library

ChartID
Returns identifier of the chart.

long  ChartID() const

Returned value

Chart identifier, assigned to the class instance. If there is no object assigned, it returns -1.

© 2000-2010, MetaQuotes Software Corp.


1331 Standard Library

Mode (Get Method)


Gets the value of "Mode" property (bar, candle or line).

ENUM_CHART_MODE  Mode() const

Returned value

Value of "Mode" property of the object, assigned to the class instance. If there is no object
assigned, it returns WRONG_VALUE.

Mode (Set Method)


Sets new value for "Mode" property (bar, candle or line).

bool  Mode(
ENUM_CHART_MODE  mode  // new chart mode
)

Parameters
mode
[in] Chart mode (candle, bar or line).

Returned value

true if successful, false if mode hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1332 Standard Library

Foreground (Get Method)


Gets the value of "Foreground" property.

bool  Foreground() const

Returned value

Value of "Foreground" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Foreground (Set Method)


Sets new value for "Foreground" property.

bool  Foreground(
bool  foreground  // new flag value
)

Parameters
foreground
[in] New value for "Foreground" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1333 Standard Library

Shift (Get Method)


Gets the value of "Shift" property.

bool  Shift() const

Returned value

Value of "Shift" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

Shift (Set Method)


Sets new value for "Shift" property.

bool  Shift(
bool  shift  // new flag value
)

Parameters
shift
[in] New value for "Shift" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1334 Standard Library

ShiftSize (Get Method)


Gets the value of "ShiftSize" property (in percents).

double  ShiftSize() const

Returned value

Value of "ShiftSize" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

ShiftSize (Set Method)


Sets new value for "Shift" property (in percents).

bool  ShiftSize(
double  shift_size  // new property value
)

Parameters
shift_size
[in] New value for "ShiftSize" property (in percents).

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1335 Standard Library

AutoScroll (Get Method)


Gets the value of "AutoScroll" property.

bool  AutoScroll() const

Returned value

Value of "AutoScroll" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

AutoScroll (Set Method)


Sets new value for "AutoScroll" property.

bool  AutoScroll(
bool  autoscroll  // new flag value
)

Parameters
autoscroll
[in] New value for "Autoscroll" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1336 Standard Library

Scale (Get Method)


Gets the value of "Scale" property.

int  Scale() const

Returned value

Value of "Scale" property of the object, assigned to the class instance. If there is no object
assigned, it returns 0.

Scale (Set Method)


Sets new value for "Scale" property.

bool  Scale(
int  scale  // new value
)

Parameters
scale
[in] New value for "Scale" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1337 Standard Library

ScaleFix (Get Method)


Gets the value of "ScaleFix" property (fixed chart scale or not).

bool  ScaleFix() const

Returned value

Value of "ScaleFix" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

ScaleFix (Set Method)


Sets new value for "ScaleFix" property.

bool  ScaleFix(
bool  scale_fix  // new value
)

Parameters
scale_fix
[in] New value for "ScaleFix" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1338 Standard Library

ScaleFix_11 (Get Method)


Gets the value of "ScaleFix_11" property (chart scale is 1:1, or not).

bool  ScaleFix_11() const

Returned value

Value of "ScaleFix_11" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

ScaleFix_11 (Set Method)


Sets new value for "ScaleFix_11" property.

bool  ScaleFix_11(
string  scale_11  // new value
)

Parameters
scale_11
[in] New value for "ScaleFix_11" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1339 Standard Library

FixedMax (Get Method)


Gets the value of "FixedMax" property (fixed maximal price).

double  FixedMax() const

Returned value

Value of "FixedMax" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

FixedMax (Set Method)


Sets new value for "FixedMax" property.

bool  FixedMax(
double  max  // new fixed maximum
)

Parameters
max
[in] New value for "FixedMax" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1340 Standard Library

FixedMin (Get Method)


Gets the value of "FixedMin" property (fixed minimal price).

double  FixedMin() const

Returned value

Value of "FixedMin" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

FixedMin (Set Method)


Sets new value for "FixedMin" property.

bool  FixedMax(
double  min  // new fixed minimum
)

Parameters
max
[in] New value for "FixedMin" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1341 Standard Library

PointsPerBar (Get Method)


Gets the value of "PointsPerBar" property (in points per bar).

double  PointsPerBar() const

Returned value

Value of "PointsPerBar" property of the object, assigned to the class instance. If there is no object
assigned, it returns EMPTY_VALUE.

PointsPerBar (Set Method)


Sets new value for "PointsPerBar" property.

bool  PointsPerBar(
double  ppb  // new scale (in points per bar)
)

Parameters
ppb
[in] New value for scale (in points per bar).

Returned value

true if successful, false if scale hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1342 Standard Library

ScalePPB (Get Method)


Gets the value of "ScalePPB" property (scale is "point per bar" or not).

bool  ScalePPB() const

Returned value

Value of "ScalePPB" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

ScalePPB (Set Method)


Sets new value for "ScalePPB" property.

bool  ScalePPB(
bool  scale_ppb  // new flag value
)

Parameters
scale_ppb
[in] New value for "ScalePPB" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1343 Standard Library

ShowOHLC (Get Method)


Gets the value of "ShowOHLC" property.

bool  ShowOHLC() const

Returned value

Value of "ShowOHLC" property of the object, assigned to the class instance. If there is no object
assigned, it returns false.

ShowOHLC (Set Method)


Sets new value for "ShowOHLC" property.

bool  ShowOHLC(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowOHLC" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1344 Standard Library

ShowLineBid (Get Method)


Gets the value of "ShowLineBid" property.

bool  ShowLineBid() const

Returned value

Value of "ShowLineBid" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowLineBid (Set Method)


Sets new value for "ShowLineBid" property.

bool  ShowLineBid(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowLineBid" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1345 Standard Library

ShowLineAsk (Get Method)


Gets the value of "ShowLineAsk" property.

bool  ShowLineAsk() const

Returned value

Value of "ShowLineAsk" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowLineAsk (Set Method)


Sets new value for "ShowLineAsk" property.

bool  ShowLineAsk(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowLineAsk" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1346 Standard Library

ShowLastLine (Get Method)


Gets the value of "ShowLastLine" property.

bool  ShowLastLine() const

Returned value

Value of "ShowLastLine" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowLastLine (Set Method)


Sets new value for "ShowLastLine" property.

bool  ShowLastLine(
bool  show  // new flag value
)

Parameters
show
[in] New value for "ShowLastLine" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1347 Standard Library

ShowPeriodSep (Get Method)


Gets the value of "ShowPeriodSep" property (show period separators).

bool  ShowPeriodSep() const

Returned value

Value of "ShowPeriodSep" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowPeriodSep (Set Method)


Sets new value for "ShowPeriodSep" property.

bool  ShowPeriodSep(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowPeriodSep" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1348 Standard Library

ShowGrid (Get Method)


Gets the value of "ShowGrid" property.

bool  ShowGrid() const

Returned value

Value of "ShowGrid" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowGrid (Set Method)


Sets new value for "ShowGrid" property.

bool  ShowGrid(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowGrid" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1349 Standard Library

ShowVolumes (Get Method)


Gets the value of "ShowVolumes" property.

bool  ShowVolumes() const

Returned value

Value of "ShowVolumes" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowVolumes (Set Method)


Sets new value for "ShowVolumes" property.

bool  ShowVolumes(
bool  show  // new value
)

Parameters
show
[in] New value for "ShowVolumes" property.

Returned value

true if successful, false if property hasn't changed.

Смотри также

Смотри также

© 2000-2010, MetaQuotes Software Corp.


1350 Standard Library

ShowObjectDescr (Get Method)


Gets the value of "ShowObjectDescr" property (show description for graphic objects).

bool  ShowObjectDescr() const

Returned value

Value of "ShowObjectDescr" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns false.

ShowObjectDescr (Set Method)


Sets new value for "ShowObjectDescr" property.

bool  ShowObjectDescr(
bool  show  // New value
)

Parameters
show
[in] New value for "ShowObjectDescr" property.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1351 Standard Library

ColorBackground (Get Method)


Gets the value of "ColorBackground" property (background color of the chart).

color  ColorBackground() const

Returned value

Value of "ColorBackground" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorBackground (Set Method)


Sets new value for "ColorBackground" property.

bool  ColorBackground(
color  new_color  // new background color
)

Parameters
new_color
[in] New background color.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1352 Standard Library

ColorForeground (Get Method)


Gets the value of "ColorForeground" property (color of axes, scale and OHLC strings of the chart).

color  ColorForeground() const

Returned value

Value of "ColorForeground" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorForeground (Set Method)


Sets new value for "ColorForeground" property (for axes, scale, and OHLC string).

bool  ColorForeground(
color  new_color  // New color
)

Parameters
new_color
[in] New color for axes, scale and OHLC string.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1353 Standard Library

ColorGrid (Get Method)


Gets the value of "ColorGrid" property (color of the grid).

color  ColorGrid() const

Returned value

Value of "ColorGrid" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorGrid (Set Method)


Sets new value for "ColorGrid" property.

bool  ColorGrid(
color  new_color  // new grid color
)

Parameters
new_color
[in] New grid color.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1354 Standard Library

ColorBarUp (Get Method)


Gets the value of "ColorBarUp" property (color for bull bars, its shadow and candle body outlines).

color  ColorBarUp() const

Returned value

Value of "ColorBarUp" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorBarUp (Set Method)


Sets new value for "ColorBarUp" property.

bool  ColorBarUp(
color  new_color  // new color for bull bars
)

Parameters
new_color
[in] New color for bull bars.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1355 Standard Library

ColorBarDown (Get Method)


Gets the value of "ColorBarDown" property (color for bear bars, its shadow and candle body outlines).

color  ColorBarDown() const

Returned value

Value of "ColorBarDown" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorBarDown (Set Method)


Sets new value for "ColorBarDown" property.

bool  ColorBarDown(
color  new_color  // new color for bear bars
)

Parameters
new_color
[in] New color for bear bars.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1356 Standard Library

ColorCandleBull (Get Method)


Gets the value of "ColorCandleBull" property (body color of the bull candle).

color  ColorCandleBull() const

Returned value

Value of "ColorCandleBull" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorCandleBull (Set Method)


Sets new value for "ColorBarBull" property.

bool  ColorCandleBull(
color  new_color  // new color for bull candle body
)

Parameters
new_color
[in] New color of the bull candle body.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1357 Standard Library

ColorCandleBear (Get Method)


Gets the value of "ColorCandleBear" property (body color of the bear candle).

color  ColorCandleBear() const

Returned value

Value of "ColorCandleBear" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorCandleBear (Set Method)


Sets new value for "ColorBarBear" property.

bool  ColorCandleBear(
color  new_color  // new color for bear candle body
)

Parameters
new_color
[in] New color of the bear candle body.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1358 Standard Library

ColorChartLine (Get Method)


Gets the value of "ColorChartLine" property (color for line chart and Doji candles).

color  ColorChartLine() const

Returned value

Value of "ColorChartLine" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorChartLine (Set Method)


Sets new value for "ColorChartLine" property.

bool  ColorChartLine(
color  new_color  // new color of the chart lines
)

Parameters
new_color
[in] New color of the chart lines (Doji candles).

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1359 Standard Library

ColorVolumes (Get Method)


Gets the value of "ColorVolumes" property (color for volumes and levels of opened positions).

color  ColorVolumes() const

Returned value

Value of "ColorVolumes" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorVolumes (Set Method)


Sets new value for "ColorVolumes" property.

bool  ColorVolumes(
color  new_color  // new color of the volumes (open position levels)
)

Parameters
new_color
[in] New color of the volumes (open position levels).

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1360 Standard Library

ColorLineBid (Get Method)


Gets the value of "ColorLineBid" property (color of Bid line).

color  ColorLineBid() const

Returned value

Value of "ColorLineBid" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorLineBid (Set Method)


Sets new value for "ColorLineBid" property.

bool  ColorLineBid(
color  new_color  // new color for Bid line
)

Parameters
new_color
[in] New color for Bid line.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1361 Standard Library

ColorLineAsk (Get Method)


Gets the value of "ColorLineAsk" property (color of Ask line).

color  ColorLineAsk() const

Returned value

Value of "ColorLineAsk" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorLineAsk (Set Method)


Sets new value for "ColorLineAsk" property.

bool  ColorLineAsk(
color  new_color  // new color for Ask line
)

Parameters
new_color
[in] New color for Ask line.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1362 Standard Library

ColorLineLast (Get Method)


Gets the value of "ColorLineLast" property (color of the last deal price line).

color  ColorLineLast() const

Returned value

Value of "ColorLineLast" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorLineLast (Set Method)


Sets new value for "ColorLineLast" property.

bool  ColorLineLast(
color  new_color  // new color of the last deal price line
)

Parameters
new_color
[in] New color of the last deal price line.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1363 Standard Library

ColorStopLevels (Get Method)


Gets the value of "ColorStopLevels" property (color of the SL and TP levels).

color  ColorStopLevels() const

Returned value

Value of "ColorStopLevels" property of the chart, assigned to the class instance. If there is no chart
assigned, it returns CLR_NONE.

ColorStopLevels (Set Method)


Sets new value for "ColorStopLevels" property.

bool  ColorStopLevels(
color  new_color  // new color of the SL and TP price levels
)

Parameters
new_color
[in] New color of the Stop Loss and Take Profit price levels.

Returned value

true if successful, false if color hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1364 Standard Library

VisibleBars
Gets total number of visible chart bars.

int  VisibleBars() const

Returned value

Gets total number of visible bars of the chart, assigned to the class instance. If there is no chart
assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1365 Standard Library

WindowsTotal
Gets total number of chart windows, including the chart indicator subwindows.

int  WindowsTotal() const

Returned value

Total number of windows, including the chart indicator subwindows, assigned to the class instance.
If there is no chart assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1366 Standard Library

WindowIsVisible
Gets visibility flag of the specified chart subwindow.

bool  WindowIsVisible(
int  num  // subwindow number
) const

Parameters
num
[in] Subwindow number (0 means base window).

Returned value

Returns visibility flag of the specified chart subwindow, assigned to the chart instance. If there is
no chart assigned, it returns false.

© 2000-2010, MetaQuotes Software Corp.


1367 Standard Library

WindowHandle
Gets window handle of the chart (HWND).

int  WindowHandle() const

Returned value

Window handle of the chart, assigned to the chart instance. If there is no chart assigned, it returns
INVALID_HANDLE.

© 2000-2010, MetaQuotes Software Corp.


1368 Standard Library

FirstVisibleBar
Gets the number of the first visible bar of the chart.

int  FirstVisibleBar() const

Returned value

Number of the first visible bar of the chart, assigned to the chart instance. If there is no chart
assigned, it returns -1.

© 2000-2010, MetaQuotes Software Corp.


1369 Standard Library

WidthInBars
Gets window width in bars.

int  WidthInBars() const

Returned value

Window width in chart bars, assigned to the chart instance. If there is no chart assigned, it returns
0.

© 2000-2010, MetaQuotes Software Corp.


1370 Standard Library

WidthInPixels
Gets subwindow width in pixels.

int  WidthInPixels() const

Returned value

Subwindow width in chart pixels, assigned to the chart instance. If there is no chart assigned, it
returns 0.

© 2000-2010, MetaQuotes Software Corp.


1371 Standard Library

HeightInPixels
Gets subwindow height in pixels.

int  HeightInPixels(
int  num  // subwindow number
) const

Parameters
num
[in] Subwindow number (0 means base window).

Returned value

Subwindow height in chart pixels, assigned to the chart instance. If there is no chart assigned, it
returns 0.

© 2000-2010, MetaQuotes Software Corp.


1372 Standard Library

PriceMin
Gets minimal price of the specified subwindow.

double  PriceMin(
int  num  // subwindow number
) const

Parameters
num
[in] Subwindow number (0 means base window).

Returned value

Minimal price value of the chart, assigned to the class instance. If there is not chart assigned, it
returns EMPTY_VALUE.

© 2000-2010, MetaQuotes Software Corp.


1373 Standard Library

PriceMax
Gets maximal price of the specified subwindow.

double  PriceMax(
int  num  // subwindow number
) const

Parameters
num
[in] Subwindow number (0 means base window).

Returned value

Maximal price value of the chart, assigned to the class instance. If there is not chart assigned, it
returns EMPTY_VALUE.

© 2000-2010, MetaQuotes Software Corp.


1374 Standard Library

Attach
Assigns the current chart to the class instance.

void  Attach()

Attach
Assigns the specified chart to the class instance.

void  Attach(
long  chart  // Chart identifier
)

Parameters
chart
[in] Identifier of the chart to assign

© 2000-2010, MetaQuotes Software Corp.


1375 Standard Library

FirstChart
Assigns the first chart of the client terminal to the class instance.

void  FirstChart()

© 2000-2010, MetaQuotes Software Corp.


1376 Standard Library

NextChart
Assigns the next chart of the client terminal to the class instance.

void  NextChart()

© 2000-2010, MetaQuotes Software Corp.


1377 Standard Library

Open
Opens chart with specified parameters and assign it to the class instance.

long  Open(
const string  symbol_name,  // Symbol name
ENUM_TIMEFRAMES  timeframe  // Period
)

Parameters
symbol_name
[in] Symbol name. NULL means the symbol of the current chart (to which expert attached).

timeframe
[in] Chart timeframe. 0 means the current timeframe.

Returned value

Chart identifier.

© 2000-2010, MetaQuotes Software Corp.


1378 Standard Library

Detach
Detaches chart from the class instance.

void  Detach()

© 2000-2010, MetaQuotes Software Corp.


1379 Standard Library

Close
Closes chart, assigned to the class instance.

void  Close()

© 2000-2010, MetaQuotes Software Corp.


1380 Standard Library

Navigate
Navigates the chart.

bool  Navigate(
ENUM_CHART_POSITION  position,  // Position
int  shift=0  // Shift
)

Parameters
position
[in] Chart position, relative to the navigation.

shift=0
[in] Number of bars to shift.

Returned value

true if successful, false if chart hasn't navigated.

© 2000-2010, MetaQuotes Software Corp.


1381 Standard Library

Symbol
Gets symbol of the chart.

string  Symbol() const

Returned value

Symbol of the chart, assigned to the class instance. If there is no chart assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1382 Standard Library

Period
Gets period of the chart.

ENUM_TIMEFRAMES  Period() const

Returned value

Period of the chart, assigned to the class instance. If there is no chart assigned, it returns 0.

© 2000-2010, MetaQuotes Software Corp.


1383 Standard Library

Redraw
Redraws chart, assigned to the class instance.

void  Redraw()

© 2000-2010, MetaQuotes Software Corp.


1384 Standard Library

GetInteger
The function returns the value of the corresponding object property. The object property must be of
the integer type. There are 2 variants of the function.

1. Immediately returns the property value.

long  GetInteger(
ENUM_CHART_PROPERTY_INTEGER  prop_id,  // property identifier
int  sub_window=0  // subwindow number
) const

2. If successful, puts the value of property to the specified variable of integer type, passed by
reference as last parameter.

bool  GetInteger(
ENUM_CHART_PROPERTY_INTEGER  prop_id,  // property identifier
int  sub_window,  // subwindow number
long&  value  // here we get the property value
) const

Parameters
prop_id
[in] Property identifier.

sub_window
[in] Chart subwindow number.

value
[in] Variable of the integer type that received the value of the requested property.

Return Value

Value of property of the chart, assigned to the class instance. If there isn't any chart assigned, it
returns -1.

For the second variant the function returns true, if this property is maintained and the value has
been placed into the value variable, otherwise returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


1385 Standard Library

SetInteger
Sets new value for the property of the integer type.

bool  SetInteger(
ENUM_CHART_PROPERTY_INTEGER  prop_id,  // property identifier
long  value  // new value
)

Parameters
prop_id
[in] Property identifier.

value
[in] New value of the property.

Returned value

true if successful, false if property of the integer type hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1386 Standard Library

GetDouble
The function returns the value of the corresponding object property. The object property must be of
the double type. There are 2 variants of the function.

1. Immediately returns the property value.

double  GetDouble(
ENUM_CHART_PROPERTY_DOUBLE  prop_id,  // property identifier
int  sub_window=0  // subwindow number
) const

2. If successful, puts the value of property to the specified variable of double type, passed by
reference as last parameter.

bool  GetDouble(
ENUM_CHART_PROPERTY_DOUBLE  prop_id,  // property identifier
int  sub_window,  // subwindow number
double&  value  // here we get the property value
) const

Parameters
prop_id
[in] Property identifier.

sub_window
[in] Chart subwindow number.

value
[in] Variable of the double type that received the value of the requested property.

Return Value

Value of property of the chart, assigned to the class instance. If there isn't any chart assigned, it
returns EMPTY_VALUE.

For the second variant the function returns true, if this property is maintained and the value has
been placed into the value variable, otherwise returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


1387 Standard Library

SetDouble
Sets new value for the property of the double type.

bool  SetDouble(
ENUM_CHART_PROPERTY_DOUBLE  prop_id,  // property identifier
double  value  // new value
)

Parameters
prop_id
[in] Property idenitifier.

value
[in] New value for the property.

Returned value

true if successful, false if property of the double type hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1388 Standard Library

GetString
The function returns the value of the corresponding object property. The object property must be of
the string type. There are 2 variants of the function.

1. Immediately returns the property value.

string  GetString(
ENUM_CHART_PROPERTY_STRING  prop_id  // property identifier
) const

2. If successful, puts the value of property to the specified variable of string type, passed by
reference as last parameter.

bool  GetString(
ENUM_CHART_PROPERTY_STRING  prop_id,  // property identifier
string&  value  // here we get the property value
) const

Parameters
prop_id
[in] Property identifier.

sub_window
[in] Chart subwindow number.

value
[in] Variable of the string type that received the value of the requested property.

Return Value

Value of property of the chart, assigned to the class instance. If there isn't any chart assigned, it
returns "".

For the second variant the function returns true, if this property is maintained and the value has
been placed into the value variable, otherwise returns false. To read more about the error call
GetLastError().

© 2000-2010, MetaQuotes Software Corp.


1389 Standard Library

SetString
Sets new value for the property of the string type.

bool  SetString(
ENUM_CHART_PROPERTY_STRING  prop_id,  // property identifier
string  value  // new property value
)

Parameters
prop_id
[in] Property idenitifier.

value
[in] New value for the property.

Returned value

true if successful, false if property of the string type hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1390 Standard Library

SetSymbolPeriod
Changes symbol and period of the chart, assigned to the class instance.

bool  SetSymbolPeriod(
const string  symbol_name,  // Symbol
ENUM_TIMEFRAMES  timeframe  // Period
)

Parameters
symbol_name
[in] New symbol name. NULL means the symbol of the current chart (to which expert attached).

timeframe
[in] New chart timeframe. 0 means the current timeframe.

Returned value

true if successful, false if property hasn't changed.

© 2000-2010, MetaQuotes Software Corp.


1391 Standard Library

ApplyTemplate
Applies specified template to the chart.

bool  ApplyTemplate(
const string  filename  // template file name
)

Parameters
filename
[in] File name of the template.

Returned value

true if successful, false if template hasn't applied.

© 2000-2010, MetaQuotes Software Corp.


1392 Standard Library

ScreenShot
Creates screenshot of the specified chart and saves it to .gif file.

bool  ScreenShot(
string  filename,  // File name
int  width,  // Width
int  height,  // Height
ENUM_ALIGN_MODE  align_mode=ALIGN_RIGHT  // Align type
) const

Parameters
filename
[in] File name for screenshot.

width
[in] Screenshot width in pixels.

height
[in] Screenshot height in pixels.

align_mode=ALIGN_RIGHT
[in] Align mode, if screenshot is narrow.

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1393 Standard Library

WindowOnDropped
Gets chart subwindow number corresponding to the object (expert or script) drop point.

int  WindowOnDropped() const

Returned value

Chart subwindow number of the object drop point. 0 means main chart window.

© 2000-2010, MetaQuotes Software Corp.


1394 Standard Library

PriceOnDropped
Gets price coordinate corresponding to the object (expert or script) drop point.

double  PriceOnDropped() const

Returned value

Price coordinate of the object drop point.

© 2000-2010, MetaQuotes Software Corp.


1395 Standard Library

TimeOnDropped
Gets time coordinate corresponding to the object (expert or script) drop point.

datetime  TimeOnDropped() const

Returned value

Time coordinate of the object drop point.

© 2000-2010, MetaQuotes Software Corp.


1396 Standard Library

XOnDropped
Gets X coordinate corresponding to the object (expert or script) drop point.

int  XOnDropped() const

Returned value

X coordinate of the object drop point.

© 2000-2010, MetaQuotes Software Corp.


1397 Standard Library

YOnDropped
Gets Y coordinate corresponding to the object (expert or script) drop point.

int  YOnDropped() const

Returned value

Y coordinate of the object drop point.

© 2000-2010, MetaQuotes Software Corp.


1398 Standard Library

Save
Saves object parameters to file.

virtual bool  Save(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1399 Standard Library

Load
Loads object parameters from file.

virtual bool  Load(


int  file_handle  // File handle
)

Parameters
file_handle
[in] handle of the binary file already opened using by function FileOpen(...).

Returned value

true if successful, false if error.

© 2000-2010, MetaQuotes Software Corp.


1400 Standard Library

Type
Returns graphic object type identifier.

virtual int  Type() const

Returned value

Object type identifier (0x1111 for CChart).

© 2000-2010, MetaQuotes Software Corp.


1401 Standard Library

File Operations
This section contains the technical details of the file operations classes and descriptions of the
corresponding components of the standard MQL5 library.

The file operations classes use will save time in developing applications which uses file input/output
operations.

The standard library MQL5 is placed in the working directory of the terminal in the Include\Files
folder.

Class name Description

CFile Base file operations class

CFileBin Binary file operations class

CFileTxt Text file operations class

© 2000-2010, MetaQuotes Software Corp.


1402 Standard Library

CFile
CFile is a base class for CFileBin and CFileTxt classes.

Description

Class CFile provides the simplified access for all of its descendants to MQL5 API file and folder
functions.

Declaration
class CFile: public CObject

Title
#include <Files\File.mqh>

Class Methods

Attributes

Handle Gets file handle

Filename Gets file name

Flags Gets file flags

SetUnicode Sets/Clears the FILE_UNICODE flag

SetCommon Sets/Clears the FILE_COMMON flag

General methods for files

Open Opens file

Close Closes file

Delete Deletes file

IsExist Checks file for existence

Copy Copies file

Move Renames/moves file

Size Gets file size

Tell Gets current file position

Seek Sets current file position

Flush Flushes data on disk

IsEnding Checks file for end

IsLineEnding Checks line for end

General methods for folders

© 2000-2010, MetaQuotes Software Corp.


1403 Standard Library

FolderCreate Creates folder

FolderDelete Deletes folder

FolderClean Clears folder

Search methods

FileFindFirst Begin file search

FileFindNext Continue file search

FileFindClose Close search handle

© 2000-2010, MetaQuotes Software Corp.


1404 Standard Library

Handle
Gets file handle of the opened file.

int  Handle()

Returned value

Handle of the opened file, assigned to the class instance. If there is no file assigned, it returns -1.

© 2000-2010, MetaQuotes Software Corp.


1405 Standard Library

FileName
Gets file name of the opened file.

string  FileName()

Returned value

File name of the opened file, assigned to the class instance. If there is no file assigned, it returns
"".

© 2000-2010, MetaQuotes Software Corp.


1406 Standard Library

Flags
Gets flags of the opened file.

int  Flags()

Returned value

Flags of the opened file, assigned to the class instance.

© 2000-2010, MetaQuotes Software Corp.


1407 Standard Library

SetUnicode
Sets/Clears the FILE_UNICODE flag.

void  SetUnicode(
bool  unicode  // New flag value
)

Parameters
unicode
[in] New value for FILE_UNICODE flag.

Note

The result of string operations is dependent on the FILE_UNICODE flag. If it's false, the ANSI codes
are used (one byte symbols). If it set, the UNICODE codes are used (two byte symbols). If the file
has already opened, the flag cannot be changed.

© 2000-2010, MetaQuotes Software Corp.


1408 Standard Library

SetCommon
Sets/Clears the FILE_COMMON flag.

void  SetCommon(
bool  common  // New flag value
)

Parameters
common
[in] New value for FILE_COMMON flag.

Note

The FILE_UNICODE flag determines the current work folder. If it's false, the local terminal folder
used as the current work folder. If it's true, the general folder used as the current work folder. If the
file has already opened, the flag cannot be changed.

© 2000-2010, MetaQuotes Software Corp.


1409 Standard Library

Open
Open the specified file and if it successful, assigns it to the class instance.

int  Open(
const string  file_name,  // File name
int  flags,  // Flags
short  delimiter=9  // Separator
)

Parameters
file_name
[in] File name to open.

flags
[in] File open flags.

delimiter=9
[in] CSV file separator.

Returned value

Handle of the opened file.

Note

The work folder is dependent on the FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1410 Standard Library

Close
Closes file, assigned to the class instance.

void  Close()

© 2000-2010, MetaQuotes Software Corp.


1411 Standard Library

Delete
Deletes the file, assigned to the file instance.

void  Delete()

Delete
Deletes the specified file.

void  Delete(
const string  file_name  // File name
)

Parameters
file_name
[in] File name of the file to delete.

Note

The work folder is dependent on FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1412 Standard Library

IsExist
Checks file for existence

bool  IsExist(
const string  file_name  // File name
)

Parameters
file_name
[in] Name of the file to check.

Returned value

true, if file exists.

© 2000-2010, MetaQuotes Software Corp.


1413 Standard Library

Copy
Copies a file.

bool  Copy(
const string  src_name,  // Source file name
int  src_flag,  // Flag
const string  dst_name,  // Destination file name
int  dst_flags  // Flags
)

Parameters
src_name
[in] File name of the file to copy.

src_flag
[in] Flags of the file to copy (only FILE_COMMON is used).

dst_name
[in] File name of the destination file.

dst_flags
[in] Flags of the destination file (only FILE_REWRITE and FILE_COMMON are used).

Returned value

true if successful, false if it hasn't been copied.

© 2000-2010, MetaQuotes Software Corp.


1414 Standard Library

Move
Renames/moves file.

bool  Move(
const string  src_name,  // Source file name
int  src_flag,  // Flag
const string  dst_name,  // Destination file name
int  dst_flags  // Flags
)

Parameters
src_name
[in] File name of the file to move.

src_flag
[in] Flags of the file to copy (only FILE_COMMON is used).

dst_name
[in] File name of the destination file.

dst_flags
[in] Flags of the destination file (only FILE_REWRITE and FILE_COMMON are used).

Returned value

true if successful, false if it hasn't been moved.

© 2000-2010, MetaQuotes Software Corp.


1415 Standard Library

Size
Gets file size in bytes.

ulong  Size()

Returned value

File size in bytes. If there isn't any file assigned, it returns ULONG_MAX.

© 2000-2010, MetaQuotes Software Corp.


1416 Standard Library

Tell
Gets the current file position.

ulong  Tell()

Returned value

The current file position. If there isn't any file assigned, it returns ULONG_MAX.

© 2000-2010, MetaQuotes Software Corp.


1417 Standard Library

Seek
Sets current file position.

void  Seek(
long  offset,  // Offset
ENUM_FILE_POSITION  origin  // Origin
)

Parameters
offset
[in] File offset in bytes (can be negative).

origin
[in] Origin of the offset.

Returned value

true if successful, false if file position hasn't been changed.

© 2000-2010, MetaQuotes Software Corp.


1418 Standard Library

Flush
Flushes all of the file input/output buffer data on disk.

void  Flush()

© 2000-2010, MetaQuotes Software Corp.


1419 Standard Library

IsEnding
Checks file for end. It's used during the file read operations.

bool  IsEnding()

Returned value

true if end of file has been achieved after read or seek operation.

© 2000-2010, MetaQuotes Software Corp.


1420 Standard Library

IsLineEnding
Checks file for end of line. It's used during the file read operations.

bool  IsLineEnding()

Returned value

true if end of line has been achieved after the txt or csv file read operation (CR-LF chars).

© 2000-2010, MetaQuotes Software Corp.


1421 Standard Library

FolderCreate
Creates new folder.

bool  FolderCreate(
const string  folder_name  // Folder name
)

Parameters
folder_name
[in] Name of the folder to create. It contains path to the folder relative to the folder defined by
FILE_COMMON flag.

Returned value

true if successful, and false if the folder hasn't been created.

Note

The work folder is dependent on FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1422 Standard Library

FolderDelete
Deletes specified folder.

bool  FolderDelete(
const string  folder_name  // Folder name
)

Parameters
folder_name
[in] Name of the folder to delete. It contains path to the folder relative to the folder defined by
FILE_COMMON flag.

Returned value

true if successful, and false if the folder hasn't been deleted.

Note

The work folder is dependent on FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1423 Standard Library

FolderClean
Cleans specified folder.

bool  FolderClean(
const string  folder_name  // Folder name
)

Parameters
folder_name
[in] Name of the folder to delete. It contains path to the folder relative to the folder defined by
FILE_COMMON flag.

Returned value

true if successful, and false if the folder hasn't been cleaned.

Note

The work folder is dependent on FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1424 Standard Library

FileFindFirst
It began file search using the filter specified.

int  FileFindFirst(
const string  filter,  // Search Filter
string&  file_name  // Reference to string
)

Parameters
filter
[in] Search filter.

file_name
[out] The reference to string for the first file found.

Returned value

If successful, it returns handle, that can be used for further file search using FileFindNext, or
INVALID_HANDLE if there isn't any file corresponding to the filter specified.

Note

The work folder is dependent on FILE_COMMON flag, defined by SetCommon() method.

© 2000-2010, MetaQuotes Software Corp.


1425 Standard Library

FileFindNext
It continue search, started by function FileFindFirst().

bool  FileFindNext(
int  search_handle,  // Search handle
string&  file_name  // Reference to string for the next file found
)

Parameters
search_handle
[in] Search handle, returned by FileFindFirst() method.

file_name
[in] The reference to string for the name of the file found if successful.

Returned value

true if successful, false if there isn't any file, corresponding to the filter specified.

© 2000-2010, MetaQuotes Software Corp.


1426 Standard Library

FileFindClose
Closes search handle.

void  FileFindClose(
int  search_handle  // Search handle
)

Parameters
search_handle
[in] Search handle, returned by FileFindFirst() method.

© 2000-2010, MetaQuotes Software Corp.


1427 Standard Library

CFileBin
CFileBin is a class for simplified access to binary files.

Description

Class CFileBin provides an access to binary files.

Declaration
class CFileBin: public CFile

Title
#include <Files\FileBin.mqh>

Class Methods

Open methods

Open Opens a binary file

Write methods

WriteChar Writes char or uchar type variable

WriteShort Writes short or ushort type variable

WriteInteger Writes int or uint type variable

WriteLong Writes long or ulong type variable

WriteFloat Writes float type variable

WriteDouble Writes double type variable

WriteString Writes string type variable

WriteCharArray Writes an array of char or uchar type variables

WriteShortArray Writes an array of short or ushort type


variables

WriteIntegerArray Writes an array of int or uint type variables

WriteLongArray Writes an array of long or ulong type variables

WriteFloatArray Writes an array of float variables

WriteDoubleArray Writes an array of double type variables

WriteObject Writes data of the CObject class inheritor


instance

Read methods

ReadChar Reads char or uchar type variable

ReadShort Reads short or ushort type variable

© 2000-2010, MetaQuotes Software Corp.


1428 Standard Library

ReadInteger Reads int or uint type variable

ReadLong Reads long or ulong type variable

ReadFloat Reads float type variable

ReadDouble Reads double type variable

ReadString Reads string type variable

ReadCharArray Reads an array of char or uchar type variables

ReadShortArray Reads an array of short or ushort type variables

ReadIntegerArray Reads an array of int or uint type variables

ReadLongArray Reads an array of long or ulong type variables

ReadFloatArray Reads an array of float type variables

ReadDoubleArray Reads an array of double type variables

ReadObject Reads data of the CObject class inheritor


instance

© 2000-2010, MetaQuotes Software Corp.


1429 Standard Library

Open
Open the specified binary file and if it successful, assigns it to the class instance.

int  Open(
const string  file_name,  // File name
int  flags  // Flags
)

Parameters
file_name
[in] File name of the file to open.

flags
[in] File open flags (there is a forced set of the FILE_BIN flag).

Returned value

Handle of the opened file.

© 2000-2010, MetaQuotes Software Corp.


1430 Standard Library

WriteChar
Writes char or uchar type variable to file.

uint  WriteChar(
char  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1431 Standard Library

WriteShort
Writes short or ushort type variable to file.

uint  WriteShort(
short  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1432 Standard Library

WriteInteger
Writes int or uint type variable to file.

uint  WriteInteger(
int  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1433 Standard Library

WriteLong
Writes long or ulong type variable to file.

uint  WriteLong(
long  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1434 Standard Library

WriteFloat
Writes float type variable to file.

uint  WriteFloat(
float  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1435 Standard Library

WriteDouble
Writes double type variable to file.

uint  WriteDouble(
double  value  // Value
)

Parameters
value
[in] Variable to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1436 Standard Library

WriteString
Writes string type variable to file.

uint  WriteString(
const string  value  // Value
)

Parameters
value
[in] String to write.

Returned value

Number of bytes written.

WriteString
Writes string type variable to file.

uint  WriteString(
const string  value,  // Value
int  size  // Size
)

Parameters
value
[in] String to write.

size
[in] Number of bytes to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1437 Standard Library

WriteCharArray
Writes an array of char or uchar type variables to file.

uint  WriteCharArray(
char&  array[],  // Array reference
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1438 Standard Library

WriteShortArray
Writes an array of short or ushort type variables to file.

uint  WriteShortArray(
short&  array[],  // Array to write
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to write
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1439 Standard Library

WriteIntegerArray
Writes an array of int or uint type variables to file.

uint  WriteIntegerArray(
int&  array[],  // Array to write
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to write
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1440 Standard Library

WriteLongArray
Writes an array of long or ulong type variables to file.

uint  WriteLongArray(
long&  array[],  // Array to write
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to write
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1441 Standard Library

WriteFloatArray
Writes an array of float type variables to file.

uint  WriteFloatArray(
float&  array[],  // Array to write
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to write
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1442 Standard Library

WriteDoubleArray
Writes an array of double type variables to file.

uint  WriteDoubleArray(
double&  array[],  // Array to write
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to write
)

Parameters
array[]
[in] Array to write.

start_item=0
[in] Start element to write from.

items_count=-1
[in] Number of elements to write (-1 - for whole array).

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1443 Standard Library

WriteObject
Writes data of the CObject class inheritor instance to file.

bool  WriteObject(
CObject*  object  // Reference to the object
)

Parameters
object
[in] Reference to the CObject class inheritor instance to write.

Returned value

true if successful, false if data hasn't been written.

© 2000-2010, MetaQuotes Software Corp.


1444 Standard Library

ReadChar
Reads char or uchar type variable from file.

bool  ReadChar(
char&  value  // Target variable
)

Parameters
value
[in] Target variable of type char.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1445 Standard Library

ReadShort
Reads short or ushort type variable from file.

bool  ReadShort(
short&  value 
)

Parameters
value
[in] Target variable of type short or ushort.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1446 Standard Library

ReadInteger
Reads int or uint type variable from file.

bool  ReadInteger(
int&  value  // Target variable
)

Parameters
value
[in] Target variable of type int or uint.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1447 Standard Library

ReadLong
Reads long or ulong type variable from file.

bool  ReadLong(
long&  value 
)

Parameters
value
[in] Target variable of type long or ulong.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1448 Standard Library

ReadFloat
Reads float type variable from file.

bool  ReadFloat(
float&  value  // Target variable
)

Parameters
value
[in] Target variable of type float.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1449 Standard Library

ReadDouble
Reads double type variable from file.

bool  ReadDouble(
double&  value 
)

Parameters
value
[in] Target variable of type double.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1450 Standard Library

ReadString
Reads string type variable from file.

bool  ReadString(
string&  value  // Target string
)

Parameters
value
[in] Target variable of type string.

Returned value

true if successful, false if data hasn't been read.

ReadString
Reads string type variable from file.

bool  ReadString(
string&  value 
)

Parameters
value
[in] Target variable of type string.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1451 Standard Library

ReadCharArray
Reads an array of char or uchar type variables from file.

bool  ReadCharArray(
char&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type char or uchar.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1452 Standard Library

ReadShortArray
Reads an array of short or ushort type variables from file.

bool  ReadShortArray(
short&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type short or ushort.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1453 Standard Library

ReadIntegerArray
Reads an array of int or uint type variables from file.

bool  ReadIntegerArray(
int&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type int or uint.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1454 Standard Library

ReadLongArray
Reads an array of long or ulong type variables from file.

bool  ReadLongArray(
long&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type long or ulong.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1455 Standard Library

ReadFloatArray
Reads an array of float type variables from file.

bool  ReadFloatArray(
float&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type float.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1456 Standard Library

ReadDoubleArray
Reads an array of double type variables from file.

bool  ReadDoubleArray(
double&  array[],  // Target array
int  start_item=0,  // Start element
int  items_count=-1  // Number of elements to read
)

Parameters
array[]
[in] Reference to the target array of type double.

start_item=0
[in] Start element to read from.

items_count=-1
[in] Number of elements to read (-1 - read to the end of file).

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1457 Standard Library

ReadObject
Reads data of the CObject class inheritor instance from file.

bool  ReadObject(
CObject*  object  // Reference to the object
)

Parameters
object
[in] Reference to the target CObject class inheritor instance for read to.

Returned value

true if successful, false if data hasn't been read.

© 2000-2010, MetaQuotes Software Corp.


1458 Standard Library

CFileTxt
CFileTxt is a class for simplified access to text files.

Description

Class CFileTxt provides an access to text files.

Declaration
class CFileTxt: public CFile

Title
#include <Files\FileTxt.mqh>

Class Methods

Open methods

Open Open a text file

Write methods

WriteString Writes string type variable to file

Read methods

ReadString Reads string type variable from file

© 2000-2010, MetaQuotes Software Corp.


1459 Standard Library

Open
Open the specified text file and if it successful, assigns it to the class instance.

int  Open(
const string  file_name,  // file name
int  flags  // flags
)

Parameters
file_name
[in] File name to open.

flags
[in] File open flags (there is a forced set of the FILE_TXT flag).

Returned value

Opened file handle.

© 2000-2010, MetaQuotes Software Corp.


1460 Standard Library

WriteString
Writes string type variable to file.

uint  WriteString(
const string  value  // String to write
)

Parameters
value
[in] String to write.

Returned value

Number of bytes written.

© 2000-2010, MetaQuotes Software Corp.


1461 Standard Library

ReadString
Reads string type variable from file.

string  ReadString()

Returned value

String which has been read.

© 2000-2010, MetaQuotes Software Corp.


1462 Standard Library

String operations
This section contains the technical details of the string operations classes and descriptions of the
corresponding components of the standard MQL5 library.

The use of string operations classes will save time in developing applications which uses text
processing operations.

The standard library MQL5 is placed in the working directory of the terminal in the Include\Strings
folder.

Class name Description

CString Class for string operations

© 2000-2010, MetaQuotes Software Corp.


1463 Standard Library

CString
CString is a class for simplified access to the variables of string type.

Description

Class CFile provides the simplified access for all of its descendants to MQL5 API string functions.

Declaration
class CString: public CObject

Title
#include <Strings\String.mqh>

Class Methods

Data access methods

Str Gets a string

Len Gets length of a string

Copy Copies a string

Fill methods

Fill Fills a string with specified char

Assign Assigns a string

Append Appends a string

Insert Inserts a string

Compare methods

Compare Compares a string

CompareNoCase Compares a strings case insensitive

Substring methods

Left Gets a specified number of characters from the


left side of a string

Right Gets a specified number of characters from the


right side of a string

Mid Gets a specified number of characters from a


string

Trim/delete methods

Trim Removes all leading and trailing occurrences of


a set of specified characters from a string

© 2000-2010, MetaQuotes Software Corp.


1464 Standard Library

TrimLeft Removes all leading occurrences of a set of


specified characters from a string

TrimRight Removes all trailing occurrences of a set of


specified characters from a string

Clear Clears a string

Convert methods

ToUpper Converts a string to uppercase.

ToLower Converts a string to lowercase.

Reverse Reverses a string

Search methods

Find Searches for the first match of a substring

FindRev Searches for the last match of a substring

Remove Deletes a substring from a string

Replace Replaces a substring

© 2000-2010, MetaQuotes Software Corp.


1465 Standard Library

Str
Gets a string.

string  Str() const;

Returned value

Copy of a string.

© 2000-2010, MetaQuotes Software Corp.


1466 Standard Library

Len
Gets length of a string.

uint  Len() const;

Returned value

Length of a string.

© 2000-2010, MetaQuotes Software Corp.


1467 Standard Library

Copy
Copies a string by reference.

void  Copy(
string&  copy  // Reference
) const;

Parameters
copy
[in] Reference to a string to copy.

Copy
Copies a string to the CString class instance.

void  Copy(
CString*  copy  // Object descriptor
) const;

Parameters
copy
[in] CString class object descriptor.

© 2000-2010, MetaQuotes Software Corp.


1468 Standard Library

Fill
Fills a string with specified char.

bool  Fill(
short  character  // Character
)

Parameters
character
[in] Character for filling.

Returned value

true if successful, false if a string hasn't been filled.

© 2000-2010, MetaQuotes Software Corp.


1469 Standard Library

Assign
Assigns a string.

void  Assign(
const string  str  // String to assign
)

Parameters
str
[in] String to assign.

Assign
Assigns a string to the CString class instance.

void  Assign(
CString*  str  // Object descriptor
)

Parameters
str
[in] CString class object descriptor to assign.

© 2000-2010, MetaQuotes Software Corp.


1470 Standard Library

Append
Appends a string.

void  Append(
const string  str  // String to append
)

Parameters
str
[in] String to append.

Append
Appends a string to the CString class instance.

void  Append(
CString*  string  // Object descriptor
)

Parameters
string
[in] CString class object descriptor to append.

© 2000-2010, MetaQuotes Software Corp.


1471 Standard Library

Insert
Inserts a string to the specified position.

uint  Insert(
uint  pos,  // Position
const string  str  // String to insert
)

Parameters
pos
[in] Insert position.

str
[in] String to insert.

Returned value

Resulted string length.

Insert
Inserts a string to the specified position to the CString class instance.

uint  Insert(
uint  pos,  // Position
CString*  str  // Object descriptor
)

Parameters
pos
[in] Insert position.

str
[in] CString class object descriptor to insert.

Returned value

Resulted string length.

© 2000-2010, MetaQuotes Software Corp.


1472 Standard Library

Compare
Compares a string.

int  Compare(
const string  str  // String to compare
) const;

Parameters
str
[in] String to compare.

Returned value

I returns 0 if a strings are equal, -1 if a string of the class is lower than a string to compare, -1 if
the class string greater than a string to compare.

Compare
Compares a string with a string of the CString class instance.

int  Compare(
CString*  str  // Object descriptor
) const;

Parameters
str
[in] CString class object descriptor to compare.

Returned value

I returns 0 if a strings are equal, -1 if a string of the class is lower than a string to compare, -1 if
the class string greater than a string to compare.

© 2000-2010, MetaQuotes Software Corp.


1473 Standard Library

CompareNoCase
Compares a strings case insensitive.

int  CompareNoCase(
const string  str  // String to compare
) const;

Parameters
str
[in] String to compare.

Returned value

I returns 0 if a strings are equal, -1 if a string of the class is lower than a string to compare, -1 if
the class string greater than a string to compare.

CompareNoCase
Compares a string (case insensitive) with a string of the CString class instance.

int  CompareNoCase(
CString*  str  // Object descriptor
) const;

Parameters
str
[in] CString class object descriptor to compare.

Returned value

I returns 0 if a strings are equal, -1 if a string of the class is lower than a string to compare, -1 if
the class string greater than a string to compare.

© 2000-2010, MetaQuotes Software Corp.


1474 Standard Library

Left
Gets a specified number of characters from the left side of a string.

string  Left(
uint  count  // Number of characters
)

Parameters
count
[in] Number of characters.

Returned value

Resulted substring.

© 2000-2010, MetaQuotes Software Corp.


1475 Standard Library

Right
Gets a specified number of characters from the right side of a string.

string  Right(
uint  count  // Number of characters
)

Parameters
count
[in] Number of characters.

Returned value

Resulted substring.

© 2000-2010, MetaQuotes Software Corp.


1476 Standard Library

Mid
Gets a specified number of characters from a string.

string  Mid(
uint  pos,  // Position
uint  count  // Number of characters
)

Parameters
pos
[in] Position of a string.

count
[in] Number of characters.

Returned value

Resulted substring.

© 2000-2010, MetaQuotes Software Corp.


1477 Standard Library

Trim
Removes all leading and trailing occurrences of a set of specified characters (and ' ','\t','\r','\n') from a
string.

int  Trim(
const string  targets  // Set of characters to remove
)

Parameters
targets
[in] Set of characters to remove.

Returned value

Number of characters removed.

Example:

//--- example for CString::Trim


#include <Strings\String.mqh>
//---
void OnStart()
{
CString str;
//---
str.Assign(" \t\tABCD\r\n");
printf("Source string '%s'",str.Str());
//---
str.Trim("DA-DA-DA");
printf("Result string '%s'",str.Str());
}

© 2000-2010, MetaQuotes Software Corp.


1478 Standard Library

TrimLeft
Removes all leading occurrences of a set of specified characters (and ' ','\t','\r','\n') from a string.

int  TrimLeft(
const string  targets  // Set of characters to remove
)

Parameters
targets
[in] Set of characters to remove.

Returned value

Number of characters removed.

© 2000-2010, MetaQuotes Software Corp.


1479 Standard Library

TrimRight
Removes all trailing occurrences of a set of specified characters (and ' ','\t','\r','\n') from a string.

int  TrimRight(
const string  targets  // Set of characters to remove
)

Parameters
targets
[in] Set of characters to remove.

Returned value

Number of characters removed.

© 2000-2010, MetaQuotes Software Corp.


1480 Standard Library

Clear
Clears a string.

bool  Clear()

Returned value

true if successful, false if a string hasn't been cleared.

© 2000-2010, MetaQuotes Software Corp.


1481 Standard Library

ToUpper
Converts a string to uppercase.

bool  ToUpper()

Returned value

true if successful, false if a string hasn't been converted.

© 2000-2010, MetaQuotes Software Corp.


1482 Standard Library

ToLower
Converts a string to lowercase.

bool  ToLower()

Returned value

true if successful, false if a string hasn't been converted.

© 2000-2010, MetaQuotes Software Corp.


1483 Standard Library

Reverse
Reverses of a string.

void  Reverse()

© 2000-2010, MetaQuotes Software Corp.


1484 Standard Library

Find
Searches for the first match of a substring.

int  Find(
uint  start,  // Position
const string  substring  // Substring to search for
) const;

Parameters
start
[in] The index of the character in the string to begin the search with, or 0 to start from the
beginning.

substring
[in] Substring to search for.

Returned value

The index of the first character that matches the requested substring; -1 if the substring is not
found.

© 2000-2010, MetaQuotes Software Corp.


1485 Standard Library

FindRev
Searches for the last match of a substring.

int  FindRev(
const string  substring  // Substring
) const;

Parameters
substring
[in] A substring to search for.

Returned value

The index of the last character that matches the requested substring; -1 if the substring is not
found.

© 2000-2010, MetaQuotes Software Corp.


1486 Standard Library

Remove
Deletes a substring from a string.

uint  Remove(
const string  substring  // Substring to remove
)

Parameters
substring
[in] A substring to search for.

Returned value

Number of substrings deleted.

© 2000-2010, MetaQuotes Software Corp.


1487 Standard Library

Replace
Replaces a substring from a string.

uint  Replace(
const string  substring,  // Substring to replace
const string  newstring  // New substring
)

Parameters
substring
[in] A substring to search for.

newstring
[in] A substring to replace for.

Returned value

Number of substrings replaced.

© 2000-2010, MetaQuotes Software Corp.


1488 Standard Library

Technical Indicators
This section contains the technical details of the technical indicator classes and description of the
corresponding components of the standard MQL5 library.

The use of the technical indicator classes will save time in developing applications (scripts, expert
advisors).

The standard library MQL5 is placed in the working directory of the terminal in the
Include\Indicators folder.

Class name/group Description

CIndicator base class Technical indicator base class

CIndicatorBuffer auxiliary class Technical indicator buffer class

Trend Indicators Group of Trend indicator classes

Oscillators Group of Oscillator indicator classes

Volume indicators Group of Volume indicator classes

Bill Williams Indicators Bill Williams indicator classes

CIndicators collection Technical indicator collection

© 2000-2010, MetaQuotes Software Corp.


1489 Standard Library

CIndicator
CIndicator is a base class for technical indicator classes of the standard MQL Library.

Description

Class CIndicator provides the simplified access for all of its descendants to MQL5 API technical
indicator functions.

Declaration
class CIndicator: public CArrayObj

Title
#include <Indicators\Indicator.mqh>

Class Methods

Attributes

Handle Returns the indicator's handle

Name Returns the indicator's name

Status Returns the indicator's status

NumBuffers Returns the number of buffers of the indicator

Timeframe Returns the indicator's timeframe flag

Symbol Returns the indicator's symbol

Period Returns the indicator's period

Create Methods

Create It creates the indicator with the specified


parameters.

BuffSize It defines the number of buffers for the


indicator

Data Access Methods

GetData It copies the data from the indicator's buffer

Update Methods

Refresh Updates the indicator data

Enumerations Conversion

PeriodStr Converts ENUM_TIMEFRAMES to string

MethodStr Converts ENUM_MA_METHOD to string

PriceStr Converts ENUM_APPLIED_PRICE to string

© 2000-2010, MetaQuotes Software Corp.


1490 Standard Library

VolumeStr Converts ENUM_APPLIED_VOLUME to string

© 2000-2010, MetaQuotes Software Corp.


1491 Standard Library

Handle
Returns the indicator's handle.

int  Handle() const

Returned value

Indicator's handle.

© 2000-2010, MetaQuotes Software Corp.


1492 Standard Library

Name
Returns the indicator's name.

string  Name() const

Returned value

Indicator's name.

© 2000-2010, MetaQuotes Software Corp.


1493 Standard Library

Status
Returns the indicator's status.

string  Status() const

Returned value

Indicator's status.

© 2000-2010, MetaQuotes Software Corp.


1494 Standard Library

NumBuffers
Returns the number of buffers of the indicator.

int  NumBuffers() const

Returned value

Number of buffers of the indicator.

© 2000-2010, MetaQuotes Software Corp.


1495 Standard Library

Timeframe
Returns the timeframe flag of the indicator.

int  Timeframe() const

Returned value

Indicator's timeframe flag.

Note

It forms as the object visibility flag.

© 2000-2010, MetaQuotes Software Corp.


1496 Standard Library

Symbol
Returns the symbol of the indicator.

string  Symbol() const

Returned value

Indicator's symbol.

© 2000-2010, MetaQuotes Software Corp.


1497 Standard Library

Period
Returns the period of the indicator.

ENUM_TIMEFRAMES  Period() const

Returned value

Indicator's period.

© 2000-2010, MetaQuotes Software Corp.


1498 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
ENUM_INDICATOR  type,  // Type
int  num_params,  // Number of parameters
MqlParam&  params[]  // reference to the array of parameters
)

Parameters
symbol
[in] Symbol name.

period
[in] Period.

type
[in] Indicator's type.

num_params
[in] Number of indicator's parameters.

params[]
[in] Reference to the parameters array for the indicator.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1499 Standard Library

BuffSize
It sets the size for the indicator's buffer.

void  BuffSize(
int  size  // buffer size
)

Parameters
size
[in] New buffer size.

Note

All the indicator's buffers will have the same size.

© 2000-2010, MetaQuotes Software Corp.


1500 Standard Library

GetData
Requests the data from the indicator's buffer by start position and number of necessary data.

bool  GetData(
int  start_pos,  // Start position
int  count,  // Number of elements
int  buffer_num,  // Buffer number
double&  buffer  // Target array for data
) const

Parameters
start_pos
[in] Start position of the indicator's buffer.

count
[in] Number of buffer elements to request.

buffer_num
[in] Number of the indicator's buffer.

buffer
[in] Reference to the target array for the data requested.

Returned value

true if successful, false if data hasn't been received.

GetData
Requests the data from the indicator's buffer by start time and number of necessary data.

bool  GetData(
datetime  start_time,  // Start time
int  count,  // Number of elements to request
int  buffer_num,  // Buffer number
double&  buffer  // Target array for data
) const

Parameters
start_time
[in] Start time of the indicator's buffer.

count
[in] Number of elements to request.

buffer_num
[in] Number of the indicator's buffer.

buffer
[in] Reference to the target array for the data requested.

© 2000-2010, MetaQuotes Software Corp.


1501 Standard Library

Returned value

true if successful, false if data hasn't been received.

GetData
Requests the data from the indicator's buffer by start and final time.

bool  GetData(
datetime  start_time,  // Start time
datetime  stop_time,  // Final time
int  buffer_num,  // Buffer number
double&  buffer  // Target array for data
) const

Parameters
start_time
[in] Start time.

stop_time
[in] Final time.

buffer_num
[in] Number of the indicator's buffer.

buffer
[in] Reference to the target array for the data requested.

Returned value

true if successful, false if data hasn't been received.

© 2000-2010, MetaQuotes Software Corp.


1502 Standard Library

Refresh
Updates the indicator's data.

void  Refresh(
int  flags  // Flags
)

Parameters
flags
[in] Timeframe update flags.

© 2000-2010, MetaQuotes Software Corp.


1503 Standard Library

PeriodStr
The function converts the value of the ENUM_TIMEFRAMES enumeration to string.

string  PeriodStr(
int  val  // Value
)

Parameters
val
[in] Value to convert.

Returned value

String, which corresponds to the value of the ENUM_TIMEFRAMES enumeration.

© 2000-2010, MetaQuotes Software Corp.


1504 Standard Library

MethodStr
The function converts the value of the ENUM_MA_METHOD enumeration to string.

string  MethodStr(
int  val  // Value
) const

Parameters
val
[in] Value to convert.

Returned value

String, which corresponds to the value of the ENUM_MA_METHOD enumeration.

© 2000-2010, MetaQuotes Software Corp.


1505 Standard Library

PriceStr
The function converts the value of the ENUM_APPLIED_PRICE enumeration to string.

string  PriceStr(
int  val  // Value
) const

Parameters
val
[in] Value to convert.

Returned value

String, which corresponds to the value of the ENUM_APPLIED_PRICE enumeration.

© 2000-2010, MetaQuotes Software Corp.


1506 Standard Library

VolumeStr
The function converts the value of the ENUM_APPLIED_VOLUME enumeration to string.

string  VolumeStr(
int  val  // Value
) const

Parameters
val
[in] Value to convert.

Returned value

String, which corresponds to the value of the ENUM_APPLIED_VOLUME enumeration.

© 2000-2010, MetaQuotes Software Corp.


1507 Standard Library

CIndicatorBuffer
The CIndicatorBuffer is a class for simplified access to the buffer data of the technical indicator.

Description

The class CIndicatorBuffer provides simplified access for all of its descendants to the buffer data of
the technical indicator.

Declaration
class CIndicatorBuffer: public CArrayDouble

Title
#include <Indicators\Indicator.mqh>

Class Methods

Attributes

Size It sets new buffer size for the indicator

Offset It gets/sets the buffer offset

Name It gets/sets the buffer name

Data Access Methods

At Returns the numerical value of buffer element


with the specified index

Data Update Methods

Refresh Updates all buffer elements

Refresh_0_only Updates only 0th (current) buffer element value

© 2000-2010, MetaQuotes Software Corp.


1508 Standard Library

Size
It sets new buffer size for the indicator.

void  Size(
int  size  // New buffer size
)

Parameters
size
[in] New buffer size.

© 2000-2010, MetaQuotes Software Corp.


1509 Standard Library

Offset (Get Method)


Returns the buffer offset.

int  Offset() const

Returned value

Buffer offset.

Offset (Set Method)


Sets the buffer offset.

void  Offset(
int  offset  // New offset
)

Parameters
offset
[in] New buffer offset.

© 2000-2010, MetaQuotes Software Corp.


1510 Standard Library

Name (Get Method)


Returns the buffer name.

string  Name() const

Returned value

Buffer name.

Name (Set Method)


Sets the buffer name.

void  Name(
string  name  // New buffer name
)

Parameters
name
[in] New buffer name.

© 2000-2010, MetaQuotes Software Corp.


1511 Standard Library

At
Returns the numerical value of buffer element with the specified index.

double  At(
int  index  // Index
) const

Returned value

Numerical value of buffer element.

© 2000-2010, MetaQuotes Software Corp.


1512 Standard Library

Refresh
Updates all buffer elements.

bool  Refresh(
int  handle,  // Indicator's handle
int  num  // Buffer number
)

Parameters
handle
[in] Indicator's handle.

num
[in] Indicator's buffer number.

Returned value

true if successful, false if buffer hasn't been updated.

© 2000-2010, MetaQuotes Software Corp.


1513 Standard Library

Refresh_0_only
Updates the 0th buffer element.

bool  Refresh_0_only(
int  handle,  // Indicator's handle
int  num  // Buffer number
)

Parameters
handle
[in] Indicator's handle.

num
[in] Indicator's buffer number.

Returned value

true if successful, false if buffer hasn't been updated.

© 2000-2010, MetaQuotes Software Corp.


1514 Standard Library

Trend Indicator Classes


This group of chapters contains technical details of Trend Indicator classes of the standard library
MQL5 and descriptions of all its key components.

Class Description

CiADX Average Directional Index

CiADXWilder Average Directional Index by Welles Wilder

CiBands Bollinger Bands

CiEnvelopes Envelopes

CiIchimoku Ichimoku Kinko Hyo

CiMA Moving Average

CiSAR Parabolic Stop And Reverse System

CiStdDev Standard Deviation

CiDEMA Double Exponential Moving Average

CiTEMA Triple Exponential Moving Average

CiFrAMA Fractal Adaptive Moving Average

CiAMA Adaptive Moving Average

CiVIDyA Variable Index Dynamic Average

© 2000-2010, MetaQuotes Software Corp.


1515 Standard Library

CiADX
The CiADX is a class intended for using the Average Directional Index technical indicator.

Description

The CiADX class provides the creation and access to the data of the Average Directional Index
indicator.

Declaration
class CiADX: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the main line

Plus Returns the buffer element of the +DI line

Minus Returns the buffer element of the -DI line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1516 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1517 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1518 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1519 Standard Library

Plus
Returns the buffer element of the +DI line by the specified index.

double  Plus(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the +DI line of the specified index, or EMPTY_VALUE if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1520 Standard Library

Minus
Returns the buffer element of the -DI line by the specified index.

double  Minus(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the -DI line of the specified index, or EMPTY_VALUE if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1521 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ADX for CiADX).

© 2000-2010, MetaQuotes Software Corp.


1522 Standard Library

CiADXWilder
The CiADXWilder is a class intended for using the Average Directional Index by Welles Wilder
technical indicator.

Description

The CiADXWilder class provides the creation and access to the data of the Average Directional Index
by Welles Wilder indicator.

Declaration
class CiADXWilder: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the main line

Plus Returns the buffer element of the +DI line

Minus Returns the buffer element of the -DI line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1523 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1524 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1525 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1526 Standard Library

Plus
Returns the buffer element of the +DI line by the specified index.

double  Plus(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the +DI line of the specified index, or EMPTY_VALUE if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1527 Standard Library

Minus
Returns the buffer element of the -DI line by the specified index.

double  Minus(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the -DI line of the specified index, or EMPTY_VALUE if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1528 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ADXW for CiADXWilder).

© 2000-2010, MetaQuotes Software Corp.


1529 Standard Library

CiBands
The CiBands is a class intended for using the Bollinger Bands technical indicator.

Description

The CiBands class provides the creation and access to the data of the Bollinger Bands indicator.

Declaration
class CiBands: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

MaShift Returns the horizontal shift

Deviation Returns the deviation

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the base line

Upper Returns the buffer element of the upper line

Lower Returns the buffer element of the lower line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1530 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1531 Standard Library

MaShift
Returns the horizontal shift of the indicator.

int  MaShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1532 Standard Library

Deviation
Returns the deviation.

double  Deviation() const

Returned value

Returns the deviation, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1533 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1534 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Shift
double  deviation,  // Deviation
int  applied  // applied price, or handle
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift of the indicator.

deviation
[in] Deviation.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1535 Standard Library

Base
Returns the buffer element of the base line by the specified index.

double  Base(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the Base line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1536 Standard Library

Upper
Returns the buffer element of the upper line by the specified index.

double  Upper(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the upper line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1537 Standard Library

Lower
Returns the buffer element of the lower line by the specified index.

double  Lower(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the lower line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1538 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_BANDS for CiBands).

© 2000-2010, MetaQuotes Software Corp.


1539 Standard Library

CiEnvelopes
The CiEnvelopes is a class intended for using the Envelopes technical indicator.

Description

The CiEnvelopes class provides the creation and access to the data of the Envelopes indicator.

Declaration
class CiEnvelopes: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

MaShift Returns the horizontal shift

MaMethod Returns the averaging method

Deviation Returns the deviation

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Upper Returns the buffer element of the upper line

Lower Returns the buffer element of the lower line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1540 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1541 Standard Library

MaShift
Returns the horizontal shift of the indicator.

int  MaShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1542 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1543 Standard Library

Deviation
Returns the value of deviation.

double  Deviation() const

Returned value

Returns the value of deviation, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1544 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1545 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Horizontal shift
ENUM_MA_METHOD  ma_method,  // Averaging method
int  applied,  // Price type or handle to apply
double  deviation  // Deviation
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift.

ma_method
[in] Averaging method.

applied
[in] Price type of handle to apply.

deviation
[in] Deviation.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1546 Standard Library

Upper
Returns the buffer element of the upper line by the specified index.

double  Upper(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the upper line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1547 Standard Library

Lower
Returns the buffer element of the lower line by the specified index.

double  Lower(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the lower line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1548 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ENVELOPES for CiEnvelopes).

© 2000-2010, MetaQuotes Software Corp.


1549 Standard Library

CiIchimoku
The CiIchimoku is a class intended for using the Ichimoku Kinko Hyo technical indicator.

Description

The CiIchimoku class provides the creation, setup and access to the data of the Ichimoku Kinko Hyo
indicator.

Declaration
class CiIchimoku: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

TenkanSenPeriod Returns the TenkanSen period

KijunSenPeriod Returns the KijunSen period

SenkouSpanBPeriod Returns the SenkouSpanB period

Create Methods

Create Creates the indicator

Data Access Methods

TenkanSen Returns the buffer element of the TenkanSen


line

KijunSen Returns the buffer element of the KijunSen line

SenkouSpanA Returns the buffer element of the SenkouSpanA


line

SenkouSpanB Returns the buffer element of the SenkouSpanB


line

ChinkouSpan Returns the buffer element of the ChinkouSpan


line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1550 Standard Library

TenkanSenPeriod
Returns the TenkanSen period.

int  TenkanSenPeriod() const

Returned value

Returns the TenkanSen period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1551 Standard Library

KijunSenPeriod
Returns the KijunSen period.

int  KijunSenPeriod() const

Returned value

Returns the KijunSen period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1552 Standard Library

SenkouSpanBPeriod
Returns the SenkouSpanB period.

int  SenkouSpanBPeriod() const

Returned value

Returns the SenkouSpanB period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1553 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  tenkan_sen,  // Period of TenkanSen
int  kijun_sen,  // Period of KijunSen
int  senkou_span_b  // Period of SenkouSpanB
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

tenkan_sen
[in] Period of TenkanSen.

kijun_sen
[in] Period of KijunSen.

senkou_span_b
[in] Period of SenkouSpanB.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1554 Standard Library

TenkanSen
Returns the buffer element of the TenkanSen line by the specified index.

double  TenkanSen(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the TenkanSen line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1555 Standard Library

KijunSen
Returns the buffer element of the KijunSen line by the specified index.

double  KijunSen(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the KijunSen line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1556 Standard Library

SenkouSpanA
Returns the buffer element of the SenkouSpanA line by the specified index.

double  SenkouSpanA(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the SenkouSpanA line of the specified index, or EMPTY_VALUE if there isn't
any correct data.

© 2000-2010, MetaQuotes Software Corp.


1557 Standard Library

SenkouSpanB
Returns the buffer element of the SenkouSpanB line by the specified index.

double  SenkouSpanB(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the SenkouSpanB line of the specified index, or EMPTY_VALUE if there isn't
any correct data.

© 2000-2010, MetaQuotes Software Corp.


1558 Standard Library

ChinkouSpan
Returns the buffer element of the ChinkouSpan line by the specified index.

double  ChinkouSpan(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the ChinkouSpan line of the specified index, or EMPTY_VALUE if there isn't
any correct data.

© 2000-2010, MetaQuotes Software Corp.


1559 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ICHIMOKU for CiIchimoku).

© 2000-2010, MetaQuotes Software Corp.


1560 Standard Library

CiMA
The CiMA is a class intended for using the Moving Average technical indicator.

Description

The CiMA class provides the creation, setup and access to the data of the Moving Average
indicator.

Declaration
class CiMA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

MaShift Returns the horizontal shift

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1561 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1562 Standard Library

MaShift
Returns the horizontal shift of the indicator.

int  MaShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1563 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1564 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1565 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  string,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Horizontal shift
ENUM_MA_METHOD  ma_method,  // Averaging method
int  applied  // Price type of handle to apply
)

Parameters
string
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift.

ma_method
[in] Averaging method.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1566 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1567 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_MA for CiMA).

© 2000-2010, MetaQuotes Software Corp.


1568 Standard Library

CiSAR
The CiSAR is a class intended for using the Parabolic Stop And Reverse System technical indicator.

Description

The CiSAR class provides the creation, setup and access to the data of the Parabolic Stop And
Reverse System indicator.

Declaration
class CiSAR: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

SarStep Returns the step for the velocity increasing

Maximum Returns the coefficient of price following

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1569 Standard Library

SarStep
Returns the step for the velocity increasing (acceleration coefficient).

double  SarStep() const

Returned value

The step for the velocity increasing, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1570 Standard Library

Maximum
Returns the coefficient of price following.

double  Maximum() const

Returned value

The price following coefficient, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1571 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
double  step,  // Step
double  maximum  // Coefficient
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

step
[in] Step for the velocity increasing.

maximum
[in] Price following coefficient.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1572 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1573 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_SAR for CiSAR).

© 2000-2010, MetaQuotes Software Corp.


1574 Standard Library

CiStdDev
The CiStdDev is a class intended for using the Standard Deviation technical indicator.

Description

The CiStdDev class provides the creation, setup and access to the data of the Standard Deviation
indicator.

Declaration
class CiStdDev: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

MaShift Returns the horizontal shift

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1575 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1576 Standard Library

MaShift
Returns the horizontal shift of the indicator.

int  MaShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1577 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1578 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1579 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Horizontal shift
ENUM_MA_METHOD  ma_method,  // Averaging method
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift.

ma_method
[in] Averaging method.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1580 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1581 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_STDDEV for CiStdDev).

© 2000-2010, MetaQuotes Software Corp.


1582 Standard Library

CiDEMA
The CiDEMA is a class intended for using the Double Exponential Moving Average technical
indicator.

Description

The CiDEMA class provides the creation, setup and access to the data of the Double Exponential
Moving Average indicator.

Declaration
class CiDEMA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

IndShift Returns the horizontal shift

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1583 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1584 Standard Library

IndShift
Returns the horizontal shift of the indicator.

int  IndShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1585 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1586 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  string,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ind_shift,  // Shift
int  applied  // Price type of handle to apply
)

Parameters
string
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ind_shift
[in] Horizontal shift.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1587 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1588 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_DEMA for CiDEMA).

© 2000-2010, MetaQuotes Software Corp.


1589 Standard Library

CiTEMA
The CiTEMA is a class intended for using the Triple Exponential Moving Average technical indicator.

Description

The CiTEMA class provides the creation, setup and access to the data of the Triple Exponential
Moving Average indicator.

Declaration
class CiTEMA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

IndShift Returns the horizontal shift

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1590 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1591 Standard Library

IndShift
Returns the horizontal shift of the indicator.

int  IndShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1592 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1593 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Offset
int  applied  // Price type of handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1594 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1595 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_TEMA for CiTEMA).

© 2000-2010, MetaQuotes Software Corp.


1596 Standard Library

CiFrAMA
The CiFrAMA is a class intended for using the Fractal Adaptive Moving Average technical indicator.

Description

The CiFrAMA class provides the creation, setup and access to the data of the Fractal Adaptive
Moving Average indicator.

Declaration
class CiFrAMA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

IndShift Returns the horizontal shift

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1597 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1598 Standard Library

IndShift
Returns the horizontal shift of the indicator.

int  IndShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1599 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1600 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  ma_shift,  // Offset
int  applied  // Price type of handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_shift
[in] Horizontal shift.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1601 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1602 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_FRAMA for CiFrAMA).

© 2000-2010, MetaQuotes Software Corp.


1603 Standard Library

CiAMA
The CiAMA is a class intended for using the Adaptive Moving Average technical indicator.

Description

The CiAMA class provides the creation, setup and access to the data of the Adaptive Moving
Average indicator.

Declaration
class CiAMA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

FastEmaPeriod Returns the averaging period for the fast EMA

SlowEmaPeriod Returns the averaging period for the slow EMA

IndShift Returns the horizontal shift

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1604 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1605 Standard Library

FastEmaPeriod
Returns the averaging period for the fast EMA.

int  FastEmaPeriod() const

Returned value

Returns the averaging period for the fast EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1606 Standard Library

SlowEmaPeriod
Returns the averaging period for the slow EMA.

int  SlowEmaPeriod() const

Returned value

Returns the averaging period for the slow EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1607 Standard Library

IndShift
Returns the horizontal shift of the indicator.

int  IndShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1608 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1609 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  string,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  fast_ema_period,  // Fast EMA period
int  slow_ema_period,  // Slow EMA period
int  ind_shift,  // Shift
int  applied  // Price type or handle to apply
)

Parameters
string
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

fast_ema_period
[in] Fast EMA averaging period.

slow_ema_period
[in] Slow EMA averaging period.

ind_shift
[in] Horizontal shift.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1610 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1611 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_AMA for CiAMA).

© 2000-2010, MetaQuotes Software Corp.


1612 Standard Library

CiVIDyA
The CiVIDyA is a class intended for using the Variable Index DYnamic Average technical indicator.

Description

The CiVIDyA class provides the creation, setup and access to the data of the Variable Index DYnamic
Average indicator.

Declaration
class CiVIDyA: public CIndicator

Title
#include <Indicators\Trend.mqh>

Class Methods

Attributes

CmoPeriod Returns the period for Momentum

EmaPeriod Returns the averaging period for EMA

IndShift Returns the horizontal shift

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1613 Standard Library

CmoPeriod
Returns the period for Momentum.

int  CmoPeriod() const

Returned value

Returns the period for Momentum, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1614 Standard Library

EmaPeriod
Returns the averaging period for EMA.

int  EmaPeriod() const

Returned value

Returns the averaging period for EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1615 Standard Library

IndShift
Returns the horizontal shift of the indicator.

int  IndShift() const

Returned value

Returns the horizontal shift value, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1616 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1617 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  cmo_period,  // Momentum period
int  ema_period,  // Averaging period
int  ind_shift,  // Shift
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

cmo_period
[in] Momentum period.

ema_period
[in] Averaging period.

ind_shift
[in] Horizontal shift.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1618 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1619 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_VIDYA for CiVIDyA).

© 2000-2010, MetaQuotes Software Corp.


1620 Standard Library

Oscillators
This group of chapters contains the technical details of Oscillators classes of the standard library
MQL5 and descriptions of all its key components.

Class Description

CiATR Average True Range

CiBearsPower Bears Power

CiBullsPower Bulls Power

CiCCI Commodity Channel Index

CiChaikin Chaikin Oscillator

CiDeMarker DeMarker

CiForce Force Index

CiMACD Moving Averages Convergence-Divergence

CiMomentum Momentum

CiOsMA Moving Average of Oscillator (MACD histogram)

CiRSI Relative Strength Index

CiRVI Relative Vigor Index

CiStochastic Stochastic Oscillator

CiWPR Williams' Percent Range

CiTriX Triple Exponential Moving Averages Oscillator

© 2000-2010, MetaQuotes Software Corp.


1621 Standard Library

CiATR
The CiATR is a class intended for using the Average True Range technical indicator.

Description

The CiATR class provides the creation, setup and access to the data of the Average True Range
indicator.

Declaration
class CiATR: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1622 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1623 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1624 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1625 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ATR for CiATR).

© 2000-2010, MetaQuotes Software Corp.


1626 Standard Library

CiBearsPower
The CiBearsPower is a class intended for using the Bears Power technical indicator.

Description

The CiBearsPower class provides the creation, setup and access to the data of the Bears Power
indicator.

Declaration
class CiBearsPower: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1627 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1628 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1629 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1630 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_BEARS for CiBearsPower).

© 2000-2010, MetaQuotes Software Corp.


1631 Standard Library

CiBullsPower
The CiBullsPower is a class intended for using the Bulls Power technical indicator.

Description

The CiBullsPower class provides the creation, setup and access to the data of the Bulls Power
indicator.

Declaration
class CiBullsPower: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1632 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1633 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1634 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1635 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_BULLS for CiBullsPower).

© 2000-2010, MetaQuotes Software Corp.


1636 Standard Library

CiCCI
The CiCCI is a class intended for using the Commodity Channel Index technical indicator.

Description

The CiCCI class provides the creation, setup and access to the data of the Commodity Channel Index
indicator.

Declaration
class CiCCI: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1637 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1638 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1639 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1640 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1641 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_CCI for CiCCI).

© 2000-2010, MetaQuotes Software Corp.


1642 Standard Library

CiChaikin
The CiChaikin is a class intended for using the Chaikin Oscillator technical indicator.

Description

The CiChaikin class provides the creation, setup and access to the data of the Chaikin Oscillator
indicator.

Declaration
class CiChaikin: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

FastMaPeriod Returns the averaging period for the fast MA

SlowMaPeriod Returns the averaging period for the slow MA

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1643 Standard Library

FastMaPeriod
Returns the averaging period for the fast EMA.

int  FastMaPeriod() const

Returned value

Returns the averaging period for the fast EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1644 Standard Library

SlowMaPeriod
Returns the averaging period for the slow EMA.

int  SlowMaPeriod() const

Returned value

Returns the averaging period for the slow EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1645 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1646 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1647 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  fast_ma_period,  // Fast EMA period
int  slow_ma_period,  // Slow EMA period
ENUM_MA_METHOD  ma_method,  // Averaging method
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

fast_ma_period
[in] Period for fast EMA.

slow_ma_period
[in] Period for slow EMA.

ma_method
[in] Averaging method.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1648 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1649 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_CHAIKIN for CiChaikin).

© 2000-2010, MetaQuotes Software Corp.


1650 Standard Library

CiDeMarker
The CiDeMarker is a class intended for using the DeMarker technical indicator.

Description

The CiDeMarker class provides the creation, setup and access to the data of the DeMarker
indicator.

Declaration
class CiDeMarker: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1651 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1652 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1653 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1654 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_DEMARKER for CiDeMarker).

© 2000-2010, MetaQuotes Software Corp.


1655 Standard Library

CiForce
The CiForce is a class intended for using the Force Index technical indicator.

Description

The CiForce class provides the creation, setup and access to the data of the Force Index indicator.

Declaration
class CiForce: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1656 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1657 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1658 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1659 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
ENUM_MA_METHOD  ma_method,  // Averaging method
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

ma_method
[in] Averaging method.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1660 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1661 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_FORCE for CiForce).

© 2000-2010, MetaQuotes Software Corp.


1662 Standard Library

CiMACD
The CiMACD is a class intended for using the Moving Averages Convergence-Divergence technical
indicator.

Description

The CiMACD class provides the creation, setup and access to the data of the Moving Averages
Convergence-Divergence indicator.

Declaration
class CiMACD: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

FastEmaPeriod Returns the averaging period fofor the fast


EMA

SlowEmaPeriod Returns the averaging period of the slow EMA

SignalPeriod Returns the averaging period of the signal line

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the main line

Signal Returns the buffer element of the signal line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1663 Standard Library

FastEmaPeriod
Returns the averaging period for the fast EMA.

int  FastEmaPeriod() const

Returned value

Returns the averaging period for the fast EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1664 Standard Library

SlowEmaPeriod
Returns the averaging period for the slow EMA.

int  SlowEmaPeriod() const

Returned value

Returns the averaging period for the slow EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1665 Standard Library

SignalPeriod
Returns the averaging period for the signal line.

int  SignalPeriod() const

Returned value

Returns the averaging period for the signal line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1666 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1667 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  fast_ema_period,  // Fast EMA period
int  slow_ema_period,  // Slow EMA period
int  signal_period,  // Signal period
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

fast_ema_period
[in] Fast EMA period.

slow_ema_period
[in] Slow EMA period.

signal_period
[in] Signal line period.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1668 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1669 Standard Library

Signal
Returns the buffer element of the signal line by the specified index.

double  Signal(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the signal line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1670 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_MACD for CiMACD).

© 2000-2010, MetaQuotes Software Corp.


1671 Standard Library

CiMomentum
The CiMomentum is a class intended for using the Momentum technical indicator.

Description

The CiMomentum class provides the creation, setup and access to the data of the Momentum
indicator.

Declaration
class CiMomentum: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1672 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1673 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1674 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1675 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1676 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_MOMENTUM for CiMomentum).

© 2000-2010, MetaQuotes Software Corp.


1677 Standard Library

CiOsMA
The CiOsMA is a class intended for using the Moving Average of Oscillator (MACD histogram)
technical indicator.

Description

The CiOsMA class provides the creation, setup and access to the data of the Moving Average of
Oscillator (MACD histogram) indicator.

Declaration
class CiOsMA: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

FastEmaPeriod Returns the averaging period of the fast EMA

SlowEmaPeriod Returns the averaging period of the slow EMA

SignalPeriod Returns the averaging period of the signal line

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1678 Standard Library

FastEmaPeriod
Returns the averaging period for the fast EMA.

int  FastEmaPeriod() const

Returned value

Returns the averaging period for the fast EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1679 Standard Library

SlowEmaPeriod
Returns the averaging period for the slow EMA.

int  SlowEmaPeriod() const

Returned value

Returns the averaging period for the slow EMA, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1680 Standard Library

SignalPeriod
Returns the averaging period for the signal line.

int  SignalPeriod() const

Returned value

Returns the averaging period for the signal line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1681 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1682 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  fast_ema_period,  // Fast EMA period
int  slow_ema_period,  // Slow EMA period
int  signal_period,  // Signal line period
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

fast_ema_period
[in] Fast EMA period.

slow_ema_period
[in] Slow EMA period.

signal_period
[in] Signal line period.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1683 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1684 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_OSMA for CiOsMA).

© 2000-2010, MetaQuotes Software Corp.


1685 Standard Library

CiRSI
The CiRSI is a class intended for using the Relative Strength Index technical indicator.

Description

The CiRSI class provides the creation, setup and access to the data of the Relative Strength Index
indicator.

Declaration
class CiRSI: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1686 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1687 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1688 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  applied  // Price type or handle to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

applied
[in] Price type or handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1689 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1690 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_RSI for CiRSI).

© 2000-2010, MetaQuotes Software Corp.


1691 Standard Library

CiRVI
The CiRVI is a class intended for using the Relative Vigor Index technical indicator.

Description

The CiRVI class provides the creation, setup and access to the data of the Relative Vigor Index
indicator.

Declaration
class CiRVI: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the base line

Signal Returns the buffer element of the signal line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1692 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1693 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period  // Averaging period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1694 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1695 Standard Library

Signal
Returns the buffer element of the signal line by the specified index.

double  Signal(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the signal line of the specified index, or DBL_MAX if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1696 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_RVI for CiRVI).

© 2000-2010, MetaQuotes Software Corp.


1697 Standard Library

CiStochastic
The CiStochastic is a class intended for using the Stochastic Oscillator technical indicator.

Description

The CiStochastic class provides the creation, setup and access to the data of the Stochastic
Oscillator indicator.

Declaration
class CiStochastic: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

Kperiod Returns the averaging period for the %K line

Dperiod Returns the averaging period for the %D line

Slowing Returns the slowing period

MaMethod Returns the averaging method

PriceField Price type (Low/High ore Close/Close) to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element of the base line

Signal Returns the buffer element of the signal line

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1698 Standard Library

Kperiod
Returns the averaging period for the %K line.

int  Kperiod() const

Returned value

Returns the averaging period for the %K line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1699 Standard Library

Dperiod
Returns the averaging period for the %D line.

int  Dperiod() const

Returned value

Returns the averaging period for the %D line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1700 Standard Library

Slowing
Returns the period of slowing.

int  Slowing() const

Returned value

Returns the period of slowing, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1701 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1702 Standard Library

PriceField
Returns the price type (Low/High or Close/Close) to apply.

ENUM_STO_PRICE  PriceField() const

Returned value

The price type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1703 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  Kperiod,  // Averaging period of %K
int  Dperiod,  // Averaging period of %D
int  slowing,  // Slowing period
ENUM_MA_METHOD  ma_method,  // Averaging method
ENUM_STO_PRICE  price_field  // Price type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

Kperiod
[in] Averaging period of %K line.

Dperiod
[in] Averaging period of %D line.

slowing
[in] Slowing period.

ma_method
[in] Averaging period.

price_field
[in] Price type (Low/High or Close/Close) to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1704 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1705 Standard Library

Signal
Returns the buffer element of the signal line by the specified index.

double  Signal(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Signal
Returns the buffer element of the signal line by the specified index.

double  Signal(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the signal line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1706 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_STOCHASTIC for CiStochastic).

© 2000-2010, MetaQuotes Software Corp.


1707 Standard Library

CiWPR
The CiWPR is a class intended for using the Williams' Percent Range technical indicator.

Description

The CiWPR class provides the creation, setup and access to the data of the Williams' Percent Range
indicator.

Declaration
class CiWPR: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

CalcPeriod Returns the calculation period

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1708 Standard Library

CalcPeriod
Returns the period for calculation.

int  CalcPeriod() const

Returned value

Returns the the period for calculation, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1709 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  calc_period  // Calculation period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

calc_period
[in] Period for calculation.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1710 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1711 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_WPR for CiWPR).

© 2000-2010, MetaQuotes Software Corp.


1712 Standard Library

CiTriX
The CiTriX is a class intended for using the Triple Exponential Moving Averages Oscillator technical
indicator.

Description

The CiTriX class provides the creation, setup and access to the data of the Triple Exponential
Moving Averages Oscillator indicator.

Declaration
class CiTriX: public CIndicator

Title
#include <Indicators\Oscilators.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1713 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1714 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1715 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
int  applied  // Price type or handle
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

applied
[in] Price type of handle to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1716 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1717 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_TRIX for CiTriX).

© 2000-2010, MetaQuotes Software Corp.


1718 Standard Library

Volume Indicators
This group of chapters contains technical details of Volume Indicator classes of the standard library
MQL5 and descriptions of all its key components.

Class Description

CiAD Accumulation/Distribution

CiMFI Money Flow Index

CiOBV On Balance Volume

CiVolumes Volumes

© 2000-2010, MetaQuotes Software Corp.


1719 Standard Library

CiAD
The CiAD is a class intended for using the Accumulation/Distribution technical indicator.

Description

The CiAD class provides the creation, setup and access to the data of the Accumulation/Distribution
indicator.

Declaration
class CiAD: public CIndicator

Title
#include <Indicators\Volumes.mqh>

Class Methods

Attributes

Applied Returns the volume type to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1720 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1721 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1722 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1723 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_AD for CiAD).

© 2000-2010, MetaQuotes Software Corp.


1724 Standard Library

CiMFI
The CiMFI is a class intended for using the Money Flow Index technical indicator.

Description

The CiMFI class provides the creation, setup and access to the data of the Money Flow Index
indicator.

Declaration
class CiMFI: public CIndicator

Title
#include <Indicators\Volumes.mqh>

Class Methods

Attributes

MaPeriod Returns the averaging period

Applied Returns the volume type to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1725 Standard Library

MaPeriod
Returns the averaging period.

int  MaPeriod() const

Returned value

Returns the averaging period, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1726 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1727 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  ma_period,  // Averaging period
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

ma_period
[in] Averaging period.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1728 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1729 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_MFI for CiMFI).

© 2000-2010, MetaQuotes Software Corp.


1730 Standard Library

CiOBV
The CiOBV is a class intended for using the On Balance Volume technical indicator.

Description

The CiOBV class provides the creation, setup and access to the data of the On Balance Volume
indicator.

Declaration
class CiOBV: public CIndicator

Title
#include <Indicators\Volumes.mqh>

Class Methods

Attributes

Applied Returns the volume type to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1731 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1732 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1733 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1734 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_OBV for CiOBV).

© 2000-2010, MetaQuotes Software Corp.


1735 Standard Library

CiVolumes
The CiVolumes is a class intended for using the Volumes technical indicator.

Description

The CiVolumes class provides the creation, setup and access to the data of the Volumes indicator.

Declaration
class CiVolumes: public CIndicator

Title
#include <Indicators\Volumes.mqh>

Class Methods

Attributes

Applied Returns the volume type to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1736 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1737 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1738 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1739 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_VOLUMES for CiVolumes).

© 2000-2010, MetaQuotes Software Corp.


1740 Standard Library

Bill Williams Indicators


This group of chapters contains technical details of Bill Williams Indicator classes of the standard
library MQL5 and descriptions of all its key components.

Class Description

CiAC Accelerator Oscillator

CiAlligator Alligator

CiAO Awesome Oscillator

CiFractals Fractals

CiGator Gator Oscillator

CiBWMFI Market Facilitation Index

© 2000-2010, MetaQuotes Software Corp.


1741 Standard Library

CiAC
The CiAC is a class intended for using the Accelerator Oscillator technical indicator.

Description

The CiAC class provides the creation, setup and access to the data of the Accelerator Oscillator
indicator.

Declaration
class CiAC: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1742 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period  // Period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1743 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1744 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_AC for CiAC).

© 2000-2010, MetaQuotes Software Corp.


1745 Standard Library

CiAlligator
The CiAlligator is a class intended for using the Alligator technical indicator.

Description

The CiAlligator class provides the creation, setup and access to the data of the Alligator indicator.

Declaration
class CiAlligator: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Attributes

JawPeriod Returns the averaging period for the Jaws line

JawShift Returns the horizontal shift of the Jaws line

TeethPeriod Returns the averaging period for the Teeths


line

TeethShift Returns the horizontal shift of the Teeths line

LipsPeriod Returns the averaging period for the Lips line

LipsShift Returns the horizontal shift of the Lips line

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Jaw Returns the buffer element of the Jaws line


buffer

Teeth Returns the buffer element of the Teeths line


buffer

Lips Returns the buffer element of the Lips line


buffer

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1746 Standard Library

JawPeriod
Returns the averaging period for the Jaw line.

int  JawPeriod() const

Returned value

Returns the averaging period for the Jaw line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1747 Standard Library

JawShift
Returns the horizontal shift of the Jaws line.

int  JawShift() const

Returned value

Horizontal shift of the Jaws line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1748 Standard Library

TeethPeriod
Returns the averaging period for the Teeth line.

int  TeethPeriod() const

Returned value

Returns the averaging period for the Teeth line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1749 Standard Library

TeethShift
Returns the horizontal shift of the Teeths line.

int  TeethShift() const

Returned value

Horizontal shift of the Teeths line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1750 Standard Library

LipsPeriod
Returns the averaging period for the Lips line.

int  LipsPeriod() const

Returned value

Returns the averaging period for the Lips line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1751 Standard Library

LipsShift
Returns the horizontal shift of the Lips line.

int  LipsShift() const

Returned value

Horizontal shift of the Lips line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1752 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1753 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1754 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  jaw_period,  // Jaws period
int  jaw_shift,  // Jaws shift
int  teeth_period,  // Teeths period
int  teeth_shift,  // Teeths shift
int  lips_period,  // Lips period
int  lips_shift,  // Lips shift
ENUM_MA_METHOD  ma_method,  // Averaging method
int  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

jaw_period
[in] Jaws period.

jaw_shift
[in] Jaws shift.

teeth_period
[in] Teeths period.

teeth_shift
[in] Teeths shift.

lips_period
[in] Lips period.

lips_shift
[in] Lips shift.

ma_method
[in] Moving average method.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1755 Standard Library

Jaw
Returns the buffer element of the Jaws line by the specified index.

double  Jaw(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the Jaws line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1756 Standard Library

Teeth
Returns the buffer element of the Teeths line by the specified index.

double  Teeth(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the Teeths line of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1757 Standard Library

Lips
Returns the buffer element of the Lips line by the specified index.

double  Lips(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the Lips line of the specified index, or EMPTY_VALUE if there isn't any correct
data.

© 2000-2010, MetaQuotes Software Corp.


1758 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_ALLIGATOR for CiAlligator).

© 2000-2010, MetaQuotes Software Corp.


1759 Standard Library

CiAO
The CiAO is a class intended for using the Awesome Oscillator technical indicator.

Description

The CiAO class provides the creation, setup and access to the data of the Awesome Oscillator
indicator.

Declaration
class CiAO: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1760 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period  // Period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1761 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1762 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_AO for CiAO).

© 2000-2010, MetaQuotes Software Corp.


1763 Standard Library

CiFractals
The CiFractals is a class intended for using the Fractals technical indicator.

Description

The CiFractals class provides the creation, setup and access to the data of the Fractals indicator.

Declaration
class CiFractals: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Create Methods

Create Creates the indicator

Data Access Methods

Upper Returns the buffer element of the upper buffer

Lower Returns the buffer element of the lower buffer

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1764 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period  // Period
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1765 Standard Library

Upper
Returns the buffer element of the upper buffer by the specified index.

double  Upper(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the upper buffer of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1766 Standard Library

Lower
Returns the buffer element of the lower buffer by the specified index.

double  Lower(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the lower buffer of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1767 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_FRACTALS for CiFractals).

© 2000-2010, MetaQuotes Software Corp.


1768 Standard Library

CiGator
The CiGator is a class intended for using the Gator Oscillator technical indicator.

Description

The CiGator class provides the creation, setup and access to the data of the Gator Oscillator
indicator.

Declaration
class CiGator: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Attributes

JawPeriod Returns the averaging period for the Jaws line

JawShift Returns the horizontal shift of the Jaws line

TeethPeriod Returns the averaging period for the Teeths


line

TeethShift Returns the horizontal shift of the Teeths line

LipsPeriod Returns the averaging period for the Lips line

LipsShift Returns the horizontal shift of the Lips line

MaMethod Returns the averaging method

Applied Returns the price type or handle to apply

Create Methods

Create Creates the indicator

Data Access Methods

Upper Returns the buffer element of the upper buffer

Lower Returns the buffer element of the lower buffer

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1769 Standard Library

JawPeriod
Returns the averaging period for the Jaws line.

int  JawPeriod() const

Returned value

Returns the averaging period for the Jaws line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1770 Standard Library

JawShift
Returns the horizontal shift of the Jaws line.

int  JawShift() const

Returned value

Horizontal shift of the Jaws line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1771 Standard Library

TeethPeriod
Returns the averaging period for the Teeth line.

int  TeethPeriod() const

Returned value

Returns the averaging period for the Teeth line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1772 Standard Library

TeethShift
Returns the horizontal shift of the Teeths line.

int  TeethShift() const

Returned value

Horizontal shift of the Teeths line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1773 Standard Library

LipsPeriod
Returns the averaging period for the Lips line.

int  LipsPeriod() const

Returned value

Returns the averaging period for the Lips line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1774 Standard Library

LipsShift
Returns the horizontal shift of the Lips line.

int  LipsShift() const

Returned value

Horizontal shift of the Lips line, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1775 Standard Library

MaMethod
Returns the averaging method.

ENUM_MA_METHOD  MaMethod() const

Returned value

Returns the averaging method, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1776 Standard Library

Applied
Returns the price type or handle to apply.

int  Applied() const

Returned value

Price type or handle to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1777 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
int  jaw_period,  // Jaws period
int  jaw_shift,  // Jaws shift
int  teeth_period,  // Teeths period
int  teeth_shift,  // Teeths shift
int  lips_period,  // Lips period
int  lips_shift,  // Lips shift
ENUM_MA_METHOD  ma_method,  // Averaging method
int  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

jaw_period
[in] Jaws period.

jaw_shift
[in] Jaws shift.

teeth_period
[in] Teeths period.

teeth_shift
[in] Teeths shift.

lips_period
[in] Lips period.

lips_shift
[in] Lips shift.

ma_method
[in] Averaging method.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1778 Standard Library

Upper
Returns the buffer element of the upper buffer by the specified index.

double  Upper(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the upper buffer of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1779 Standard Library

Lower
Returns the buffer element of the lower buffer by the specified index.

double  Upper(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

The buffer element of the lower buffer of the specified index, or EMPTY_VALUE if there isn't any
correct data.

© 2000-2010, MetaQuotes Software Corp.


1780 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_GATOR for CiGator).

© 2000-2010, MetaQuotes Software Corp.


1781 Standard Library

CiBWMFI
The CiBWMFI is a class intended for using the Market Facilitation Index by Bill Williams technical
indicator.

Description

The CiBWMFI class provides the creation, setup and access to the data of the Market Facilitation
Index by Bill Williams indicator.

Declaration
class CiBWMFI: public CIndicator

Title
#include <Indicators\BillWilliams.mqh>

Class Methods

Attributes

Applied Returns the volume type to apply

Create Methods

Create Creates the indicator

Data Access Methods

Main Returns the buffer element

Input/output

Type Returns the object type identifier

© 2000-2010, MetaQuotes Software Corp.


1782 Standard Library

Applied
Returns the volume type to apply.

ENUM_APPLIED_VOLUME  Applied() const

Returned value

Volume type to apply, defined at the indicator creation.

© 2000-2010, MetaQuotes Software Corp.


1783 Standard Library

Create
It creates the indicator with specified parameters.

bool  Create(
string  symbol,  // Symbol
ENUM_TIMEFRAMES  period,  // Period
ENUM_APPLIED_VOLUME  applied  // Volume type to apply
)

Parameters
symbol
[in] Symbol.

period
[in] Period.

applied
[in] Volume type to apply.

Returned value

true if successful, false if indicator hasn't been created.

© 2000-2010, MetaQuotes Software Corp.


1784 Standard Library

Main
Returns the buffer element by the specified index.

double  Main(
int  index  // Index
)

Parameters
index
[in] Element index.

Returned value

Buffer element of the specified index if successful, or EMPTY_VALUE if there isn't any correct data.

© 2000-2010, MetaQuotes Software Corp.


1785 Standard Library

Type
Returns the object type identifier.

virtual int  Type() const

Returned value

Object type identifier (IND_BWMFI for CiBWMFI).

© 2000-2010, MetaQuotes Software Corp.


1786 Standard Library

CIndicators Class
The CIndicators is a class for collecting instances of technical indicators classes.

Description

The CIndicators class provides creation of the technical indicators class instances, their storage and
management (daya synchronization, handle and memory management).

Declaration
class CIndicators: public CArrayObj

Title
#include <Indicators\Indicator.mqh>

Class Methods

Create Methods

Create Creates technical indicator

Data Update Methods

Refresh Updates data for all technical indicators in the


collection

© 2000-2010, MetaQuotes Software Corp.


1787 Standard Library

Create
It creates the indicator with the specified parameters.

CIndicator*  Create(
string  symbol,  // Symbol name
ENUM_TIMEFRAMES  period,  // Period
ENUM_INDICATOR  type,  // Indicator's type
int  count,  // Number of parameters
MqlParam&  params  // Parameters array reference
)

Parameters
symbol
[in] Symbol name.

period
[in] Period.

type
[in] Indicator's type.

count
[in] Number of parameters for the indicator.

params
[in] Reference to the parameters array for the indicator.

Returned value

If successful, it returns the reference to the created indicator, and NULL if the indicator hasn't been
created.

© 2000-2010, MetaQuotes Software Corp.


1788 Standard Library

Refresh
Updates data for all technical indicators in the collection.

int  Refresh()

Returned value

It returns the updated timeframe flags (formed as an object visibility flags).

© 2000-2010, MetaQuotes Software Corp.


1789 Moving from MQL4

Moving from MQL4 to MQL5


MQL5 is the development of its predecessor - the MQL4 language, in which numerous indicators,
scripts, and Expert Advisors were written. Despite the fact that the new programming language is
maximally compatible with the previous-generation language, there are still some differences between
these languages. And when transferring programs these differences should be noted.

This section contains information intended to facilitate the adaptation of codes to the new MQL5
language for programmers who know MQL4.

First it should be noted:

The new language does not contain functions start(), init() and deinit();
The number of indicator buffers is not limited;
dll is downloaded immediately after downloading an Expert Advisor (or any other mql5 program);
Check of logical conditions is shortened;
When limits of an array are exceeded, the current performance is terminated (critically - with the
output of an errors);
Precedence of operators like in C + +;
The language offers the implicit type cast (even from string to a number);
Local variables are not initialized automatically (except for strings);
Common local arrays are automatically deleted.

Special Functions init, start and deinit


The MQL4 language contained only three predefined functions that could be used in the indicator,
script or Expert Advisor (not taking into account the include files *.mqh and library files). In MQL5
there are no such functions, but there are their analogues. The table shows the approximate
correspondence of functions.

MQL4 MQL5

init OnInit

start OnStart

deinit OnDeinit

Functions OnInit and OnDeinit perform the same role as init and deinit in MQL4 - they are designed
to locate the code, which must be performed during initialization and deinitialization of mql5
programs. You can either just rename these functions accordingly, or leave them as they are, but add
calls of these functions in corresponding places.

Example:

void OnInit()
{
//--- Functions is called to initialize
init();
}

© 2000-2010, MetaQuotes Software Corp.


1790 Moving from MQL4

void OnDeinit(const int reason)


{
//--- Call the function with deinitialization
deinit();
//---
}

The start function is replaced by OnStart only in scripts. In Expert Advisors and indicators it should
be renamed to OnTick and OnCalculate, respectively. The code that is to be executed during a mql5
program operation should be located in these three functions:

mql5-program main function

script OnStart

indicator OnCalculate

Expert Advisor OnTick

If the indicator or script code does not contain the main function, or the function name differs from
the required one, the call of this function is not performed. It means, if the source code of a script
doesn't contain OnStart, such a code will be compiled as an Expert Advisor.

If an indicator code doesn't contain the OnCalculate function, the compilation of such an indicator is
impossible.

Predefined Variables
In MQL5 there are no such predefined variables as Ask, Bid, Bars. Variables Point and Digits have a
slightly different spelling:

MQL4 MQL5

Digits _Digits

Point _Point

_LastError

_Period

_Symbol

_StopFlag

_UninitReason

Access to Timeseries
In MQL5 there are no such predefined timeseries as Open [], High [], Low [], Close [], Volume []
and Time []. The necessary depth of a timeseries can now be set using corresponding functions to
access timeseries.

© 2000-2010, MetaQuotes Software Corp.


1791 Moving from MQL4

Expert Advisors
Expert Advisors in MQL5 do not require the obligatory presence of the function for handling the
events of a new tick receipt - OnTick, as it was in MQL4 (the start function in MQL4 is executed when
you receive a new tick), because in MQL5 Expert Advisors can contain pre-defined handler functions
are several types of events:

OnTick – receipt of a new tick;


OnTimer – timer event;
OnTrade - trade event;
OnChartEvent – events of input from the keyboard and mouse, events of a graphic object moving,
event of a text editing completion in the entry field of the LabelEdit object;
OnBookEvent – event of Depth of Market status change.

Custom Indicators
In MQL4, the number of indicator buffers is limited and can't exceed 8. In MQL5 there are no such
limitations, but it should be remembered that each indicator buffer requires allocation of a certain
part of memory for its location in the terminal, so the new possibility should not be abused.

MQL4 offered only 6 types of custom indicator plotting; while MQL5 now offers 18 drawing styles.
The names of drawing types haven't changed, but the ideology of the graphical representation of
indicators has changed significantly.

The direction of indexing in indicator buffers also differs. By default, in MQL5 all the indicator
buffers have the behavior of common arrays, i.e. 0 indexed element is the oldest one in the history,
and as the index increases, we move from the oldest data to the most recent ones.

The only function for working with custom indicators that was preserved from MQL4 is
SetIndexBuffer. But its call has changed; now you should specify type of data to be stored in an array,
linked to the indicator buffer.

Properties of custom indicators also have changed and expanded. New functions for accessing
timeseries have been added, so the total calculation algorithm must be reconsidered.

Graphical Objects
The number of graphical objects in has increased significantly MQL5. Besides, graphical objects can
now be positioned in time with the accuracy of a second in a chart of any timeframe - now object
anchor points are not rounded off to the bar opening time in the current price chart.

For objects Arrow, Text and Label now way of binding can be indicated, and for Label, Button,
Chart, Bitmap Label and Edit chart corner, to which the object is anchored, can be set.

© 2000-2010, MetaQuotes Software Corp.

You might also like