Función StringCchGetsExA (strsafe.h)

Artículo
11/20/2024

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.

StringCchGetsEx agrega a la funcionalidad de StringCchGets devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. También se pueden pasar marcas a la función para un control adicional.

stringCchGetsEx es un reemplazo de las funciones siguientes:

obtiene, _getws, _getts

stringCchGetsEx 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 StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

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.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

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

[out, optional] pcchRemaining

Tipo: size_t*

Número de caracteres sin usar en pszDest, incluido el carácter nulo de terminación. Si pcchRemaining es null, el recuento no se conserva ni devuelve.

[in] dwFlags

Tipo: DWORD de

Uno o varios de los siguientes valores.

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 null punteros de cadena 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, se usa el byte bajo de dwFlags (0) para rellenar todo el búfer de 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	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 o se pasó una marca no válida.
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

stringCchGetsEx 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. StringCchGetsEx siempre finaliza un búfer de destino 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 se devuelva un error debido a un espacio insuficiente aunque se omitan valores NULL.

stringCchGetsEx 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"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	StringCchGetsExW

Nota

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

stringCbGetsEx

stringCchGets

Compartir a través de