Share via

StringCchGetsExA 함수(strsafe.h)

  • 아티클

줄 바꿈 문자('\n')를 포함하여 stdin에서 텍스트 한 줄을 가져옵니다. 텍스트 줄이 대상 버퍼에 복사되고 줄 바꿈 문자가 null 문자로 대체됩니다. 대상 버퍼의 크기는 이 버퍼의 끝을 지나서 작성되지 않도록 함수에 제공됩니다.

참고 이 함수는 인라인으로만 사용할 수 있습니다.
 
StringCchGetsEx 는 대상 문자열의 끝에 대한 포인터와 해당 문자열에서 사용되지 않은 문자 수를 반환하여 StringCchGets 의 기능을 추가합니다. 플래그는 추가 제어를 위해 함수에 전달될 수도 있습니다.

StringCchGetsEx 는 다음 함수를 대체합니다.

StringCchGetsEx 는 줄 바꿈 문자를 종료 null 문자로 바꾸지 않는 fgets의 대체 문자가 아닙니다.

구문

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

매개 변수

[out] pszDest

형식: LPTSTR

복사한 문자를 받는 대상 버퍼입니다.

[in] cchDest

형식: size_t

대상 버퍼의 크기(문자)입니다. 함수가 성공하려면 이 값이 2 이상이어야 합니다. 종료 null 문자를 포함하여 허용되는 최대 문자 수는 STRSAFE_MAX_CCH. cchDest가 너무 작아서 전체 텍스트 줄을 저장할 수 없는 경우 데이터가 잘립니다.

[out, optional] ppszDestEnd

형식: LPTSTR*

pszDest의 끝에 대한 포인터의 주소입니다. ppszDestEnd가 NULL이 아니고 데이터가 대상 버퍼에 복사되는 경우 문자열 끝에 있는 종료 null 문자를 가리킵니다.

[out, optional] pcchRemaining

형식: size_t*

종료 null 문자를 포함하여 pszDest에서 사용되지 않는 문자의 수입니다. pcchRemaining이 NULL인 경우 개수가 유지되거나 반환되지 않습니다.

[in] dwFlags

형식:DWORD

다음 값 중 하나 이상.

값 의미
STRSAFE_FILL_BEHIND_NULL
0x00000200
 함수가 성공하면 종료 null 문자 다음에 pszDest의 초기화되지 않은 부분을 채우는 데 dwFlags(0)의 낮은 바이트가 사용됩니다.
STRSAFE_IGNORE_NULLS
0x00000100
 NULL 문자열 포인터를 빈 문자열(TEXT(""))과 같이 처리합니다. 이 플래그는 lstrcpy와 같은 함수를 에뮬레이트하는 데 유용합니다.
STRSAFE_FILL_ON_FAILURE
0x00000400
 함수가 실패하면 전체 pszDest 버퍼를 채우는 데 dwFlags(0)의 낮은 바이트가 사용되고 버퍼는 null로 종료됩니다. STRSAFE_E_INSUFFICIENT_BUFFER 실패의 경우 반환된 잘린 문자열을 덮어씁니다.
STRSAFE_NULL_ON_FAILURE
0x00000800
 함수가 실패하면 pszDest 가 빈 문자열(TEXT(""))로 설정됩니다. STRSAFE_E_INSUFFICIENT_BUFFER 실패의 경우 잘린 문자열을 덮어씁니다.
STRSAFE_NO_TRUNCATION
0x00001000
 STRSAFE_NULL_ON_FAILURE 경우와 마찬가지로 함수가 실패하면 pszDest 는 빈 문자열(TEXT(""))로 설정됩니다. STRSAFE_E_INSUFFICIENT_BUFFER 실패의 경우 잘린 문자열을 덮어씁니다.

반환 값

형식: HRESULT

이 함수는 다음 값 중 하나를 반환할 수 있습니다. SUCCEEDED 및 FAILED 매크로를 사용하여 이 함수의 반환 값을 테스트하는 것이 좋습니다.

반환 코드 Description
S_OK
 문자가 stdin에서 읽혀지고 pszDest의 버퍼에 복사되었으며 버퍼가 null로 종료되었습니다.
STRSAFE_E_END_OF_FILE
 오류 또는 파일 끝 조건을 나타냅니다. feof 또는 ferror를 사용하여 발생한 작업을 확인합니다.
STRSAFE_E_INVALID_PARAMETER
 cchDest의 값이 허용되는 최대 값보다 크거나 잘못된 플래그가 전달되었습니다.
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest의 값은 1 이하입니다.
 

이 함수는 대체되는 함수와 달리 HRESULT 값을 반환합니다.

설명

StringCchGetsEx 는 코드에서 적절한 버퍼 처리를 위한 추가 처리를 제공합니다. 버퍼 처리 불량은 버퍼 오버런과 관련된 많은 보안 문제에 연루됩니다. StringCchGetsEx 는 항상 null 길이가 아닌 대상 버퍼를 종료합니다.

STRSAFE_IGNORE_NULLS 플래그를 지정하지 않는 한 pszDest 값은 NULL이 아니어야 합니다. 그러나 NULL 값이 무시되더라도 공간이 부족하여 오류가 반환될 수 있습니다.

StringCchGetsEx 는 제네릭 형식 또는 보다 구체적인 형식으로 사용할 수 있습니다. 문자열의 데이터 형식은 다음 표와 같이 사용해야 하는 이 함수의 형식을 결정합니다.

문자열 데이터 형식 문자열 리터럴 함수
char "문자열" StringCchGetsExA
TCHAR TEXT("string") StringCchGetsEx
Wchar L"string" StringCchGetsExW
 

참고

strsafe.h 헤더는 STRINGCchGetsEx를 유니코드 전처리기 상수의 정의에 따라 이 함수의 ANSI 또는 유니코드 버전을 자동으로 선택하는 별칭으로 정의합니다. 인코딩 중립 별칭을 인코딩 중립이 아닌 코드와 혼합하면 컴파일 또는 런타임 오류가 발생하는 불일치가 발생할 수 있습니다. 자세한 내용은 함수 프로토타입에 대한 규칙을 참조하세요.

요구 사항

요구 사항 값
지원되는 최소 클라이언트 WINDOWS XP SP2 [데스크톱 앱 | UWP 앱]
지원되는 최소 서버 WINDOWS Server 2003 SP1 [데스크톱 앱 | UWP 앱]
대상 플랫폼 Windows
헤더 strsafe.h

추가 정보

참조

StringCbGetsEx

StringCchGets