Función RtlStringCchCatNW (ntstrsafe.h)

Las funciones RtlStringCchCatNW y RtlStringCchCatNA concatenan dos cadenas con recuento de caracteres al limitar el tamaño de la cadena anexada.

Sintaxis

NTSTRSAFEDDI RtlStringCchCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cchToAppend
);

Parámetros

[in, out] pszDest

Puntero a un búfer que, en la entrada, contiene una cadena terminada en null a la que pszSrc se concatenará. En la salida, este es el búfer de destino que contiene toda la cadena resultante. La cadena en pszSrc, hasta caracteres cchMaxAppend , se agrega al final de la cadena en pszDest y termina con un carácter null.

[in] cchDest

Tamaño del búfer de destino, en caracteres. El número máximo de caracteres permitido es NTSTRSAFE_MAX_CCH.

[in] pszSrc

Un puntero a una cadena terminada en null. Esta cadena se concatenará al final de la cadena contenida en el búfer en pszDest.

cchToAppend

Número máximo de caracteres que se van a anexar a la cadena contenida en el búfer en pszDest.

Valor devuelto

La función devuelve uno de los valores NTSTATUS que se enumeran en la tabla siguiente. Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS
Este estado correcto significa que los datos de origen estaban presentes, las cadenas se concatenaron sin truncamiento y el búfer de destino resultante termina en null.
STATUS_BUFFER_OVERFLOW
Este estado de advertencia significa que la operación de concatenación no se completó debido a un espacio de búfer insuficiente. El búfer de destino contiene una versión truncada terminada en null del resultado previsto.
STATUS_INVALID_PARAMETER
Este estado de error significa que la función recibió un parámetro de entrada no válido. Para obtener más información, consulte el párrafo siguiente.

La función devuelve el valor STATUS_INVALID_PARAMETER cuando:

  • El valor de cchDest es mayor que el tamaño máximo del búfer.
  • El búfer de destino ya estaba lleno.
  • Había un puntero NULL .
  • La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Comentarios

Se debe usar RtlStringCchCatNW y RtlStringCchCatNA en lugar de las siguientes funciones:

  • strncat
  • wcsncat
El tamaño, en caracteres, del búfer de destino se proporciona a la función para asegurarse de que RtlStringCchCatNW y RtlStringCchCatNA no escriban más allá del final del búfer.

Use RtlStringCchCatNW para controlar cadenas Unicode y RtlStringCchCatNA para controlar cadenas ANSI. El formulario que use depende de los datos, como se muestra en la tabla siguiente.

Tipo de datos String Literal de cadena Función
WCHAR L"string" RtlStringCchCatNW
Char "cadena" RtlStringCchCatNA
 

Si pszSrc y pszDest apuntan a cadenas superpuestas, el comportamiento de la función no está definido.

Ni pszSrc ni pszDest pueden ser NULL. Si necesita controlar los valores de puntero de cadena NULL , use RtlStringCchCatNEx.

Para obtener más información sobre las funciones de cadena segura, consulte Uso de funciones de cadena segura.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado ntstrsafe.h (incluya Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Consulte también

RtlStringCbCatN

RtlStringCchCat

RtlStringCchCatNEx