Función RtlStringCchCopyA (ntstrsafe.h)
Las funciones de RtlStringCchCopyW y RtlStringCchCopyA copian una cadena de origen terminada en null en un búfer de destino de longitud especificada.
Sintaxis
NTSTRSAFEDDI RtlStringCchCopyA(
[out] NTSTRSAFE_PSTR pszDest,
[in] size_t cchDest,
[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] 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 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 |
---|---|
|
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. |
|
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. |
|
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:
|
Observaciones
RtlStringCchCopyW y RtlStringCchCopyA deben usarse en lugar de las funciones siguientes:
- strcpy
- wcscpy
El tamaño, en caracteres, del búfer de destino se proporciona para 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 usa 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 | "string" | rtlStringCchCopyA de |
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, 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 |