UPMEULGN or U32EULGN

The UPMEULGN API logs on a user. This function supports a logon prompt and registers user IDs like the command-line logon.

To use the UPMEULGN API, you must be linked to the UPM.LIB library. In addition, you need at least 8KB of free stack space.

Restrictions

A call to this API can be issued only from an OS/2 application to the local computer.

Syntax

• #include <upm.h>
   
  LSINT LSFAR LSPAS
  UPMEULGN(pszUserID, pszPassword, pszRemotename,
           remotetype, flags);    /* 16 bit */
   
  LSINT LSFAR LSPAS
  U32EULGN(pszUserID, pszPassword, pszRemotename,
           remotetype, flags);    /* 32 bit */
  

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

pszPassword

(unsigned char LSFAR *) points to an ASCIIZ string containing the password of the user name, obtained by an application's request to the user. A null pointer or string indicates that no password is needed. After a user is logged on to a requester, the pszPassword and pszUserID are verified again by LAN Server whenever the same requester attempts to access a remote resource.
pszRemotename
(unsigned char LSFAR *) points to the name identifying the node or domain for which the user ID and password are required. If remotetype is UPM_LOCAL, pszRemotename is ignored.
remotetype
(16-bit unsigned short or 32-bit unsigned long) is the type of node named in pszRemotename for which the user ID and password are required. The following are the possible values: ┌─────────────────────────┬───────┬────────────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ VALUE │ MEANING │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_LOCAL │ 1 │ Indicates the local node. If 386 HPFS is │
│ │ │ installed, a user logging on locally is │
│ │ │ assigned 386-HPFS local access unless a │
│ │ │ domain logon has been performed. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_DNODE │ 2 │ Specifies that remotename is the name of │
│ │ │ an LU 6.2 node to which the user wants to │
│ │ │ log on. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_DOMAIN │ 3 │ Specifies that remotename is the name of a │
│ │ │ domain. If the 386 HPFS is installed, the │
│ │ │ domain user being logged on is assigned │
│ │ │ 386-HPFS access. flags only has an effect │
│ │ │ for remotetype of UPM_DOMAIN. │
├─────────────────────────┴───────┴────────────────────────────────────────────┤
│ Bits 2-15 are reserved and must be 0. │
└──────────────────────────────────────────────────────────────────────────────┘

flags
(16-bit unsigned short or 32-bit unsigned long) is a bit mask for LAN Server logon verification. Valid values for bits 0 and 1 are: ┌─────────────────────────┬───────┬────────────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ BIT │ MEANING │
│ │ MASK │ │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_FL_LOCVER │ 0x01 │ Verification of logon at the local work- │
│ │ │ station. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_FL_NOVER │ 0x02 │ No logon verification required. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_FL_DOMVER │ 0x03 │ Verification of logon to the domain. │
└─────────────────────────┴───────┴────────────────────────────────────────────┘

Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌────────────────────────┬─────────────────────────────────────────────────────┐│SYMBOLICCONSTANT │MEANING │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_OK │ The user was logged on successfully. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_LOG_INPROC │ Another logon was being processed; the logon │
│ │ attempt was not successful. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_BAD_TYPE │ The remote type specified was not valid. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_NOMEM │ Insufficient memory is available to process the │
│ │ request. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_LOG_FILE_NOT_FOUND │ A required logon program was not found. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_FAIL _ SECURITY │TheuserIDorpasswordcouldnotbevalidated . │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_ULP_LOADED │ The local logon failed; a local logon with a user │
│ │ logon profile is already active. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_PASSWORD_EXP │ The logon failed; the user's password is expired. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_UNAVAIL │ The logon failed; the remote node or domain could │
│ │ not be contacted to process the logon request. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_ACTIVE │ The domain logon or logoff failed; a domain logon, │
│ │ logoff, or the LAN Requester graphical user inter- │
│ │ face is active. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_SS_PWDEXPWARNING │ The local logon succeeded. The user's password is │
│ │ expired. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_SS_BUSY │ The local logon failed; the secure shell was busy. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_SS_DEAD │ The local logon failed; the secure shell has │
│ │ stopped. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_LOGGED │ The domain logon failed because a domain logon has │
│ │ already occurred. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_SYS_ERROR │ An unexpected system error occurred. │
├────────────────────────┼─────────────────────────────────────────────────────┤
│ UPM_BAD_PARAMETER │ The user ID, password, or remote name was not │
│ │ valid. │
└────────────────────────┴─────────────────────────────────────────────────────┘


---

[Back: UPMEULGF or U32EULGF]
[Next: Remarks]