Función RtlStringCbCatNA (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCbCatNW y RtlStringCbCatNA concatenan dos cadenas con recuento de bytes al limitar el tamaño de la cadena anexada.

Sintaxis

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

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

[in] cbDest

Tamaño del búfer de destino, en bytes. El búfer debe ser lo suficientemente grande como para incluir las cadenas 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

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

cbToAppend

Número máximo de bytes 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 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 RtlStringCbCatNW y RtlStringCbCatNA en lugar de las siguientes funciones:

  • strncat
  • wcsncat
El tamaño, en bytes, del búfer de destino se proporciona a RtlStringCbCatNW y RtlStringCbCatNA para asegurarse de que no escriben más allá del final del búfer.

Use RtlStringCbCatNW para controlar cadenas Unicode y RtlStringCbCatNA 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" RtlStringCbCatNW
char "cadena" RtlStringCbCatNA
 

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

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN