Función RtlStringCbCopyA (ntstrsafe.h)

Artículo
02/07/2025

Las funciones de RtlStringCbCopyW y RtlStringCbCopyA copian una cadena con recuento de bytes en un búfer.

Sintaxis

NTSTRSAFEDDI RtlStringCbCopyA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  NTSTRSAFE_PCSTR pszSrc
);

Parámetros

[out] pszDest

Puntero a un búfer proporcionado por el autor de la llamada que recibe la cadena copiada. La cadena de pszSrc 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 como para la cadena y el carácter nulo de terminación.

En el caso de las cadenas Unicode, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

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

[in] pszSrc

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

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	Este advertencia estado 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 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.

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

Este advertencia estado 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 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

RtlStringCbCopyA y RtlStringCbCopyW deben usarse en lugar de las funciones siguientes:

strcpy
wcscpy

RtlStringCbCopyA y RtlStringCbCopyW no son reemplazos de strncpy. Para reemplazar strncpy, use rtlStringCbCopyN o RtlStringCbCopyNEx.

El tamaño del búfer de destino se proporciona a la función para asegurarse de que rtlStringCbCopy no escribe más allá del final del búfer.

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

Tipo de datos string	Literal de cadena	Función
WCHAR	L"string"	RtlStringCbCopyW
char	"string"	rtlStringCbCopyA

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

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

rtlStringCbCopyEx

RtlStringCchCopy

Compartir a través de