ClearRestOfLine関数

このページをスマートフォンなどでご覧になる場合は、画面を横長にする方が読みやすくなる事があります。

書式

int8_t ClearRestOfLine(void)

対応オブジェクト型

MGLCD_AQM1248A_SoftwareSPI型
MGLCD_AQM1248A_SPI型
MGLCD_GH12864_20_SoftwareSPI型
MGLCD_GH12864_20_SPI型
MGLCD_S12232ZA型
MGLCD_serial型
MGLCD_SoftwareSerial型
MGLCD_SG12232型
MGLCD_SG12864型

対応バージョン

Ver. 0.22以降

説明

次の文字の表示位置から行末までを消去する。行末とは、テキストウィンドウで指定された右端の桁までを指し、LCD画面の右端の桁までではない。(ただし、デフォルトではテキストウィンドウがLCD画面いっぱいに設定されているので、テキストウィンドウの右端とLCD画面の右端を区別する必要はない)

引数

なし。

返り値

関数の呼び出しに成功すれば0、失敗すれば負の値を返す。LCDが直接Arduinoにつながっている場合は、関数の呼び出しに失敗する事はなく、必ず返り値が0となる。LCDがシリアル回線経由の場合は回線の状態により、関数の呼び出しに失敗する可能性があり、返り値が負になる可能性がある。

使用例

#include <MGLCD.h>

MGLCD_serial MGLCD(&Serial,500000); // Serialを500kbpsで使用

void setup()
{
  while(MGLCD.Reset()); // LCDの初期化
}

void loop()
{
  MGLCD.ClearScreen();
  delay(3000);
  MGLCD.print("abcdef"); // abcdefと表示される
  delay(3000);
  MGLCD.Locate(0,0);  // abcをABCで上書きして、
  MGLCD.print("ABC"); // ABCdefと表示される
  delay(3000);
  MGLCD.ClearRestOfLine(); // ABCと表示される
  delay(3000);
}