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 的最后一个字符之后。
返回值
此方法可以返回其中一个值。
值 | 说明 |
---|---|
|
该方法已成功完成。 |
|
方法无法获取指向 paStart 和/或 paEnd 的有效接口指针。 |
|
paStart 或 paEnd 定位点位于文档文本之外。 |
|
调用方对文档没有只读锁。 |
注解
使用此方法的调用方必须通过调用 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 |