Función StringCbCatNA (strsafe.h)
Concatena el número especificado de bytes de una cadena a otra. El tamaño, en bytes, 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.
StringCbCatN es un reemplazo de las funciones siguientes:
Sintaxis
STRSAFEAPI StringCbCatNA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToAppend
);
Parámetros
[in, out] pszDest
Tipo: LPTSTR de
El búfer de destino, que contiene la cadena que se va a concatenar a pszSrcy recibirá la cadena resultante. La cadena de pszSrc, hasta cbMaxAppend bytes, se agrega al final de la cadena en pszDest.
[in] cbDest
Tipo: size_t
Tamaño del búfer de destino, en bytes. Este valor debe tener en cuenta la longitud de pszSrc más la longitud de pszDest o cbMaxAppend (lo que sea menor) más el carácter nulo de terminación. El número máximo de bytes permitido es STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Tipo: LPCTSTR de
Cadena de origen que se va a concatenar al final de pszDest. Esta cadena de origen debe terminar en null.
[in] cbToAppend
Tipo: size_t
Número máximo de bytes que se van a anexar a pszDest.
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 cbDest es mayor que el valor máximo permitido o el búfer de destino ya está lleno. |
|
Error en la operación de concatenación debido a un espacio de búfer insuficiente. El búfer de destino contiene una versión truncada 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, StringCbCatN 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. StringCbCatN 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. Consulte StringCbCatNEx si necesita el control de valores de puntero de cadena NULL.
StringCbCatN 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" | stringCbCatNA |
| TCHAR | TEXT("string") | StringCbCatN |
| WCHAR | L"string" | StringCbCatNW |
Nota
El encabezado strsafe.h define StringCbCatN 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