Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FifteenWindows/OS Functions (continued)

GetUserName Function

Overview

The GetUserName function returns information about the user name and the domain to which the user belongs.

Syntax/Parameters

Syntax

string = GetUserName ( [int mode] );

Parameters

mode

An optional int specifying whether to get the user name (0), the domain name (1) or full name (2). The default is user name.

Return Value

A string containing the user name information or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The GetUserName function returns information about the user logged onto the system on which the script is executing. For example:

string u_name, d_name, f_name;

 

u_name = GetUserName();

d_name = GetUserName(1);

f_name = GetUserName(2);

 

AddMessage("User Name   : %s", u_name);

AddMessage("Domain Name : %s", d_name);

AddMessage("Full Name   : %s", f_name);

 

This code might return (actual returned data depends on the user and network):

User Name   : john.smith

Domain Name : ABC

Full Name   : John Q. Smith

 

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic