Compartir a través de


Función RtlStringCchCopyNExA (ntstrsafe.h)

Las de RtlStringCchCopyNExW y RtlStringCchCopyNExA funciones copian una cadena con recuento de caracteres en un búfer al limitar el tamaño de la cadena copiada.

Sintaxis

NTSTRSAFEDDI RtlStringCchCopyNExA(
  [out, optional] NTSTRSAFE_PSTR pszDest,
  [in]            size_t         cchDest,
  [in, optional]  STRSAFE_PCNZCH pszSrc,
                  size_t         cchToCopy,
  [out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

Parámetros

[out, optional] 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. El puntero pszDest de puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS se establece en dwFlags.

[in] cchDest

Tamaño, en caracteres, del búfer de destino. El número máximo de caracteres permitido es NTSTRSAFE_MAX_CCH. Si pszDest es NULL, cchDest debe ser cero.

[in, optional] 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.

[out, optional] ppszDestEnd

Si el autor de la llamada proporciona un puntero de dirección que no esNULL, una vez completada la operación de copia, la función carga esa dirección con un puntero al terminador de cadena null resultante del búfer de destino.

[out, optional] pcchRemaining

Si el autor de la llamada proporciona un puntero de dirección que no esNULL, la función carga la dirección con el número de caracteres sin usar que están en el búfer al que apunta pszDest, incluido el carácter nulo de terminación.

[in] dwFlags

Una o varias marcas y, opcionalmente, un byte de relleno. Las marcas se definen de la siguiente manera:

Valor Significado
STRSAFE_FILL_BEHIND_NULL Si se establece esta marca y la función se ejecuta correctamente, se usa el byte bajo de dwFlags para rellenar la parte del búfer de destino que sigue al carácter nulo de terminación.
STRSAFE_IGNORE_NULLS Si se establece esta marca, pszDest o pszSrc, o ambas, puede ser NULL. punterospszSrc null se tratan como cadenas vacías (TEXT("")), que se pueden copiar. punterospszDest NULL no pueden recibir cadenas no vacías.
STRSAFE_FILL_ON_FAILURE Si se establece esta marca y se produce un error en la función, se usa el byte bajo de dwFlags para rellenar todo el búfer de destino y el búfer termina en null. Esta operación sobrescribe el contenido del búfer preexistente.
STRSAFE_NULL_ON_FAILURE Si se establece esta marca y se produce un error en la función, el búfer de destino se establece en una cadena vacía (TEXT("")). Esta operación sobrescribe el contenido del búfer preexistente.
STRSAFE_NO_TRUNCATION

Si se establece esta marca y la función devuelve STATUS_BUFFER_OVERFLOW:

  • Si también se especifica STRSAFE_FILL_ON_FAILURE, STRSAFE_NO_TRUNCATION rellena el búfer de destino en consecuencia.
  • De lo contrario, el contenido del búfer de destino se establecerá en una cadena vacía, incluso si no se establece STRSAFE_NULL_ON_FAILURE. STRSAFE_FILL_BEHIND_NULL se omite.

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. Si STRSAFE_NO_TRUNCATION se establece en dwFlags, consulte el parámetro dwFlags para obtener más información.
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:

  • Se especificó una marca no válida.
  • El valor de cchDest es mayor que el tamaño máximo del búfer.
  • El búfer de destino ya estaba lleno.
  • Hay un puntero NULL sin la marca STRSAFE_IGNORE_NULLS.
  • El puntero del búfer de destino se NULL, pero el tamaño del búfer no era cero.
  • El puntero del búfer de destino se NULL, o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

RtlStringCchCopyNExW y RtlStringCchCopyNExA en lugar de strncpy. Las funciones copian un número determinado de caracteres de una cadena de origen. El tamaño, en caracteres, del búfer de destino se proporciona para rtlStringCchCopyNExW y rtlStringCchCopyNExA para asegurarse de que 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, RtlStringCchCopyNExW y RtlStringCch Elde strncpy deCopyNExA no sigue rellenando pszDest con caracteres NULL hasta que se hayan copiado caracteres cchSrc.

rtlStringCchCopyNExW y RtlStringCchCopyNExA agregar a la funcionalidad de RtlStringCchCopyN devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. Las marcas se pueden pasar a la función para un control adicional.

Use rtlStringCchCopyNExW para controlar cadenas Unicode y RtlStringCchCopyNExA 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" rtlStringCchCopyNExW
char "string" rtlStringCchCopyNExA

Si pszSrc y pszDest apuntan a cadenas superpuestas, el comportamiento de la función no está definido.

Ni pszSrc ni pszDest pueden ser NULL a menos que se establezca la marca STRSAFE_IGNORE_NULLS, en cuyo caso o ambos pueden ser NULL. Si pszDest es NULL, pszSrc debe ser null o apuntar a una cadena vacía.

Para obtener más información sobre las funciones de cadena segura, consulte Uso de funciones de cadena seguras.

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