VMS Help LGI Routines, LGI$ICB_PASSWORD  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The LGI$ICB_PASSWORD callback routine produces the specified
    password prompt and then processes the input.

    Format

      LGI$ICB_PASSWORD  password_number ,prompt ,buffer

1 - Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

    Condition value in R0.

2 - Arguments

 password_number

    OpenVMS usage:value
    type:         longword (unsigned)
    access:       read only
    mechanism:    by value
    A numeric value indicating which password to prompt for and what
    action to take on it:

    ValuePrompt for

    0    Primary password and validate it
    1    Secondary password and validate it
    -1   Primary password but do not validate it
    -2   Secondary password but do not validate it
    -3   Arbitrary 32-character value returned to buffer specified in
         buffer

    If the value is -3, you must specify the prompt argument and the
    buffer argument.

 prompt

    OpenVMS usage:character string
    type:         string descriptor
    access:       read only
    mechanism:    by reference
    String that must begin with "cr,lf". If this argument is not
    supplied, the standard prompt is used.

 buffer

    OpenVMS usage:character string
    type:         string descriptor
    access:       modify
    mechanism:    by reference
    Buffer having at least 32 bytes available to store password when
    password_number argument value is -3.

3 - Description

    The site can use this callback routine to interactively prompt
    for passwords. The routine uses either the standard OpenVMS
    password prompt or a prompt provided by the caller in the second
    argument.

    The password is returned in one of the following locations,
    depending on the value of the password_number argument:

    Value of Password_
    Number Argument        Location

    0 or -1                LGI$A_ICR_PWD1
    1 or -2                LGI$A_ICR_PWD2
    -3                     buffer argument

                                   NOTE

       This routine will do overstriking, if necessary, to support
       echo local terminals. See the OpenVMS Programming Concepts
       Manual for more information about echo terminals.

4 - Condition Values Returned

    SS$_NORMAL         Success.
    LGI$_INVPWD        Password check failed.
    LGI$_NOSUCHUSER    No UAF record found.