【MQL5】OrderCalcProfit関数について

OrderCalcProfit関数の働き・役割
OrderCalcProfit関数の引数について
OrderCalcProfit関数の戻り値について
1. 戻り値の詳細
OrderCalcProfit関数を使う際の注意点
OrderCalcProfitを使ったサンプルコード
サンプルコードに使われた関数や文法要素の簡単な解説

OrderCalcProfit関数の働き・役割

OrderCalcProfit関数は、渡されたパラメータに基づいて現在の銘柄での現在の口座の利益を計算するために使用されます。計算された利益の値は口座の預金通貨で返されます。

この関数を使用することで、取引を行う前に予測される利益を確認し、リスク管理や取引戦略の立案に活用することができます。具体的には、新規注文を出す前に期待される利益を評価する場合や、異なる取引条件での利益をシミュレーションする場合に利用されます。

OrderCalcProfit関数の引数について

OrderCalcProfit関数の引数構成は以下の通りです。

bool  OrderCalcProfit(
  ENUM_ORDER_TYPE      action,          // 注文の種類 （ORDER_TYPE_BUY または ORDER_TYPE_SELL）
  string                symbol,          // 銘柄名
  double                volume,          // ボリューム
  double                price_open,      // 始値
  double                price_close,      // 終値
  double&               profit            // 利益値の取得に使用される変数

第1引数: action

注文の種類を指定します。この引数はENUM_ORDER_TYPEの値を取ります。ORDER_TYPE_BUYまたはORDER_TYPE_SELLのいずれかを指定します。

第2引数: symbol

取引対象の銘柄名を文字列で指定します。例えば、EURUSDやGBPJPYなどのシンボル（特定の文字や記号）を指定します。

第3引数: volume

取引のボリュームを指定します。ボリュームはロット単位で表され、通常は少数点以下の値を取ることができます。

第4引数: price_open

取引の始値を指定します。これは取引が開始される価格です。

第5引数: price_close

取引の終値を指定します。これは取引が終了する価格です。

第6引数: profit

計算された利益の値が格納される変数です。関数が成功すると、この変数に参照渡しで利益の値が格納されます。

※参照渡しについては下記の記事をご参照ください。

OrderCalcProfit関数の戻り値について

OrderCalcProfit関数は、計算が成功した場合にtrueを返し、失敗した場合にはfalseを返します。

戻り値の詳細

true: 計算が成功し、利益の値がprofit変数に格納されました。
false: 計算が失敗しました。無効な注文の種類が指定された場合、この関数はfalseを返します。この場合、GetLastError関数を使用してエラーの詳細を取得することができます。

利益の計算結果は、市場の変動や口座の設定に大きく影響を受けるため、異なる条件で異なる結果が得られることがあります。

OrderCalcProfit関数を使う際の注意点

利益の計算は市場環境に依存するため、実際の取引結果とは異なる場合があります。このため、計算結果は参考値として利用し、実際の取引時には常に最新の市場状況を確認することが重要です。

OrderCalcProfit関数は利益を計算するための変数を参照渡しで受け取ります。このため、関数呼び出し後にこの変数の値を確認することで、計算結果を取得することができます。

最後に、OrderCalcProfit関数がfalseを返した場合、エラーの詳細を取得するためにGetLastError関数を使用することが推奨されます。これにより、利益計算に失敗した原因を特定し、適切な対策を講じることができます。

OrderCalcProfitを使ったサンプルコード

以下は、OrderCalcProfit関数を使用して指定された注文に対して予測される利益を計算するサンプルコードです。

// OnStart関数はスクリプトの実行が開始されたときに自動的に呼び出されます
void OnStart()
{
    // 計算に使用するパラメータを設定
    ENUM_ORDER_TYPE orderType = ORDER_TYPE_BUY; // 成行買い注文
    string symbol = "EURUSD";                   // 銘柄名
    double volume = 1.0;                        // ボリューム（ロット）
    double price_open = 1.1200;                 // 始値
    double price_close = 1.1300;                // 終値
    double profit;                              // 利益を格納する変数

    // 利益を計算
    bool result = OrderCalcProfit(orderType, symbol, volume, price_open, price_close, profit);

    // 計算結果をチェック
    if(result)
    {
        // 計算が成功した場合、利益の値をエキスパートログに出力
        Print("予測される利益: ", profit);
    }
    else
    {
        // 計算が失敗した場合、エラーコードをエキスパートログに出力
        Print("利益の計算に失敗しました。エラーコード: ", GetLastError());
    }
}

サンプルコードに使われた関数や文法要素の簡単な解説

OnStart関数

OnStart関数は、スクリプトが実行されるときに最初に呼び出される関数です。この関数内で、利益の計算と結果の出力を行います。

計算に使用するパラメータの設定

// 計算に使用するパラメータを設定
ENUM_ORDER_TYPE orderType = ORDER_TYPE_BUY; // 成行買い注文
string symbol = "EURUSD";                   // 銘柄名
double volume = 1.0;                        // ボリューム（ロット）
double price_open = 1.1200;                 // 始値
double price_close = 1.1300;                // 終値
double profit;                              // 利益を格納する変数

この部分では、利益を計算するための必要なパラメータを設定します。

orderTypeは注文の種類を示し、ここでは成行買い注文を指定しています。
symbolは取引する銘柄名を指定しています。
volumeは取引のボリュームをロット単位で指定します。
price_openは取引開始時の価格を設定します。
price_closeは取引終了時の価格を設定します。
profitは計算された利益の値を格納するための変数です。

OrderCalcProfit関数の呼び出し

// 利益を計算
bool result = OrderCalcProfit(orderType, symbol, volume, price_open, price_close, profit);

ここでは、OrderCalcProfit関数を呼び出して利益を計算します。引数として、前述のパラメータを渡します。関数は、計算が成功した場合にtrueを返し、失敗した場合にはfalseを返します。計算結果はprofit変数に格納されます。

計算結果のチェック

// 計算結果をチェック
if(result)
{
    // 計算が成功した場合、利益の値をエキスパートログに出力
    Print("予測される利益: ", profit);
}
else
{
    // 計算が失敗した場合、エラーコードをエキスパートログに出力
    Print("利益の計算に失敗しました。エラーコード: ", GetLastError());
}

ここでは、OrderCalcProfit関数の戻り値であるresultをチェックしています。

if文は、resultがtrueの場合に実行されるブロックを指定します。この場合、計算された利益の値をエキスパートログに出力します。
else文は、resultがfalseの場合に実行されるブロックを指定します。この場合、利益の計算が失敗したことを示し、GetLastError関数を使用してエラーコードをエキスパートログに出力します。