Función RtlUnicodeStringInit (ntstrsafe.h)

  • Artículo

La función RtlUnicodeStringInit inicializa una estructura UNICODE_STRING.

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

Parámetros

[out] DestinationString

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.

[in, optional] pszSrc

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

Valor devuelto

rtlUnicodeStringInit devuelve uno de los siguientes valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS
 Este correcto estado significa que los datos de origen se encontraban presentes, la cadena se copió sin truncamiento y el búfer de destino resultante está terminado en null.
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 la lista siguiente.
 

RtlUnicodeStringInit 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 de pszSrc no es null.
Para obtener información sobre cómo probar valores NTSTATUS, vea Using NTSTATUS Values.

Observaciones

La función RtlUnicodeStringInit hace lo siguiente:

  • Establece el miembro Length de la estructura de UNICODE_STRING a la que apunta el parámetro pszSrc longitud, en bytes, de la cadena a la que apunta el parámetro pszSrc.
  • Establece el miembro MaximumLength de la estructura UNICODE_STRING a la longitud, en bytes, de la cadena a la que apunta el parámetro pszSrc más 2 bytes.
  • Establece el Buffer de la estructura de UNICODE_STRING en la dirección que especifica el parámetro pszSrc .
El puntero DestinationString no debe ser NULL. Si necesita especificar valores de punteroDestinationString NULL, use la función RtlUnicodeStringInitEx.

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 a partir de Windows XP con Service Pack 1 (SP1).
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

rtlUnicodeStringInitEx

UNICODE_STRING