Syuhitu Home > 関連情報・ソフトウェア > プラグイン > API > PFID_GETSTRING

PFID_GETSTRING

 指定した範囲の文字列を取得する。

PFT_BOOL (*PFT_GetString)(
	unsigned long SLP,
	unsigned long SCP,
	unsigned long ELP,
	unsigned long ECP,
	wchar_t* pBuf,
	unsigned long BufLength
);

概要

 SLP行目SCP文字目からELP行目ECP-1文字目までの文字列をpBufが示すアドレスに取得します。

 文字列の末尾には'\0'が設定されます。

 もし、取得される文字列がBufLengthより長かった場合には、バッファに格納することができた位置までの文字列が返されます。

引数

SLP

 文字列の取得を開始する行番号を指定します。指定可能な行番号は0から総行数-1までです。

SCP

 SLP行内の何番目の文字から取得するか、を指定します。指定可能な値は0からSLP行目に存在する文字数-1までです。

ELP

 文字列の取得を終了する行番号を指定します。指定可能な行番号は0から総行数-1までです。

ECP

 ELP行内の何番目の文字まで取得するか、を指定します。指定可能な値は0からSLP行目に存在する文字数までです。 なお、。取得される文字列にはELP行目ECP文字目の文字は含まれません。

pBuf

 文字列を取得するためのメモリ領域のアドレスを指定します。

BufLength

 pBufに用意されたバッファの長さ(文字数)を指定します。

戻り値

 文字列の取得に成功した場合は真が返されます。そうでない場合は偽が返されます。


Copyright(C) 2005 nabiki_t All Rights Reserved.