Función RtlStringCchCopyNA (ntstrsafe.h)

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

Sintaxis

NTSTRSAFEDDI RtlStringCchCopyNA(
  [out] NTSTRSAFE_PSTR pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH 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 de pszSrc, hasta caracteres de cchSrc, se copia en el búfer en pszDest y finaliza 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 proporcionada por el autor de la llamada y terminada en NULL.

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 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 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 NULL. La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

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 recibir 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 solo sentido. Si cchSrc es mayor que el número de caracteres de pszSrc, RtlStringCchCopyNW y RtlStringCch LosdeCopyNA ,a diferencia de strncpy, no siguen rellenando pszDest con caracteres NULL hasta que se hayan copiado cchSrc caracteres.

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	"string"	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, 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

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx