Compartir a través de

Función RtlStringCchCopyNW (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCchCopyNW y RtlStringCchCopyNA copian una cadena con recuento de caracteres en un búfer y limitan el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

Parámetros

[out] pszDest

Puntero a un búfer proporcionado por el autor de la llamada que recibe la cadena copiada. La cadena en pszSrc, hasta caracteres cchSrc , se copia en el búfer en pszDest y termina con un carácter nulo.

[in] cchDest

Tamaño del búfer de destino, en caracteres. El número máximo de caracteres permitido es NTSTRSAFE_MAX_CCH.

[in] pszSrc

Puntero a una cadena terminada en null proporcionada por el autor de la llamada.

cchToCopy

Número máximo de caracteres que se van a copiar de pszSrc al búfer proporcionado por pszDest.

Valor devuelto

La función devuelve uno de los valores NTSTATUS que se enumeran en la tabla siguiente. Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de 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 termina en null.
STATUS_BUFFER_OVERFLOW
 Este estado de advertencia significa que la operación de copia no se completó debido a un espacio insuficiente en el búfer de destino. El búfer de destino contiene una versión truncada de la cadena copiada.
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, vea el siguiente párrafo.

La función devuelve el valor STATUS_INVALID_PARAMETER cuando:

  • El valor de cchDest es mayor que el tamaño máximo del búfer.
  • El búfer de destino ya estaba lleno.
  • Había un puntero NULL .
  • La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Comentarios

RtlStringCchCopyNW y RtlStringCchCopyNA deben usarse en lugar de strncpy.

Las funciones copian un número determinado de caracteres de una cadena de origen. RtlStringCchCopyNW y RtlStringCchCopyNA reciben el tamaño, en caracteres, del búfer de destino para asegurarse de que las funciones no escriben más allá del final del búfer.

Tenga en cuenta que estas funciones se comportan de forma diferente a strncpy en un sentido. Si cchSrc es mayor que el número de caracteres de pszSrc, RtlStringCchCopyNW y RtlStringCchCopyNA, a diferencia de strncpy, no continúe rellenando pszDest con caracteres NULL hasta que se hayan copiado los caracteres cchSrc .

Use RtlStringCchCopyNW para controlar cadenas Unicode y RtlStringCchCopyNA para controlar cadenas ANSI. El formulario que use depende de los datos, como se muestra en la tabla siguiente.

Tipo de datos String Literal de cadena Función
WCHAR L"string" RtlStringCchCopyNW
char "cadena" RtlStringCchCopyNA
 

Si pszSrc y pszDest apuntan a cadenas superpuestas, el comportamiento de la función no está definido.

Ni pszSrc ni pszDest pueden ser NULL. Si necesita controlar valores de puntero de cadena NULL , use RtlStringCchCopyNEx.

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

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx