mui.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MUI_ENTRY
struct	MUI_ERROR
struct	MUI_PAGE
struct	MUI_STRING
struct	MUI_LANGUAGE_RESOURCE

Macros
#define	TEXT_ID_STATIC   (-1)
#define	TEXT_ID_FORMAT_PROMPT   1
#define	STRING_PLEASEWAIT   1
#define	STRING_INSTALLCREATEPARTITION   2
#define	STRING_INSTALLCREATELOGICAL   60
#define	STRING_INSTALLDELETEPARTITION   3
#define	STRING_DELETEPARTITION   59
#define	STRING_PARTITIONSIZE   4
#define	STRING_CHOOSENEWPARTITION   5
#define	STRING_CHOOSE_NEW_EXTENDED_PARTITION   57
#define	STRING_CHOOSE_NEW_LOGICAL_PARTITION   61
#define	STRING_HDDSIZE   6
#define	STRING_CREATEPARTITION   7
#define	STRING_PARTFORMAT   8
#define	STRING_NONFORMATTEDPART   9
#define	STRING_NONFORMATTEDSYSTEMPART   62
#define	STRING_NONFORMATTEDOTHERPART   63
#define	STRING_INSTALLONPART   10
#define	STRING_CONTINUE   12
#define	STRING_QUITCONTINUE   13
#define	STRING_REBOOTCOMPUTER   14
#define	STRING_DELETING   15
#define	STRING_MOVING   16
#define	STRING_RENAMING   17
#define	STRING_COPYING   18
#define	STRING_SETUPCOPYINGFILES   19
#define	STRING_REGHIVEUPDATE   20
#define	STRING_IMPORTFILE   21
#define	STRING_DISPLAYSETTINGSUPDATE   22
#define	STRING_LOCALESETTINGSUPDATE   23
#define	STRING_KEYBOARDSETTINGSUPDATE   24
#define	STRING_CODEPAGEINFOUPDATE   25
#define	STRING_DONE   26
#define	STRING_REBOOTCOMPUTER2   27
#define	STRING_CONSOLEFAIL1   28
#define	STRING_CONSOLEFAIL2   29
#define	STRING_CONSOLEFAIL3   30
#define	STRING_FORMATTINGDISK   31
#define	STRING_CHECKINGDISK   32
#define	STRING_FORMATDISK1   33
#define	STRING_FORMATDISK2   34
#define	STRING_KEEPFORMAT   35
#define	STRING_HDINFOPARTCREATE_1   36
#define	STRING_HDINFOPARTDELETE_1   39
#define	STRING_PARTTYPE   42
#define	STRING_HDDINFO_1   45
#define	STRING_HDDINFO_2   46
#define	STRING_NEWPARTITION   47
#define	STRING_UNPSPACE   48
#define	STRING_MAXSIZE   49
#define	STRING_UNFORMATTED   50
#define	STRING_EXTENDED_PARTITION   58
#define	STRING_FORMATUNUSED   51
#define	STRING_FORMATUNKNOWN   52
#define	STRING_KB   53
#define	STRING_MB   54
#define	STRING_GB   55
#define	STRING_ADDKBLAYOUTS   56
#define	STRING_REBOOTPROGRESSBAR   64

Typedefs
typedef struct MUI_ENTRY *	PMUI_ENTRY

Functions
VOID	MUIDisplayPage (ULONG PageNumber)
VOID	MUIClearPage (ULONG PageNumber)
VOID	MUIDisplayErrorV (IN ULONG ErrorNum, OUT PINPUT_RECORD Ir, IN ULONG WaitEvent, IN va_list args)
VOID __cdecl	MUIDisplayError (ULONG ErrorNum, PINPUT_RECORD Ir, ULONG WaitEvent,...)
VOID	SetConsoleCodePage (VOID)
PCSTR	MUIGetString (ULONG Number)
const MUI_ENTRY *	MUIGetEntry (IN ULONG Page, IN INT TextID)
VOID	MUIClearText (IN ULONG Page, IN INT TextID)
VOID	MUIClearStyledText (IN ULONG Page, IN INT TextID, IN INT Flags)
VOID	MUISetText (IN ULONG Page, IN INT TextID)
VOID	MUISetStyledText (IN ULONG Page, IN INT TextID, IN INT Flags)

Macro Definition Documentation

STRING_ADDKBLAYOUTS

#define STRING_ADDKBLAYOUTS   56

Definition at line 166 of file mui.h.

STRING_CHECKINGDISK

#define STRING_CHECKINGDISK   32

Definition at line 147 of file mui.h.

STRING_CHOOSE_NEW_EXTENDED_PARTITION

#define STRING_CHOOSE_NEW_EXTENDED_PARTITION   57

Definition at line 118 of file mui.h.

STRING_CHOOSE_NEW_LOGICAL_PARTITION

#define STRING_CHOOSE_NEW_LOGICAL_PARTITION   61

Definition at line 119 of file mui.h.

STRING_CHOOSENEWPARTITION

#define STRING_CHOOSENEWPARTITION   5

Definition at line 117 of file mui.h.

STRING_CODEPAGEINFOUPDATE

#define STRING_CODEPAGEINFOUPDATE   25

Definition at line 140 of file mui.h.

STRING_CONSOLEFAIL1

#define STRING_CONSOLEFAIL1   28

Definition at line 143 of file mui.h.

STRING_CONSOLEFAIL2

#define STRING_CONSOLEFAIL2   29

Definition at line 144 of file mui.h.

STRING_CONSOLEFAIL3

#define STRING_CONSOLEFAIL3   30

Definition at line 145 of file mui.h.

STRING_CONTINUE

#define STRING_CONTINUE   12

Definition at line 127 of file mui.h.

STRING_COPYING

#define STRING_COPYING   18

Definition at line 133 of file mui.h.

STRING_CREATEPARTITION

#define STRING_CREATEPARTITION   7

Definition at line 121 of file mui.h.

STRING_DELETEPARTITION

#define STRING_DELETEPARTITION   59

Definition at line 115 of file mui.h.

STRING_DELETING

#define STRING_DELETING   15

Definition at line 130 of file mui.h.

STRING_DISPLAYSETTINGSUPDATE

#define STRING_DISPLAYSETTINGSUPDATE   22

Definition at line 137 of file mui.h.

STRING_DONE

#define STRING_DONE   26

Definition at line 141 of file mui.h.

STRING_EXTENDED_PARTITION

#define STRING_EXTENDED_PARTITION   58

Definition at line 160 of file mui.h.

STRING_FORMATDISK1

#define STRING_FORMATDISK1   33

Definition at line 148 of file mui.h.

STRING_FORMATDISK2

#define STRING_FORMATDISK2   34

Definition at line 149 of file mui.h.

STRING_FORMATTINGDISK

#define STRING_FORMATTINGDISK   31

Definition at line 146 of file mui.h.

STRING_FORMATUNKNOWN

#define STRING_FORMATUNKNOWN   52

Definition at line 162 of file mui.h.

STRING_FORMATUNUSED

#define STRING_FORMATUNUSED   51

Definition at line 161 of file mui.h.

STRING_GB

#define STRING_GB   55

Definition at line 165 of file mui.h.

STRING_HDDINFO_1

#define STRING_HDDINFO_1   45

Definition at line 154 of file mui.h.

STRING_HDDINFO_2

#define STRING_HDDINFO_2   46

Definition at line 155 of file mui.h.

STRING_HDDSIZE

#define STRING_HDDSIZE   6

Definition at line 120 of file mui.h.

STRING_HDINFOPARTCREATE_1

#define STRING_HDINFOPARTCREATE_1   36

Definition at line 151 of file mui.h.

STRING_HDINFOPARTDELETE_1

#define STRING_HDINFOPARTDELETE_1   39

Definition at line 152 of file mui.h.

STRING_IMPORTFILE

#define STRING_IMPORTFILE   21

Definition at line 136 of file mui.h.

STRING_INSTALLCREATELOGICAL

#define STRING_INSTALLCREATELOGICAL   60

Definition at line 113 of file mui.h.

STRING_INSTALLCREATEPARTITION

#define STRING_INSTALLCREATEPARTITION   2

Definition at line 112 of file mui.h.

STRING_INSTALLDELETEPARTITION

#define STRING_INSTALLDELETEPARTITION   3

Definition at line 114 of file mui.h.

STRING_INSTALLONPART

#define STRING_INSTALLONPART   10

Definition at line 126 of file mui.h.

STRING_KB

#define STRING_KB   53

Definition at line 163 of file mui.h.

STRING_KEEPFORMAT

#define STRING_KEEPFORMAT   35

Definition at line 150 of file mui.h.

STRING_KEYBOARDSETTINGSUPDATE

#define STRING_KEYBOARDSETTINGSUPDATE   24

Definition at line 139 of file mui.h.

STRING_LOCALESETTINGSUPDATE

#define STRING_LOCALESETTINGSUPDATE   23

Definition at line 138 of file mui.h.

STRING_MAXSIZE

#define STRING_MAXSIZE   49

Definition at line 158 of file mui.h.

STRING_MB

#define STRING_MB   54

Definition at line 164 of file mui.h.

STRING_MOVING

#define STRING_MOVING   16

Definition at line 131 of file mui.h.

STRING_NEWPARTITION

#define STRING_NEWPARTITION   47

Definition at line 156 of file mui.h.

STRING_NONFORMATTEDOTHERPART

#define STRING_NONFORMATTEDOTHERPART   63

Definition at line 125 of file mui.h.

STRING_NONFORMATTEDPART

#define STRING_NONFORMATTEDPART   9

Definition at line 123 of file mui.h.

STRING_NONFORMATTEDSYSTEMPART

#define STRING_NONFORMATTEDSYSTEMPART   62

Definition at line 124 of file mui.h.

STRING_PARTFORMAT

#define STRING_PARTFORMAT   8

Definition at line 122 of file mui.h.

STRING_PARTITIONSIZE

#define STRING_PARTITIONSIZE   4

Definition at line 116 of file mui.h.

STRING_PARTTYPE

#define STRING_PARTTYPE   42

Definition at line 153 of file mui.h.

STRING_PLEASEWAIT

#define STRING_PLEASEWAIT   1

Definition at line 111 of file mui.h.

STRING_QUITCONTINUE

#define STRING_QUITCONTINUE   13

Definition at line 128 of file mui.h.

STRING_REBOOTCOMPUTER

#define STRING_REBOOTCOMPUTER   14

Definition at line 129 of file mui.h.

STRING_REBOOTCOMPUTER2

#define STRING_REBOOTCOMPUTER2   27

Definition at line 142 of file mui.h.

STRING_REBOOTPROGRESSBAR

#define STRING_REBOOTPROGRESSBAR   64

Definition at line 167 of file mui.h.

STRING_REGHIVEUPDATE

#define STRING_REGHIVEUPDATE   20

Definition at line 135 of file mui.h.

STRING_RENAMING

#define STRING_RENAMING   17

Definition at line 132 of file mui.h.

STRING_SETUPCOPYINGFILES

#define STRING_SETUPCOPYINGFILES   19

Definition at line 134 of file mui.h.

STRING_UNFORMATTED

#define STRING_UNFORMATTED   50

Definition at line 159 of file mui.h.

STRING_UNPSPACE

#define STRING_UNPSPACE   48

Definition at line 157 of file mui.h.

TEXT_ID_FORMAT_PROMPT

#define TEXT_ID_FORMAT_PROMPT   1

Definition at line 108 of file mui.h.

TEXT_ID_STATIC

#define TEXT_ID_STATIC   (-1)

Definition at line 105 of file mui.h.

Typedef Documentation

PMUI_ENTRY

typedef struct MUI_ENTRY * PMUI_ENTRY

Function Documentation

MUIClearPage()

VOID MUIClearPage

(

ULONG

PageNumber

)

MUIClearStyledText()

VOID MUIClearStyledText	(	IN ULONG	Page,
		IN INT	TextID,
		IN INT	Flags
	)

@MUIClearStyledText

Clears a portion of text from the console output, given the actual state style flag of the text.

Parameters

[in]	Page	The MUI (Multilingual User Interface) entry page number, as a unsigned long integer.
[in]	TextID	The text identification number (ID), as an integer. The parameter is used to identify its MUI properties like the coordinates, text style flag and its buffer content.
[in]	Flags	The text style flag, as an integer. The flag determines the style of the text, such as being highlighted, underlined, high padding and so on.

Returns

Nothing.

Definition at line 378 of file mui.c.

{
    const MUI_ENTRY * entry;
    ULONG Index = 0;

    /* Get the MUI entry */
    entry = MUIGetEntry(Page, TextID);

    if (!entry)
        return;

    /* Ensure that the text string given by the text ID and page is not NULL */
    while (entry[Index].Buffer != NULL)
    {
        /* If text ID is not correct, skip the entry */
        if (entry[Index].TextID != TextID)
        {
            Index++;
            continue;
        }

        /* Now, begin removing the text by calling CONSOLE_ClearStyledText() */
        CONSOLE_ClearStyledText(
            entry[Index].X,
            entry[Index].Y,
            Flags,
            (USHORT)strlen(entry[Index].Buffer));

        /* Increment the index and loop over next entires with the same ID */
        Index++;
    }
}

Referenced by FormatPartitionPage().

MUIClearText()

VOID MUIClearText	(	IN ULONG	Page,
		IN INT	TextID
	)

@MUIClearText

Clears a portion of text from the console output.

Parameters

[in]	Page	The MUI (Multilingual User Interface) entry page number, as a unsigned long integer.
[in]	TextID	The text identification number (ID), as an integer. The parameter is used to identify its MUI properties like the coordinates, text style flag and its buffer content.

Returns

Nothing.

Definition at line 323 of file mui.c.

{
    const MUI_ENTRY * entry;
    ULONG Index = 0;

    /* Get the MUI entry */
    entry = MUIGetEntry(Page, TextID);

    if (!entry)
        return;

    /* Ensure that the text string given by the text ID and page is not NULL */
    while (entry[Index].Buffer != NULL)
    {
        /* If text ID is not correct, skip the entry */
        if (entry[Index].TextID != TextID)
        {
            Index++;
            continue;
        }

        /* Remove the text by using CONSOLE_ClearTextXY() */
        CONSOLE_ClearTextXY(
            entry[Index].X,
            entry[Index].Y,
            (USHORT)strlen(entry[Index].Buffer));

        /* Increment the index and loop over next entires with the same ID */
        Index++;
    }
}

MUIDisplayError()

VOID __cdecl MUIDisplayError	(	ULONG	ErrorNum,
		PINPUT_RECORD	Ir,
		ULONG	WaitEvent,
			...
	)

MUIDisplayErrorV()

VOID MUIDisplayErrorV	(	IN ULONG	ErrorNum,
		OUT PINPUT_RECORD	Ir,
		IN ULONG	WaitEvent,
		IN va_list	args
	)

Definition at line 178 of file mui.c.

{
    const MUI_ERROR* entry;
    CHAR Buffer[2048];

    if (ErrorNum >= ERROR_LAST_ERROR_CODE)
    {
        PopupError("Invalid error number provided",
                   "Press ENTER to continue",
                   Ir,
                   POPUP_WAIT_ENTER);
        return;
    }

    entry = FindMUIErrorEntries();
    if (!entry)
    {
        PopupError("Error: Failed to find translated error message",
                   NULL,
                   NULL,
                   POPUP_WAIT_NONE);
        return;
    }

    vsprintf(Buffer, entry[ErrorNum].ErrorText, args);

    PopupError(Buffer,
               entry[ErrorNum].ErrorStatus,
               Ir,
               WaitEvent);
}

Referenced by MUIDisplayError(), and USetupErrorRoutine().

MUIDisplayPage()

VOID MUIDisplayPage

(

ULONG

PageNumber

)

MUIGetEntry()

const MUI_ENTRY* MUIGetEntry	(	IN ULONG	Page,
		IN INT	TextID
	)

@MUIGetEntry

Retrieves a MUI entry of a page, given the page number and the text ID.

Parameters

[in]	Page	The MUI (Multilingual User Interface) entry page number, as a unsigned long integer.
[in]	TextID	The text identification number (ID), as a unsigned integer. The parameter is used to identify its MUI properties like the coordinates, text style flag and its buffer content.

Returns

Returns a constant MUI entry.

Definition at line 276 of file mui.c.

{
    const MUI_ENTRY * entry;
    ULONG index;

    /* Retrieve the entries of a MUI page */
    entry = FindMUIEntriesOfPage(Page);
    if (!entry)
    {
        DPRINT("MUIGetEntryData(): Failed to get the translated entry page!\n");
        return NULL;
    }

    /* Loop over the ID entries and check if it matches with one of them */
    for (index = 0; entry[index].Buffer != NULL; index++)
    {
        if (entry[index].TextID == TextID)
        {
            /* They match so return the MUI entry */
            return &entry[index];
        }
    }

    /* Page number or ID are incorrect so in this case bail out */
    DPRINT("Couldn't get the MUI entry field from the page!\n");
    return NULL;
}

Referenced by MUIClearStyledText(), MUIClearText(), MUISetStyledText(), and MUISetText().

MUIGetString()

PCSTR MUIGetString

(

ULONG

Number

)

Definition at line 230 of file mui.c.

{
    ULONG i;
    const MUI_STRING * entry;
    CHAR szErr[128];

    entry = FindMUIStringEntries();
    if (entry)
    {
        for (i = 0; entry[i].Number != 0; i++)
        {
            if (entry[i].Number == Number)
            {
                return entry[i].String;
            }
        }
    }

    sprintf(szErr, "Error: failed find string id %lu for language index %lu\n", Number, FindLanguageIndex());

    PopupError(szErr,
               NULL,
               NULL,
               POPUP_WAIT_NONE);

    return "<nostring>";
}

Referenced by BootLoaderPage(), CheckFileSystemPage(), CreateExtendedPartitionPage(), CreateLogicalPartitionPage(), CreatePrimaryPartitionPage(), DeletePartitionPage(), DiskDescription(), DoChkdsk(), DoFormat(), DrawFileSystemList(), FileCopyCallback(), FileCopyPage(), FormatPartitionPage(), GetPartitionTypeString(), PartitionDescription(), PrettifySize1(), PrettifySize2(), ProgressCountdown(), QuitPage(), RegistryPage(), RegistryStatus(), RunUSetup(), SelectFileSystemPage(), SelectPartitionPage(), and ShowPartitionSizeInputBox().

MUISetStyledText()

VOID MUISetStyledText	(	IN ULONG	Page,
		IN INT	TextID,
		IN INT	Flags
	)

@MUISetStyledText

Prints a text to the console output, with a style for it.

Parameters

[in]	Page	The MUI (Multilingual User Interface) entry page number, as a unsigned long integer.
[in]	TextID	The text identification number (ID), as an integer. The parameter is used to identify its MUI properties like the coordinates, text style flag and its buffer content.
[in]	Flags	The text style flag, as an integer. The flag determines the style of the text, such as being highlighted, underlined, high padding and so on.

Returns

Nothing.

Definition at line 483 of file mui.c.

{
    const MUI_ENTRY * entry;
    ULONG Index = 0;

    /* Get the MUI entry */
    entry = MUIGetEntry(Page, TextID);

    if (!entry)
        return;

    /* Ensure that the text string given by the text ID and page is not NULL */
    while (entry[Index].Buffer != NULL)
    {
        /* If text ID is not correct, skip the entry */
        if (entry[Index].TextID != TextID)
        {
            Index++;
            continue;
        }

        /* Print the text to the console output by calling CONSOLE_SetStyledText() */
        CONSOLE_SetStyledText(entry[Index].X, entry[Index].Y, Flags, entry[Index].Buffer);

        /* Increment the index and loop over next entires with the same ID */
        Index++;
    }
}

MUISetText()

VOID MUISetText	(	IN ULONG	Page,
		IN INT	TextID
	)

@MUISetText

Prints a text to the console output.

Parameters

[in]	Page	The MUI (Multilingual User Interface) entry page number, as a unsigned long integer.
[in]	TextID	The text identification number (ID), as an integer. The parameter is used to identify its MUI properties like the coordinates, text style flag and its buffer content.

Returns

Nothing.

Definition at line 431 of file mui.c.

{
    const MUI_ENTRY * entry;
    ULONG Index = 0;

    /* Get the MUI entry */
    entry = MUIGetEntry(Page, TextID);

    if (!entry)
        return;

    /* Ensure that the text string given by the text ID and page is not NULL */
    while (entry[Index].Buffer != NULL)
    {
        /* If text ID is not correct, skip the entry */
        if (entry[Index].TextID != TextID)
        {
            Index++;
            continue;
        }

        /* Print the text to the console output by calling CONSOLE_SetTextXY() */
        CONSOLE_SetTextXY(entry[Index].X, entry[Index].Y, entry[Index].Buffer);

        /* Increment the index and loop over next entires with the same ID */
        Index++;
    }
}

SetConsoleCodePage()

VOID SetConsoleCodePage

(

VOID

)

Definition at line 516 of file mui.c.

{
    UINT wCodePage;

#if 0
    ULONG lngIndex = 0;

    while (ResourceList[lngIndex].MuiPages != NULL)
    {
        if (_wcsicmp(ResourceList[lngIndex].LanguageID, SelectedLanguageId) == 0)
        {
            wCodePage = (UINT) wcstoul(ResourceList[lngIndex].OEMCPage, NULL, 10);
            SetConsoleOutputCP(wCodePage);
            return;
        }

        lngIndex++;
    }
#else
    wCodePage = (UINT)wcstoul(MUIGetOEMCodePage(SelectedLanguageId), NULL, 10);
    SetConsoleOutputCP(wCodePage);
#endif
}

Referenced by LanguagePage(), and SetupStartPage().