Función StringCchGetsExA (strsafe.h)

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.

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 siguientes funciones:

• 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

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 permitido, 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.

[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] 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 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, el byte bajo de dwFlags (0) se usa 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 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 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. Utilice 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 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 HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

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

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.

String (Tipo de datos)	Literal de cadena	Función
char	"cadena"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	StringCchGetsExW

 

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

StringCbGetsEx

StringCchGets