ReadConsoleOutputCharacter 함수

아티클
07/12/2023

Important

이 문서에서는 더 이상 에코시스템 로드맵의 일부가 되지 않는 콘솔 플랫폼 기능에 대해 설명합니다. 이 콘텐츠를 신제품에서 사용하지 않는 것이 좋지만, 무기한 앞으로도 기존 사용을 계속 지원할 것입니다. 선호하는 최신 솔루션은 플랫폼 간 시나리오에서 최대 호환성을 위해 가상 터미널 시퀀스에 중점을 둡니다. 이 디자인 결정에 대한 자세한 내용은 클래식 콘솔과 가상 터미널 문서에서 확인할 수 있습니다.

지정된 위치에서 시작하여 콘솔 화면 버퍼의 연속 셀에서 여러 문자를 복사합니다.

구문

BOOL WINAPI ReadConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _Out_ LPTSTR  lpCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwReadCoord,
  _Out_ LPDWORD lpNumberOfCharsRead
);

매개 변수

hConsoleOutput [in]
콘솔 화면 버퍼에 대한 핸들입니다. 핸들에는 GENERIC_READ 액세스 권한이 있어야 합니다. 자세한 내용은 콘솔 버퍼 보안 및 액세스 권한을 참조하세요.

lpCharacter [out]
콘솔 화면 버퍼에서 읽은 문자를 받는 버퍼에 대한 포인터입니다.

nLength [in]
읽을 화면 버퍼 문자 셀의 수입니다. lpCharacter 매개 변수가 가리키는 버퍼의 크기는 여야 nLength * sizeof(TCHAR)합니다.

dwReadCoord [in]
콘솔 화면 버퍼에서 읽을 첫 번째 셀의 좌표(문자)입니다. COORD 구조체의 X 멤버는 열이고 Y 멤버는 행입니다.

lpNumberOfCharsRead [out]
실제로 읽은 문자 수를 받는 변수에 대한 포인터입니다.

반환 값

함수가 성공하면 반환 값이 0이 아닙니다.

함수가 실패하면 반환 값은 0입니다. 확장 오류 정보를 가져오려면 GetLastError를 호출합니다.

설명

읽을 문자 수가 지정된 화면 버퍼 행의 끝을 넘어 확장되면 다음 행에서 문자를 읽습니다. 읽을 문자 수가 콘솔 화면 버퍼의 끝을 넘어 확장되면 콘솔 화면 버퍼의 끝까지 문자를 읽습니다.

이 함수는 콘솔의 현재 코드 페이지에서 유니코드 문자 또는 8비트 문자를 사용합니다. 콘솔의 코드 페이지는 처음에 기본적으로 시스템의 OEM 코드 페이지로 설정됩니다. 콘솔의 코드 페이지를 변경하려면 SetConsoleCP 또는 SetConsoleOutputCP 함수를 사용합니다. 레거시 소비자는 chcp 또는 mode con cp select= 명령을 사용할 수도 있지만 새로운 개발에는 추천되지 않습니다.

팁

이 API는 권장되지 않으며 해당하는 가상 터미널이 없습니다. 이 결정은 개별 클라이언트 애플리케이션이 추가 조작을 위해 자체 그리기 상태를 기억해야 하는 다른 운영 체제와 Windows 플랫폼을 의도적으로 정렬합니다. 이 API를 사용하는 경우 플랫폼 간 유틸리티 및 SSH와 같은 전송을 통한 애플리케이션 원격 작업이 예상대로 작동하지 않을 수 있습니다.

요구 사항


지원되는 최소 클라이언트	Windows 2000 Professional[데스크톱 앱만]
지원되는 최소 서버	Windows 2000 Server[데스크톱 앱만]
헤더	ConsoleApi2.h(WinCon.h를 통해 Windows.h 포함)
라이브러리	Kernel32.lib
DLL	Kernel32.dll
유니코드 및 ANSI 이름	ReadConsoleOutputCharacterW (유니코드) 및 ReadConsoleOutputCharacterA (ANSI)