Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › Name Method—Sets or Retrieves the User's Username

Name Method—Sets or Retrieves the User's Username

The Name method sets or retrieves the user's username.

Syntax

The Name method has the following format:

Netegrity::AgentUser‑>Name([username])

Parameters

The Name method accepts the following parameter:

username (string)

(Optional) Specifies the username to set.

Return Value

The Name method returns the following value:

• username (string)

  Specifies the new or existing username.

Remarks

Setting the username only affects the current instance of the user object. It does not affect the user's entry in the directory.