Función RtlStringCbCatA (ntstrsafe.h)

Las funciones RtlStringCbCatW y RtlStringCbCatA concatenan dos cadenas con recuento de bytes.

Sintaxis

NTSTRSAFEDDI RtlStringCbCatA(
  [in, out] NTSTRSAFE_PSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      NTSTRSAFE_PCSTR pszSrc
);

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 de pszSrc se agrega al final de la cadena en pszDest y termina con un carácter nulo.

[in] cbDest

Tamaño del búfer de destino, en bytes. El búfer de destino debe ser lo suficientemente grande como para incluir las cadenas concatenadas y el carácter nulo de terminación.

Para las cadenas Unicode, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Para las cadenas ANSI, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(char).

[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.

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.

El STATUS_INVALID_PARAMETER valor devuelto significa que se produjo una de las siguientes acciones:

  • El valor de cbDest 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 RtlStringCbCatW y RtlStringCbCatA en lugar de las siguientes funciones:

  • strcat
  • wcscat
Dado que RtlStringCbCatW y RtlStringCbCatA reciben el tamaño del búfer de destino como entrada, no escribirán más allá del final del búfer.

Use RtlStringCbCatW para controlar cadenas Unicode y RtlStringCbCatA para controlar cadenas ANSI. El formulario que se va a usar viene determinado por los datos, como se muestra en la tabla siguiente.

Tipo de datos String Literal de cadena Función
WCHAR L"string" RtlStringCbCatW
char "cadena" RtlStringCbCatA
 

Si pszSrc y pszDest apuntan a cadenas que se superponen, el comportamiento de las funciones no está definido.

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

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

RtlStringCbCatEx

RtlStringCbCatNEx

RtlStringCchCatEx