Función RtlUnicodeStringCbCopyStringN (ntstrsafe.h)

  • Artículo

La función RtlUnicodeStringCbCopyStringN copia una cadena en una estructura de UNICODE_STRING y limita el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszSrc,
  [in]  size_t           cbToCopy
);

Parámetros

[out] DestinationString

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

[in] pszSrc

Puntero a la cadena que se va a copiar.

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

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 destino se superponen, el comportamiento de la función no está definido.

Los punteros pszSrc 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 PASSIVE_LEVEL

Consulte también

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING