Función RtlStringCbCopyUnicodeString (ntstrsafe.h)

La función RtlStringCbCopyUnicodeString copia el contenido de una estructura de UNICODE_STRING en un destino especificado.

Sintaxis

NTSTRSAFEDDI RtlStringCbCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  PCUNICODE_STRING SourceString
);

Parámetros

[out] pszDest

Puntero a un búfer que recibe la cadena copiada. La cadena a la que apunta la estructura UNICODE_STRING del parámetro SourceString se copia en el búfer en pszDest y termina con un carácter nulo.

[in] cbDest

Tamaño, en bytes, del búfer de destino al que apunta pszDest . El búfer debe ser lo suficientemente grande como para contener la cadena y el carácter nulo de terminación. El número máximo de bytes del búfer es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

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

Valor devuelto

RtlStringCbCopyUnicodeString devuelve uno de los siguientes valores NTSTATUS.

Código devuelto	Descripción
STATUS_SUCCESS	Este estado de éxito significa que los datos de origen se encontraban presentes, la cadena se copió sin truncamiento y el búfer de destino resultante terminó 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 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.

 

RtlStringCbCopyUnicodeString 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 valor de cbDest es mayor que el tamaño máximo del búfer.
• El búfer de destino (al que pszDest apunta) 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 RtlStringCbCopyUnicodeString usa el tamaño del búfer de destino (que especifica el parámetro cbDest ) para asegurarse de que la operación de copia no escribe más allá del final del búfer.

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

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

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 a partir de Windows XP con Service Pack 1 (SP1).
Plataforma de destino	Escritorio
Encabezado	ntstrsafe.h (incluya Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL	PASSIVE_LEVEL

Consulte también

RtlStringCbCopyUnicodeStringEx

RtlStringCchCopyUnicodeString

UNICODE_STRING