Función RtlUnicodeStringCbCatN (ntstrsafe.h)

La función RtlUnicodeStringCbCatN concatena dos cadenas contenidas en UNICODE_STRING estructuras, al tiempo que limita el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCbCatN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      PCUNICODE_STRING SourceString,
  [in]      size_t           cbToAppend
);

Parámetros

[in, out] DestinationString

Puntero a una estructura 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 bytes del búfer de cadena de la estructura es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Puntero a una estructura 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 bytes del búfer de cadena de la estructura es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] cbToAppend

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

Valor devuelto

RtlUnicodeStringCbCatN devuelve uno de los siguientes valores NTSTATUS.

Código devuelto	Descripción
STATUS_SUCCESS	Este estado de éxito 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 la lista siguiente.

 

RtlUnicodeStringCbCatN devuelve el valor 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 cbToAppend es mayor que NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.

Comentarios

La función RtlUnicodeStringCbCatN 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.

Los punteros SourceString y DestinationString no pueden ser NULL. Si necesita controlar valores de puntero NULL , use la función RtlUnicodeStringCbCatNEx .

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	Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

RtlUnicodeStringCbCatNEx

RtlUnicodeStringCchCatN

UNICODE_STRING