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일 수 없습니다.
반환 값
이 메서드는 이러한 값 중 하나를 반환할 수 있습니다.
| 값 | Description |
|---|---|
|
메서드를 성공적으로 수행했습니다. |
|
acpStart 또는 acpEnd 매개 변수는 문서 텍스트 외부에 있습니다. |
|
호출자에게 문서에 대한 읽기 전용 잠금이 없습니다. |
설명
이 메서드를 사용하는 호출자는 ITextStoreACP::RequestLock 메서드를 호출하여 문서에 대한 읽기 전용 잠금이 있어야 합니다. 읽기 전용 잠금이 없으면 메서드가 실패하고 TF_E_NOLOCK 반환합니다.
애플리케이션은 내부 이유로 메서드 반환 값을 잘라낼 수도 있습니다. 호출자는 반환 문자 및 텍스트 실행 횟수를 주의 깊게 검토하여 필요한 반환 값을 가져와야 합니다. 반환 값이 불완전한 경우 반환 값이 완료될 때까지 메서드를 반복적으로 호출합니다.
호출자는 cRunInfoReq 매개 변수를 0으로 설정하고 prgRunInfo 매개 변수를 NULL로 설정해야만 일반 텍스트를 요청할 수 있습니다. 호출자는 cchPlainReq 매개 변수를 0으로 설정하고 pchPlain 매개 변수를 NULL로 설정하여 텍스트 실행 데이터만 요청할 수 있습니다. 그러나 이 매개 변수를 사용하지 않더라도 호출자는 여전히 pcchPlainRet에 유효한 null이 아닌 값을 제공해야 합니다.
acpEnd가 -1이면 스트림의 끝에 설정된 것처럼 처리해야 합니다. 그렇지 않으면 0보다 크거나 같습니다.
종료 시 pacpNext 는 반환 값으로 참조되지 않는 스트림에서 다음 문자의 문자 위치로 설정해야 합니다. 호출자는 이를 사용하여 여러 ITextStoreACP::GetText 호출로 텍스트를 빠르게 검사합니다.
요구 사항
| 요구 사항 | 값 |
|---|---|
| 지원되는 최소 클라이언트 | Windows 2000 Professional[데스크톱 앱만] |
| 지원되는 최소 서버 | Windows 2000 Server[데스크톱 앱만] |
| 대상 플랫폼 | Windows |
| 헤더 | textstor.h |
| DLL | Msctf.dll |
| 재배포 가능 파일 | Windows 2000 Professional의 TSF 1.0 |