UPMEULGF or U32EULGF

The UPMEULGF API logs a user off the system.

To use this API, you must be linked to the UPM.LIB library. In addition, you should have 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.

All parameters must be valid; if not, an error is returned.

For the remotetype of UPM_DOMAIN and UPM_DOMAIN_MAX_FORCE, the pszRemotename is ignored if the logon was performed with no verification or local verification.

Syntax

• #include <upm.h>
   
  LSINT LSFAR LSPAS
  UPMEULGF(pszUserID, pszRemotename,
           remotetype);    /* 16 bit */
   
  LSINT LSFAR LSPAS
  U32EULGF(pszUserID, pszRemotename,
           remotetype);    /* 32 bit */
  

Parameters

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

pszRemotename

(unsigned char LSFAR *) points to the name of the node or domain for which the user is logging off.
remotetype
(16-bit unsigned short or 32-bit unsigned long) is the type of node for pszRemotename. The following are the possible values: ┌─────────────────────────┬───────┬────────────────────────────────────────────┐
│ Symbolic Constant │ VALUE │ MEANING │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_LOCAL │ 1 │ The local node. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_DNODE │ 2 │ Specifies that remotename is the name of a │
│ │ │ node from which the user wants to log off. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_DOMAIN │ 3 │ Specifies that remotename is the name of a │
│ │ │ domain. If the domain user being logged │
│ │ │ off also has 386 HPFS access, the local │
│ │ │ user logged on is assigned the 386 HPFS │
│ │ │ local security access. │
├─────────────────────────┼───────┼────────────────────────────────────────────┤
│ UPM_DOMAIN_MAX_FORCE │ 4 │ Same meaning as UPM_DOMAIN, except that │
│ │ │ all connections are forced closed. │
└─────────────────────────┴───────┴────────────────────────────────────────────┘

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 off successfully. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_BAD_TYPE │ The remote type specified was not valid. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_NOT_LOGGED │ The specified user ID was not logged on. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_OPEN_SESSIONS │ The domain logoff failed because a domain logon has │
│ │ active open sessions. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_SYS_ERROR │ An unexpected system error occurred. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_BAD_PARAMETER │ The user ID or remote name was not valid. │
├───────────────────┼──────────────────────────────────────────────────────────┤
│ UPM_ACTIVE │ The domain logon or logoff failed; a domain logon, │
│ │ logoff, or the LAN Requester graphical user interface is │
│ │ active. │
└───────────────────┴──────────────────────────────────────────────────────────┘


---

[Back: UPMELOCU or U32ELOCU]
[Next: UPMEULGN or U32EULGN]