Función StringCchCatNW (strsafe.h)

  • Artículo

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

StringCchCatN es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCchCatNW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
  [in]      size_t          cchToAppend
);

Parámetros

[in, out] pszDest

Tipo: LPTSTR

El búfer de destino, que contiene la cadena que se va a concatenar con pszSrc, y recibirá toda la cadena resultante. La cadena en pszSrc, hasta caracteres cchMaxAppend , 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 o cchMaxAppend (lo que sea menor). Para esta suma, agregue 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

Cadena de origen que se concatena 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.

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 cchDest es mayor que STRSAFE_MAX_CCH 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, StringCchCatN 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. StringCchCatN 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 se superponen.

Ni pszSrc ni pszDest deben ser NULL. Consulte StringCchCatNEx si necesita el control de valores de puntero de cadena NULL.

StringCchCatN 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" StringCchCatNA
TCHAR TEXT("string") StringCchCatN
WCHAR L"string" StringCchCatNW
 

Nota

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

StringCbCatN

StringCchCat

StringCchCatNEx