Función RtlUnicodeStringCbCopyN (ntstrsafe.h)

La función RtlUnicodeStringCbCopyN copia una cadena de una estructura de UNICODE_STRING a otra, al tiempo que limita el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCbCopyN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString,
  [in]  size_t           cbToCopy
);

Parámetros

[out] DestinationString

Puntero a una estructura de UNICODE_STRING que recibe la cadena copiada. La cadena a la que apunta la estructura de UNICODE_STRING del parámetro SourceString se copia en el búfer al que apunta la estructura de UNICODE_STRING del parámetro DestinationString. El número máximo de bytes del búfer de cadena de la estructura DestinationString es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Puntero a una estructura de UNICODE_STRING que contiene la cadena que se va a copiar. El número máximo de bytes del búfer de cadena de la estructura es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] cbToCopy

Número de bytes que se van a copiar del origen al destino.

Valor devuelto

RtlUnicodeStringCbCopyN devuelve uno de los siguientes valores NTSTATUS.

Código devuelto	Descripción
STATUS_SUCCESS	Este estado correcto significa que los datos de origen están presentes, la cadena se copió sin truncamiento.
STATUS_BUFFER_OVERFLOW	Este estado de advertencia significa que la operación de copia no se completó debido a un espacio de búfer insuficiente. El búfer de destino contiene una versión truncada 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.

 

RtlUnicodeStringCbCopyN 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 cbToCopy 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 RtlUnicodeStringCbCopyN usa el tamaño del búfer de destino para asegurarse de que la operación de copia 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 de 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 RtlUnicodeStringCbCopyNEx .

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

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING