Use this function to log on to the server. The logon function must be executed once when commencing a server session and is valid for the duration of the session.
Syntax
Login(string userName, string password, string code, string options, out string sessionID, out string xmlResult )
| Parameter | Description |
|---|---|
|
userName |
User account |
|
password |
Password in plain text. This parameter is used only if the code parameter contains an empty string. |
|
code |
Encrypted password created using Encoder.exe. |
|
options |
The Login XML that allows you to pass an alias username, that will then be used when the session creates a new communication. See Login_XML.xml for more information. To use this functionality, you must also modify the MWS configuration. See the serviceuser element in "mws Element in Composer.MWS.exe.config" in the Content Composer Advanced Design and Setup Guide for more information. |
|
sessionID |
Session identifier, returns the session ID that must be used for all subsequent calls. |
|
xmlResult |
The respective UserInfo XML when login execution was successful, otherwise Error XML. |
Return Value
| Value | Description |
|---|---|
| 0 | OK |
| <>0 |
Error See Error Codes. |