画面に表示中の組込みメディア項目の消去を行います。
PSINT PSFUNCTION ps_clear_media(
PSFILE psfile,
PSUSHORT mode,
PSPSTR pGroup,
PSPVOID pRecord,
PSPVOID pAttr)
psfile | : | オープン処理で獲得した表示ファイル識別子を指定します。 | ||
mode | : | メディア項目の消去の種類を指定します。 | ||
PS_CM_ALL | : | 全項目消去を行います。 | ||
PS_CM_FILED | : | 単項目消去を行います。 | ||
pGroup | : | 出力の対象とする項目群名または項目名を指定します。項目群名または項目名には、先頭から最大6文字までのNULLで終わる文字列を指定します。pGroupに0を指定すると、すべての項目が出力の対象となります。 | ||
pRecord | : | レコードデータ領域を指すポインタを指定します。 | ||
pAttr | : | リザーブです。必ず0を指定します。 |
正常終了時には0が返されます。エラー発生時には1または2が返されます。psfileの指定に誤りがある場合には2が、それ以外のエラーの場合には1が返されます。1が返した場合には通知コードの獲得で通知コードを獲得してエラー原因を識別できます。
処理中にオペレータがタスクリストからの終了を選択すると-1が返されます。その場合、利用者プログラムは必ずプログラムを終了してください。