Función RtlStringCbCopyNW (ntstrsafe.h)

Las funciones de RtlStringCbCopyNW y RtlStringCbCopyNA copian una cadena con recuento de bytes en un búfer al limitar el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlStringCbCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cbToCopy
);

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 cbSrc bytes, se copia en el búfer en pszDest y finaliza con un carácter NULO.

[in] cbDest

Tamaño, en bytes, del búfer de destino. El búfer debe ser lo suficientemente grande para la cadena como para el carácter nulo de terminación.

Para las cadenas Unicode, el número máximo de bytes es NTSTRSAFE_MAX_CCH * tamaño de(WCHAR).

Para las cadenas ANSI, el número máximo de bytes es NTSTRSAFE_MAX_CCH * tamaño de(char).

[in] pszSrc

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

cbToCopy

Número máximo de bytes que se van a copiar de pszSrc a 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 Using NTSTATUS Values.

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 está terminado en null.
STATUS_BUFFER_OVERFLOW	Esta advertencia estado 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 error estado 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. La función devuelve el valor de STATUS_INVALID_PARAMETER cuando: El valor de cbDest es mayor que el tamaño máximo del búfer. El búfer de destino ya estaba lleno. Había un puntero NULL NULL. La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

RtlStringCbCopyNW y RtlStringCbCopyNA deben usarse en lugar de strncpy. Sin embargo, estas funciones difieren en el comportamiento. Si cbSrc es mayor que el número de bytes de pszSrc, las funciones RtlStringCbCopyN , a diferencia de strncpy, no rellenen pszDest con caracteres NULL hasta que se hayan copiado cbSrc bytes.

RtlStringCbCopyN copia un número determinado de bytes de una cadena de origen. El tamaño, en bytes, del búfer de destino se proporciona a la función para asegurarse de que RtlStringCbCopyN no escribe más allá del final de este búfer.

Use RtlStringCbCopyNW para controlar cadenas Unicode y rtlStringCbCopyNA 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"	rtlStringCbCopyNW de
char	"string"	RtlStringCbCopyNA

 

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, consulte RtlStringCbCopyNEx.

Para obtener más información sobre las funciones de cadena segura, vea Using Safe String Functions.

Requisitos

Requisito	Valor
cliente mínimo admitido	Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
de la plataforma de destino de	Escritorio
encabezado de	ntstrsafe.h (incluya Ntstrsafe.h)
biblioteca de	Ntstrsafe.lib
irQL	Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

rtlStringCbCopy de

rtlStringCbCopyNEx

rtlStringCchCopyN