LotusScript for Visual Basic Programmers - IBM Redbooks

Accessing Notes Session Properties
HTGetProperty fetches one of various session-level property values into a
supplied buffer. Each property has a data type, and the buffer must be large
enough to hold the result.
HTSetProperty assigns a value to a session-level property. The type of the
data is indicated by the property. When setting the value of properties
which are inherited by newly opened databases, the new value has no effect
on currently open databases.
Let’s look at an example.
Example
This example retrieves and prints a session property for the current user’s
name.
Dim hgstatus As Long
Dim hgvalue As String
hgvalue = String(HTMaxLen_User_Name, 0)
hgstatus = HTInit(0)
hgstatus = HTGetProperty(HTSession_User_Name, ByVal hgvalue)
hgvalue = Left(hgvalue, InStr(hgvalue, Chr$(0)) - 1)
If hgstatus = 0 Then Print "The current user is " & hgvalue &
"."
hgstatus = HTTerm(0)
Following is an explanation of the code.
We declare an hgstatus variable. All the status codes we get later will be
put in the variable.
Dim hgstatus As Long
We declare hgvalue as a string which will store the user name of the Notes
session.
Dim hgvalue As String
114 LotusScript for Visual Basic Programmers