Función StringCchCatNExA (strsafe.h)
Concatena el número especificado de caracteres de una cadena a otra. 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.
stringCchCatNEx agrega a la funcionalidad de stringCchCatN 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.
StringCchCatNEx es un reemplazo de las siguientes funciones:
Sintaxis
STRSAFEAPI StringCchCatNExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToAppend,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parámetros
[in, out] pszDest
Tipo: LPTSTR de
El búfer de destino, que contiene la cadena que se va a concatenar con pszSrcy recibirá toda la cadena resultante. La cadena de pszSrc se agrega al final de la cadena en pszDest.
[in] cchDest
Tipo: size_t
Tamaño del búfer de destino, en caracteres. Este valor debe ser igual a la longitud de pszSrc más la longitud de pszDest más 1 para tener en cuenta el carácter nulo de terminación. El número máximo de caracteres permitido es STRSAFE_MAX_CCH.
[in] pszSrc
Tipo: LPCTSTR de
Cadena de origen concatenada al final de pszDest. Esta cadena debe terminar en null.
[in] cchToAppend
Tipo: size_t
Número máximo de caracteres que se van a anexar a pszDest.
[out, optional] ppszDestEnd
Tipo:
Dirección de un puntero al final de pszDest. Si ppszDestEnd no esNULL y los datos se anexan al 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 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 |
|---|---|
|
Los datos de origen estaban presentes, las cadenas se concatenaron sin truncamiento y el búfer de destino resultante está terminado en null. |
|
El valor de cchDest es mayor que STRSAFE_MAX_CCH, se pasó una marca no válida o hay discrepancias entre el tamaño del pszDest, cchDesty la cantidad de material que se va a anexar en pszSrc. |
|
Error en la operación de copia debido a un espacio de búfer insuficiente. Según el valor de dwFlags, el búfer de destino puede contener una versión truncada y terminada en NULL del resultado previsto. En situaciones en las que el truncamiento es aceptable, es posible que esto no se vea necesariamente como una condición de error. |
Tenga en cuenta que esta función devuelve un valor de HRESULT, a diferencia de las funciones que reemplaza.
Observaciones
En comparación con las funciones que reemplaza, stringCchCatNEx 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. StringCchCatNEx siempre finaliza null y nunca desborda un búfer de destino válido, incluso si el contenido de la cadena de origen cambia durante la operación.
El comportamiento no está definido si las cadenas a las que apunta pszSrc y pszDest superposición.
Ni pszSrc ni pszDest deben ser NULL a menos que se especifique la marca de STRSAFE_IGNORE_NULLS, en cuyo caso ambos pueden ser NULL. Sin embargo, es posible que se devuelva un error debido a un espacio insuficiente aunque se omitan valores NULL.
stringCchCatNEx 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 se debe usar.
| Tipo de datos de cadena | Literal de cadena | Función |
|---|---|---|
| char | "string" | StringCchCatNExA |
| TCHAR | TEXT("string") | StringCchCatNEx |
| WCHAR | L"string" | StringCchCatNExW |
Nota
El encabezado strsafe.h define StringCchCatNEx 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
stringCchCatEx de