Función StringCchGetsA (strsafe.h)

Obtiene una línea de texto de stdin, hasta e incluye 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 más allá del final de este búfer.

Nota Esta función solo se puede usar en línea.

 

StringCchGets es un reemplazo de las funciones siguientes:

• obtiene, _getws, _getts

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 de

El 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 de texto completa, 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	Se leyeron caracteres de stdin, se copiaron en el búfer en pszDesty el búfer finalizó 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 se ha producido.
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 de HRESULT, a diferencia de las funciones que reemplaza.

Observaciones

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 finaliza 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.

Tipo de datos de cadena	Literal de cadena	Función
char	"string"	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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP]
servidor mínimo admitido	Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP]
de la plataforma de destino de	Windows
encabezado de	strsafe.h

Consulte también

de referencia de

StringCbGets

StringCchGetsEx