Función StringCbCatNW (strsafe.h)

  • Artículo

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 después del final de este búfer.

StringCbCatN es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCbCatNW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
  [in]      size_t          cbToAppend
);

Parámetros

[in, out] pszDest

Tipo: LPTSTR

El búfer de destino, que contiene la cadena que se va a concatenar a pszSrc, y recibirá la cadena resultante. La cadena en pszSrc, hasta bytes cbMaxAppend , 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

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
S_OK
 Los datos de origen estaban presentes, las cadenas se concatenaron sin truncamiento y el búfer de destino resultante termina en null.
STRSAFE_E_INVALID_PARAMETER
 El valor de cbDest es mayor que el valor máximo permitido o el búfer de destino ya está lleno.
STRSAFE_E_INSUFFICIENT_BUFFER
 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 HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

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 termina en 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 se superponen.

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 debe usar.

String (Tipo de datos) Literal de cadena Función
char "cadena" 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 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

StringCbCat

StringCbCatNEx

StringCchCatN