Función RtlStringCbCopyW (ntstrsafe.h)

  • Artículo

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

Sintaxis

NTSTRSAFEDDI RtlStringCbCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR 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 termina 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 terminada en null proporcionada por el autor de la llamada.

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 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, vea el siguiente párrafo.

La función devuelve el valor 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 .
  • La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Comentarios

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

  • strcpy
  • wcscpy
RtlStringCbCopyA y RtlStringCbCopyW no son sustitutos 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 "cadena" 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 los valores de puntero de cadena NULL , use RtlStringCbCopyEx.

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

RtlStringCbCopyEx

RtlStringCchCopy