ITextStoreACP2：：GetText 方法 (textstor.h)
取得位於指定字元位置的文字相關資訊。 這個方法會傳回可見和隱藏的文字，並指出內嵌資料是否附加至文字。
語法
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。
傳回值
這個方法可以傳回其中一個值。
| 值 | 描述 |
|---|---|
|
此方法成功。 |
|
acpStart或acpEnd參數位於檔文字之外。 |
|
呼叫端在檔上沒有唯讀鎖定。 |
備註
使用此方法的呼叫端必須透過呼叫 RequestLock 方法，對檔具有唯讀鎖定。 如果沒有唯讀鎖定，方法會失敗並傳回 TF_E_NOLOCK。
應用程式也可以基於內部原因截斷方法傳回值。 呼叫端應該仔細檢查傳回字元和文字執行計數，以取得所需的傳回值。 如果傳回值不完整，請重複呼叫 方法，直到傳回值完成為止。
呼叫端只能藉由將 cRunInfoReq 參數設定為 0， 並將 prgRunInfo 參數設定為 Null來要求純文字。 呼叫端只能要求文字執行資料，方法是將 cchPlainReq 參數設定為 0，並將 pchPlain 參數設定為 Null。 不過，即使未使用此參數，呼叫端仍必須提供pcchPlainRet的有效非Null值。
如果 acpEnd 是 -1，則應該如同在資料流程結尾設定一樣處理。 否則，它將會大於或等於零。
結束時， pacpNext 應該設定為傳回值未參考之資料流程中下一個字元的字元位置。 呼叫端會使用此專案來快速掃描具有多個 GetText 呼叫的文字。
規格需求
| 最低支援的用戶端 | Windows 8 [傳統型應用程式 |UWP 應用程式] |
| 最低支援的伺服器 | Windows Server 2012 [傳統型應用程式 |UWP 應用程式] |
| 目標平台 | Windows |
| 標頭 | textstor.h |
| Dll | Msctf.dll |