RtlNextUnicodePrefix function

The RtlNextUnicodePrefix routine is used to enumerate the elements in a Unicode prefix table.

Syntax

NTSYSAPI PUNICODE_PREFIX_TABLE_ENTRY RtlNextUnicodePrefix(
  PUNICODE_PREFIX_TABLE PrefixTable,
  BOOLEAN               Restart
);

Parameters

PrefixTable

Pointer to the prefix table. The table must have been initialized by calling RtlInitializeUnicodePrefix.

Restart

Set to TRUE if the enumeration is to start at the first element in the table. Set to FALSE if resuming the enumeration from a previous call.

To enumerate all elements in the table, use RtlNextUnicodePrefix as follows:

for (p = RtlNextUnicodePrefix ( Table, TRUE );
     p != NULL;
     p = RtlNextUnicodePrefix ( Table, FALSE )) {
        // Process the element pointed to by p
}

Return Value

RtlNextUnicodePrefix returns a pointer to the next element, if one exists. If there are no more elements in the table, RtlNextUnicodePrefix returns NULL.

Remarks

File systems must call RtlInitializeUnicodePrefix to initialize the prefix table before using any other Rtl..UnicodePrefix routines on it. The initialized prefix table structure should be considered opaque.

Callers of the Rtl..UnicodePrefix routines are responsible for synchronizing access to the prefix table. A fast mutex is the most efficient synchronization mechanism to use for this purpose.

For information about other string-handling routines, see Strings.

Requirements

   
Windows version Windows XP Windows Server 2003
Target Platform Universal
Header ntifs.h (include Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL "< DISPATCH_LEVEL"

See Also

RtlFindUnicodePrefix

RtlInitializeUnicodePrefix

RtlInsertUnicodePrefix

RtlRemoveUnicodePrefix