ITextStoreAnchor：：GetText 方法 (textstor.h)

ITextStoreAnchor：：GetText方法會傳回指定錨點位置的文字相關資訊。 這個方法會傳回可見和隱藏的文字，並指出內嵌資料是否附加至文字。

語法

HRESULT GetText(
  [in]  DWORD   dwFlags,
  [in]  IAnchor *paStart,
  [in]  IAnchor *paEnd,
  [out] WCHAR   *pchText,
  [in]  ULONG   cchReq,
  [out] ULONG   *pcch,
  [in]  BOOL    fUpdateAnchor
);

參數

[in] dwFlags

未使用;應該是零。

[in] paStart

指定起始錨點位置。

[in] paEnd

指定結束錨點位置。 如果 為 Null，則會將其視為位於文字資料流程結尾的錨點。

[out] pchText

指定要接收文字的緩衝區。 只有在cchReq = 0 時，才可為Null。

[in] cchReq

以字元指定 pchText 緩衝區大小。

[out] pcch

接收復制到 pchText 緩衝區的字元數。

[in] fUpdateAnchor

如果 為 TRUE， paStart 將會重新置放到複製到 pchText的最後一個字元之後。

傳回值

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

值	描述
S_OK	已成功完成命令。
E_FAIL	方法無法取得 paStart 和/或 paEnd的有效介面指標。
TF_E_INVALIDPOS	paStart或paEnd錨點位於檔文字之外。
TS_E_NOLOCK	呼叫端在檔上沒有唯讀鎖定。

備註

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

應用程式可能會因為內部原因而截斷方法傳回值。

若要使用多個GetText呼叫快速掃描文字，呼叫端會使用fUpdateAnchor = TRUE。

如果paStart與paEnd之間的字元數小於cchReq，則複製的實際字元數可能小於cchReq。

GetText的行為不受傳回文字所涵蓋的任何區域界限影響。

規格需求

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

另請參閱

ITextStoreAnchor

ITextStoreAnchor：：RequestLock

管理員傳回值

TS_RUNINFO