Función RtlStringCchCopyW (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCchCopyW y RtlStringCchCopyA copian una cadena de origen terminada en null en un búfer de destino de longitud especificada.

Sintaxis

NTSTRSAFEDDI RtlStringCchCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [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] cchDest

Tamaño, en caracteres, del búfer de destino. 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.

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 cchDest es mayor que el tamaño máximo del búfer.
  • Había un puntero NULL .
  • La longitud del búfer de destino era cero en la entrada.

Comentarios

RtlStringCchCopyW y RtlStringCchCopyA deben usarse en lugar de las siguientes funciones:

  • strcpy
  • wcscpy
Estas funciones no son reemplazos de strncpy. Use RtlStringCchCopyN o RtlStringCchCopyNEx para reemplazar strncpy.

El tamaño, en caracteres, del búfer de destino se proporciona a RtlStringCchCopyW y RtlStringCchCopyA para asegurarse de que no escriben más allá del final del búfer.

Use RtlStringCchCopyW para controlar cadenas Unicode y RtlStringCchCopyA 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" RtlStringCchCopyW
char "cadena" RtlStringCchCopyA
 

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

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

RtlStringCbCopy

RtlStringCchCopyEx