Compartir a través de

Función RtlUnicodeStringInitEx (ntstrsafe.h)

  • Artículo

La función RtlUnicodeStringInitEx inicializa una estructura de UNICODE_STRING .

Sintaxis

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

Parámetros

[out] DestinationString

Opcional. Puntero a una estructura de UNICODE_STRING que se va a inicializar. El puntero pszSrc se copia en la estructura UNICODE_STRING del parámetro DestinationString. El número máximo de caracteres de la cadena a la que apunta pszSrc es NTSTRSAFE_UNICODE_STRING_MAX_CCH. DestinationString puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[in, optional] pszSrc

Opcional. Puntero a una constante de cadena terminada en null. Este puntero de cadena se copiará en el miembro Buffer de la estructura UNICODE_STRING a la que apunta el parámetro DestinationString . Este puntero de cadena puede ser NULL.

[in] dwFlags

Se define la marca siguiente:

STRSAFE_IGNORE_NULLS

Si se establece esta marca, el puntero de origen puede ser NULL. RtlUnicodeStringInitEx trata punteros de búfer de origen NULL como cadenas vacías (TEXT("")), que se pueden copiar.

Valor devuelto

RtlUnicodeStringInitEx devuelve uno de los siguientes 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 ha terminado en null.
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.
 

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

  • La longitud de la cadena a la que apunta el parámetro pszSrc es mayor que NTSTRSAFE_UNICODE_STRING_MAX_CCH caracteres.
  • El puntero DestinationString es NULL, pero el puntero pszSrc no es NULL.
Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.

Comentarios

La función RtlUnicodeStringInitEx hace lo siguiente:

  • Establece el miembro Length de la estructura UNICODE_STRING en la longitud, en bytes, de la cadena a la que apunta el parámetro pszSrc .
  • Establece el miembro MaximumLength de la estructura UNICODE_STRING en la longitud, en bytes, de la cadena a la que apunta el parámetro pszSrc a más 2 bytes.
  • Establece el miembro Buffer de la estructura UNICODE_STRING en la dirección que especifica el parámetro pszSrc .
El puntero DestinationString no puede ser NULL a menos que se establezca la marca STRSAFE_IGNORE_NULLS.

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

RtlUnicodeStringInit

UNICODE_STRING