Función StringCchGetsA (strsafe.h)

  • Artículo

Obtiene una línea de texto de stdin, hasta el carácter de nueva línea ("\n"). La línea de texto se copia en el búfer de destino y el carácter de nueva línea se reemplaza por un carácter NULL. El tamaño del búfer de destino se proporciona a la función para asegurarse de que no escribe después del final de este búfer.

Nota Esta función solo se puede usar insertada.
 
StringCchGets es un reemplazo de las siguientes funciones:StringCchGets no es un reemplazo de fgets, que no reemplaza los caracteres de nueva línea por un carácter nulo de terminación.

Sintaxis

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

Parámetros

[out] pszDest

Tipo: LPTSTR

Búfer de destino, que recibe los caracteres copiados.

[in] cchDest

Tipo: size_t

Tamaño del búfer de destino, en caracteres. Este valor debe ser al menos 2 para que la función se realice correctamente. El número máximo de caracteres permitidos, incluido el carácter nulo de terminación, es STRSAFE_MAX_CCH. Si cchDest es demasiado pequeño para contener la línea completa de texto, los datos se truncan.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de los siguientes valores. Se recomienda encarecidamente usar las macros SUCCEEDED y FAILED para probar el valor devuelto de esta función.

Código devuelto Descripción
S_OK
 Los caracteres se leyeron desde stdin, se copiaron en el búfer en pszDest y el búfer terminó en null.
STRSAFE_E_END_OF_FILE
 Indica un error o una condición de fin de archivo. Use feof o ferror para determinar cuál ha ocurrido.
STRSAFE_E_INVALID_PARAMETER
 El valor de cchDest es mayor que el valor máximo permitido.
STRSAFE_E_INSUFFICIENT_BUFFER
 El valor de cchDest es 1 o menos.
 

Tenga en cuenta que esta función devuelve un valor HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

StringCchGets proporciona procesamiento adicional para el control adecuado del búfer en el código. El control deficiente del búfer está implicado en muchos problemas de seguridad que implican saturaciones de búfer. StringCchGets siempre termina en null un búfer de destino que no es de longitud cero.

El valor de pszDest no debe ser NULL. Consulte StringCchGetsEx si necesita el control de valores de puntero de cadena NULL.

StringCchGets se puede usar en su forma genérica o en sus formularios más específicos. El tipo de datos de la cadena determina la forma de esta función que debe usar, como se muestra en la tabla siguiente.

String (Tipo de datos) Literal de cadena Función
char "cadena" StringCchGetsA
TCHAR TEXT("string") StringCchGets
WCHAR L"string" StringCchGetsW
 

Nota

El encabezado strsafe.h define StringCchGets como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

   
Cliente mínimo compatible Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado strsafe.h

Consulte también

Referencia

StringCbGets

StringCchGetsEx