Función RtlUnicodeStringCopyStringEx (ntstrsafe.h)

  • Artículo

La función RtlUnicodeStringCopyStringEx copia una cadena en una estructura de UNICODE_STRING .

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringCopyStringEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Parámetros

[out] DestinationString

Opcional. Puntero a una estructura de UNICODE_STRING que recibe la cadena copiada. La cadena a la que apunta el parámetro pszSrc (excepto el valor NULL de terminación) se copia en el búfer al que apunta la estructura UNICODE_STRING del parámetro DestinationString. El número máximo de bytes de la cadena es NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). DestinationString puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[in] pszSrc

Opcional. Puntero a una cadena terminada en null que se copiará en el búfer al que apunta la estructura del parámetro DestinationStringUNICODE_STRING . pszSrc puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[out, optional] RemainingString

Opcional. Si el autor de la llamada proporciona un puntero distinto de NULL a una estructura de UNICODE_STRING , la función establece el miembro Buffer de esta estructura al final de la cadena concatenada, establece el miembro Length de la estructura en cero y establece el miembro MaximumLength de la estructura en el número de bytes que quedan en el búfer de destino. RemainingString puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[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 Si se establece esta marca y la función se realiza correctamente, el byte bajo de dwFlags se usa para rellenar la parte del búfer de destino que sigue al último carácter de la cadena.
STRSAFE_IGNORE_NULLS Si se establece esta marca, el puntero de origen o destino, o ambos, puede ser NULL. RtlUnicodeStringCopyStringEx trata punteros de búfer de origen NULL como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros de búfer de destino 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. Esta operación sobrescribe cualquier contenido de 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 cualquier contenido de 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.
STRSAFE_ZERO_LENGTH_ON_FAILURE Si se establece esta marca y la función devuelve STATUS_BUFFER_OVERFLOW, la longitud de la cadena de destino se establece en cero bytes.

Valor devuelto

RtlUnicodeStringCopyStringEx devuelve uno de los siguientes valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS Este estado correcto significa que los datos de origen estaban presentes y las cadenas se concatenaron sin truncamiento.
STATUS_BUFFER_OVERFLOW Este estado de advertencia 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, el búfer de destino no se modifica. Si no se establece la marca, el búfer de destino contiene una versión truncada de la cadena copiada.
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, consulte la lista siguiente.

RtlUnicodeStringCopyStringEx devuelve el valor de STATUS_INVALID_PARAMETER cuando se produce una de las siguientes acciones:

  • El contenido de una estructura de UNICODE_STRING no es válido.
  • Se especifica una marca no válida en dwFlags.
  • El búfer de destino ya está lleno.
  • Un puntero de búfer es NULL y la marca STRSAFE_IGNORE_NULLS no se especifica en dwFlags.
  • El puntero del búfer de destino es NULL, pero el tamaño del búfer no es cero.
  • El puntero del búfer de destino es NULL o su longitud es cero, pero existe una cadena de origen de longitud distinta de cero.

Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.

Comentarios

La función RtlUnicodeStringCopyStringEx usa el tamaño del búfer de destino para asegurarse de que la operación de concatenación no escribe después del final del búfer. De forma predeterminada, la función no finaliza la cadena resultante con un valor de carácter NULO (es decir, con cero). Como opción, el autor de la llamada puede usar la marca de STRSAFE_FILL_BEHIND y un valor de byte de relleno de cero para terminar en null una cadena resultante que no ocupa todo el búfer de destino.

RtlUnicodeStringCopyStringEx agrega a la funcionalidad de la función RtlUnicodeStringCopyString devolviendo una estructura de UNICODE_STRING que identifica el final de la cadena de destino y el número de bytes que quedan sin usar en esa cadena. Puede pasar marcas a RtlUnicodeStringCopyStringEx para un control adicional.

Si las cadenas de origen y de destino se superponen, el comportamiento de la función no está definido.

Los punteros pszSrc y DestinationString no pueden ser NULL a menos que la marca de STRSAFE_IGNORE_NULLS esté establecida en dwFlags. Si se establece STRSAFE_IGNORE_NULLS, uno o ambos punteros pueden ser NULL. Si el puntero DestinationString es NULL, el puntero 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 Value
Cliente mínimo compatible Disponible a partir de Windows XP con Service Pack 1 (SP1).
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