PositionGetString - MQL5 Documentation

Documentation

MQL5 ReferenceTrade FunctionsPositionGetString

MQL5 Help as One File:

CHM (1.7 Mb)

PDF (8 Mb)

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.

Note

For each symbol, at any given moment of time, only one position can be open, which is the result of one or more deals. Do not confuse positions with current pending orders, which are also displayed on the "Trade" tab of the "Toolbox" of the client terminal.

To ensure receipt of fresh data about a position, it is recommended to call PositionSelect() right before referring to them.