Función RtlStringCbCatA (ntstrsafe.h)

Las funciones de RtlStringCbCatW y RtlStringCbCatA concatenan dos cadenas contadas por 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 se concatenará pszSrc. 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 finaliza con un carácter NULL.

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

En el caso de 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

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 Using NTSTATUS Values.

Código devuelto	Descripción
STATUS_SUCCESS	Este correcto estado significa que los datos de origen estaban presentes, las cadenas se concatenaron sin truncamiento y el búfer de destino resultante está terminado en null.
STATUS_BUFFER_OVERFLOW	Este advertencia estado 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 error estado 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 NULL. La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

RtlStringCbCatW y RtlStringCbCatA en lugar de las funciones siguientes:

• strcat
• wcscat

Dado que rtlStringCbCatW y rtlStringCbCatA recibir 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, tal como se muestra en la tabla siguiente.

Tipo de datos string	Literal de cadena	Función
WCHAR	L"string"	rtlStringCbCatW
char	"string"	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 valores de puntero de cadena NULL, use RtlStringCbCatNEx.

Para obtener más información sobre las funciones de cadena segura, vea Using Safe String Functions.

Requisitos

Requisito	Valor
cliente mínimo admitido	Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
de la plataforma de destino de	Escritorio
encabezado de	ntstrsafe.h (incluya Ntstrsafe.h)
biblioteca de	Ntstrsafe.lib
irQL	Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

rtlStringCbCatEx de

RtlStringCbCatNEx

rtlStringCchCatEx