ITAgent::get_User method (tapi3.h)

The get_User method gets the agent user name, which is the same as the operating system user login or e-mail name.

Syntax

HRESULT get_User(
  [out] BSTR *ppUser
);

Parameters

[out] ppUser

Pointer to BSTR containing user name.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The ppUser parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

The application must free the memory allocated for the ppUser parameter through SysFreeString when the variable is no longer needed.

Requirements

Requirement Value
Target Platform Windows
Header tapi3.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITAgent