Unix
Mac OS X
Windows
Options
Unix
Windows

# Module passphrase Methods

## GetPhrase

GetPhrase() gets a phrase from the terminal.

The format of the GetPhrase method is:

      WizardBooleanType GetPhrase(const char *prompt,PassphraseMode flags,
        StringInfo *phrase)

A description of each parameter follows:

##### prompt

Prompt the user for the passphrase.

##### flags

modify the behavior of this method by setting one or more of these flags:

        EchoOffMode     Turn off echo (default).
        EchoOnMode      Leave echo on.
        RequireTTYMode  Fail if there is no tty.
        ForceLowerMode  Force input to lower case.
        ForceUpperMode  Force input to upper case.
        SevenBitMode    Strip the high bit from input.
        StdinMode       Read from stdin, not /dev/tty.

##### phrase

The passphrase is returned in this buffer.

## GetPassphrase

GetPassphrase() gets a passphrase from the terminal and returns it.

The format of the GetPassphrase method is:

      StringInfo GetPassphrase(ExceptionInfo *exception)

A description of each parameter follows:

##### prompt

Prompt the user for the passphrase.

Discourse Server