RtlInitStringEx function (ntifs.h)

The RtlInitStringEx routine initializes a counted string of 8-bit characters.

Syntax

NTSYSAPI NTSTATUS RtlInitStringEx(
  [out]          PSTRING               DestinationString,
  [in, optional] __drv_aliasesMem PCSZ SourceString
);

Parameters

[out] DestinationString

A pointer to the STRING structure to be initialized. The Ntdef.h header file defines this structure to be identical to the ANSI_STRING structure.

[in, optional] SourceString

A pointer to a null-terminated character string. This string is used to initialize the counted string pointed to by DestinationString.

Return value

Returns STATUS_NAME_TOO_LONG if the SourceString is too long. Otherwise, this routine returns STATUS_SUCCESS.

Remarks

This routine initializes a counted character string.

The routine copies the SourceString pointer value to the Buffer member of the STRING structure pointed to by DestinationString. The Length member of this structure is set to the length, in bytes, of the source string, excluding the terminating null. The MaximumLength member of the structure is set to the length, in bytes, of the source string, including the terminating null. If SourceString is NULL, Length and MaximumLength are both set to zero.

RtlInitStringEx does not alter the source string pointed to by SourceString.

Callers of RtlInitStringEx can be running at IRQL <= DISPATCH_LEVEL if the DestinationString buffer is nonpageable. Usually, callers run at IRQL = PASSIVE_LEVEL because most other RtlXxxString routines cannot be called at IRQL > PASSIVE_LEVEL.

Requirements

See also

ANSI_STRING