Función StringCbGetsA (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 NULO. 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 insertada.
 
StringCbGets es un reemplazo de las funciones siguientes:StringCbGets 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 StringCbGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cbDest
);

Parámetros

[out] pszDest

Tipo: LPTSTR

El búfer de destino, que recibe la entrada.

[in] cbDest

Tipo: size_t

Tamaño del búfer de destino, en bytes. Este valor debe ser mayor que sizeof(TCHAR) para que la función se realice correctamente. El número máximo de bytes permitido es STRSAFE_MAX_CCH * sizeof(TCHAR). Si cbDest 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 valores siguientes. 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 datos 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. Utilice feof o ferror para determinar cuál ha ocurrido.
STRSAFE_E_INVALID_PARAMETER
 El valor de cbDest es mayor que el valor máximo permitido.
STRSAFE_E_INSUFFICIENT_BUFFER
 El valor de cbDest es sizeof(TCHAR) o menos.
 

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

Comentarios

StringCbGets 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 del búfer. StringCbGets siempre termina en null un búfer de destino distinto de cero.

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

StringCbGets 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" StringCbGetsA
TCHAR TEXT("string") StringCbGets
WCHAR L"string" StringCbGetsW
 

Nota:

El encabezado strsafe.h define StringCbGets 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 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

StringCbGetsEx

StringCchGets