Función RtlUnicodeStringCchCatN (ntstrsafe.h)

La función RtlUnicodeStringCchCatN concatena dos cadenas contenidas en UNICODE_STRING estructuras al limitar el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCchCatN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      PCUNICODE_STRING SourceString,
  [in]      size_t           cchToAppend
);

Parámetros

[in, out] DestinationString

Puntero a una estructura de UNICODE_STRING. Esta estructura incluye un búfer que, en la entrada, contiene una cadena de destino a la que se concatenará la cadena de origen. En la salida, este búfer es el búfer de destino que contiene toda la cadena resultante. La cadena de origen se agrega al final de la cadena de destino. El número máximo de caracteres del búfer de cadenas de la estructura es NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] SourceString

Puntero a una estructura de UNICODE_STRING. Esta estructura incluye un búfer que contiene la cadena de origen. Esta cadena se agregará al final de la cadena de destino. El número máximo de caracteres del búfer de cadenas de la estructura es NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] cchToAppend

Número máximo de caracteres que se van a anexar a la cadena que describe el parámetro DestinationString.

Valor devuelto

rtlUnicodeStringCchCatN devuelve uno de los siguientes valores NTSTATUS.

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	Esta advertencia estado significa que la operación concatenada 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 la lista siguiente.

 

RtlUnicodeStringCchCatN devuelve el valor de STATUS_INVALID_PARAMETER cuando se produce una de las siguientes acciones:

• El contenido de la estructura UNICODE_STRING no es válido.
• El búfer de destino ya está lleno.
• Un puntero de búfer es NULL.
• La longitud del búfer de destino es cero, pero existe una cadena de origen de longitud distinta de cero.
• El valor del parámetro cchToAppend es mayor que NTSTRSAFE_UNICODE_STRING_MAX_CCH.

Para obtener información sobre cómo probar valores NTSTATUS, vea Using NTSTATUS Values.

Observaciones

La función rtlUnicodeStringCchCatN usa el tamaño del búfer de destino para asegurarse de que la operación de concatenación no escribe más allá del final del búfer. La función no finaliza la cadena resultante con un valor de carácter nulo (es decir, con cero).

Si las cadenas de origen y destino se superponen, el comportamiento de la función no está definido.

El sourceString de y los punteros DestinationString no se pueden NULL. Si necesita controlar valores de puntero NULL, use la función RtlUnicodeStringCchCatNEx.

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

RtlUnicodeStringCbCatN

RtlUnicodeStringCchCatNEx

UNICODE_STRING