Función RtlUnicodeStringCopy (ntstrsafe.h)

La función RtlUnicodeStringCopy copia una cadena de una estructura UNICODE_STRING a otra.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

Parámetros

[out] DestinationString

Puntero a una estructura de UNICODE_STRING . La cadena de origen se copia en 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 de UNICODE_STRING . Esta estructura incluye un búfer que contiene la cadena de origen. Esta cadena se copiará en 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).

Valor devuelto

RtlUnicodeStringCopy 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 y el búfer de destino resultante ha terminado en null.
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 de la cadena de origen.
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.

 

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

• El contenido de una estructura de 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.

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

Comentarios

La función RtlUnicodeStringCopy 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. Si la cadena debe truncarse al final del búfer de destino, la función no finaliza la cadena resultante con un carácter null.

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

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

RtlUnicodeStringCopyEx

UNICODE_STRING