ITextStoreACP：：GetText 方法 (textstor.h)

ITextStoreACP：：GetText 方法會傳回指定字元位置的文字相關信息。 這個方法會傳回可見和隱藏的文字，並指出內嵌數據是否附加至文字。

語法

HRESULT GetText(
  [in]  LONG       acpStart,
  [in]  LONG       acpEnd,
  [out] WCHAR      *pchPlain,
  [in]  ULONG      cchPlainReq,
  [out] ULONG      *pcchPlainRet,
  [out] TS_RUNINFO *prgRunInfo,
  [in]  ULONG      cRunInfoReq,
  [out] ULONG      *pcRunInfoRet,
  [out] LONG       *pacpNext
);

參數

[in] acpStart

指定起始字元位置。

[in] acpEnd

指定結束符位置。 如果此參數為 -1，則傳回文字存放區中的所有文字。

[out] pchPlain

指定要接收純文字數據的緩衝區。 如果此參數為 NULL， 則 cchPlainReq 參數必須是 0。

[in] cchPlainReq

指定傳遞至 方法的純文字字元數目。

[out] pcchPlainRet

接收複製到純文字緩衝區中的字元數。 此參數不可為 NULL。 如果不需要值，請使用 參數。

[out] prgRunInfo

接收 TS_RUNINFO 結構的陣列。 只有在 cRunInfoReq = 0 時，才可為 NULL。

[in] cRunInfoReq

指定文字執行緩衝區的大小，以字元為單位。

[out] pcRunInfoRet

接收寫入文字執行緩衝區 的TS_RUNINFO 結構數目。 此參數不可為 NULL。

[out] pacpNext

接收下一個未讀取字元的字元位置。 不可以是 NULL。

傳回值

這個方法可以傳回其中一個值。

值	描述
S_OK	此方法成功。
TF_E_INVALIDPOS	acpStart 或 acpEnd 參數位於文件文字之外。
TF_E_NOLOCK	呼叫端在文件上沒有唯讀鎖定。

備註

使用此方法的呼叫端必須透過呼叫 ITextStoreACP：：RequestLock 方法，對檔具有只讀鎖定。 如果沒有只讀鎖定，方法會失敗並傳回 TF_E_NOLOCK。

應用程式也可以基於內部原因截斷方法傳回值。 呼叫端應該仔細檢查傳回字元和文字執行計數，以取得所需的傳回值。 如果傳回值不完整，請重複呼叫 方法，直到傳回值完成為止。

呼叫端只能藉由將 cRunInfoReq 參數設定為 0， 並將 prgRunInfo 參數設定為 NULL 來要求純文字。 呼叫端只能要求文字執行數據，方法是將 cchPlainReq 參數設定為 0，並將 pchPlain 參數設定為 NULL。 不過，即使未使用此參數，呼叫端仍必須提供pcchPlainRet的有效非 Null 值。

如果 acpEnd 是 -1，則應該如同在數據流結尾設定一樣處理。 否則，它將會大於或等於零。

結束時， pacpNext 應該設定為傳回值未參考之數據流中下一個字元的字元位置。 呼叫端會使用此專案快速掃描具有多個 ITextStoreACP：：GetText 呼叫的文字。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	textstor.h
Dll	Msctf.dll
可轉散發套件	Windows 2000 專業版上的 TSF 1.0

另請參閱

ITextStoreACP

ITextStoreACP：：RequestLock

管理員傳回值

TS_RUNINFO