Función StringCbGetsExA (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.
 
StringCbGetsEx agrega a la funcionalidad de StringCbGets devolviendo un puntero al final de la cadena de destino, así como el número de bytes que quedan sin usar en esa cadena. Las marcas también se pueden pasar a la función para un control adicional.

StringCbGetsEx es un reemplazo de las siguientes funciones:

StringCbGetsEx 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 StringCbGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cbDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcbRemaining,
  [in]            DWORD         dwFlags
);

Parámetros

[out] pszDest

Tipo: LPTSTR

Búfer de destino, que va a recibir 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.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Dirección de un puntero al final de pszDest. Si ppszDestEnd no es NULL y los datos se copian en el búfer de destino, esto apunta al carácter nulo de terminación al final de la cadena.

[out, optional] pcbRemaining

Tipo: size_t*

Número de bytes sin usar en pszDest, incluidos los usados para el carácter nulo de terminación. Si pcbRemaining es NULL, el recuento no se mantiene ni se devuelve.

[in] dwFlags

Tipo: DWORD

Uno o varios de los valores siguientes.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Si la función se ejecuta correctamente, se usa el byte bajo de dwFlags (0) para rellenar la parte no inicializada de pszDest después del carácter nulo de terminación.
STRSAFE_IGNORE_NULLS
0x00000100
 Trate punteros de cadena NULL como cadenas vacías (TEXT("")). Esta marca es útil para simular funciones como lstrcpy.
STRSAFE_FILL_ON_FAILURE
0x00000400
 Si se produce un error en la función, el byte bajo de dwFlags (0) se usa para rellenar todo el búfer pszDest y el búfer termina en null. En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada devuelta.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada.
STRSAFE_NO_TRUNCATION
0x00001000
 Como en el caso de STRSAFE_NULL_ON_FAILURE, si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada.

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 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. Use 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 o se pasó una marca no válida.
STRSAFE_E_INSUFFICIENT_BUFFER
 El valor de cbDest es 1 o menos.
 

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

Comentarios

StringCbGetsEx 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. StringCbGetsEx siempre termina en null un búfer de destino que no es de longitud cero.

El valor de pszDest no debe ser NULL a menos que se especifique la marca STRSAFE_IGNORE_NULLS . Sin embargo, es posible que todavía se devuelva un error debido a un espacio insuficiente aunque se omitan los valores NULL .

StringCbGetsEx 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" StringCbGetsExA
TCHAR TEXT("string") StringCbGetsEx
WCHAR L"string" StringCbGetsExW
 

Nota

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

Requisito Value
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