LotusScript for Visual Basic Programmers - IBM Redbooks

More documents

Recommendations

Info

For every HiTest application, we must initialize the Notes session as a first step. Other functions can only be called after session initialization. If the initialize is unsuccessful, it will return either HTFAIL_HITEST_VERSION (program built with incompatible HiTest API version) or HTFAIL_NOTES_VERSION (the HiTest API requires Notes Release 3.0 or higher) to hgstatus. hgstatus = HTInit(0) We set the string length as the maximum length of the user name in Notes. HTMaxLen_User_Name is a constant defined by HiTest to present the maximum length of the Notes user name. hgvalue = String(HTMaxLen_User_Name, 0) We get the user name and store it in hgvalue. hgstatus = HTGetProperty(HTSession_User_Name, ByVal hgvalue) We set the string to only contain valid characters. hgvalue = Left(hgvalue, InStr(hgvalue, Chr$(0)) - 1) We print out the user name. If hgstatus = 0 Then Print "The current user is " & hgvalue & "." We close the Notes session. Each HTInit function must be closed. If there is a failure, the same failure code will be returned as for HTInit. hgstatus = HTTerm(0) Accessing Notes Session Environment Values HTGetEnvironmentString retrieves the value of a Notes environment string variable. Notes stores environment variables in the NOTES.INI file. Use the HTSetEnvironmentString function to modify Notes environment variables. To retrieve import/export formats, which are stored in multiple environment variables, use the functions HTCompositeListImport and HTCompositeListExport. HTSetEnvironmentString assigns a value to a Notes environment string variable. The calling program controls whether to create a new environment variable. Notes stores environment variables in the NOTES.INI file. Use the HTGetEnvironmentString function to retrieve Notes environment variables. Use care when modifying Notes environment variables, since they affect the Notes client and server programs. Let’s look at an example. Chapter 6: Accessing Notes Sessions 115
Example This example sets the value of a Notes environment variable in the NOTES.INI. If the variable does not already exist, it is created. Dim hgstatus As Long hgstatus = HTInit(0) hgstatus = HTSetEnvironmentString("TestOfAPI", "It worked", HTSetEnvF_Create) If hgstatus = 0 Then Print "This environment variable has been set in your notes.ini file." hgstatus = HTTerm(0) Following is an explanation of the code. We set the environment TestOfAPI to “It worked”. If the TestOfAPI does not already exist in NOTES.INI, we create it. If it fails, an error code is returned: “Value is longer than the maximum environment string length”. hgstatus = HTSetEnvironmentString("TestOfAPI", "It worked", HTSetEnvF_Create) If the setting is successful, we print out a message to inform the user. If hgstatus = 0 Then Print "This environment variable has been set in your notes.ini file." Accessing Notes Sessions in Visual Basic Using Notes Classes through OLE Automation Using Notes classes through OLE Automation in Visual Basic, we present the session as NotesSession. The NotesSession class provides a means for accessing attributes of the user environment and information about agents. It also provides methods for accessing environment variables. Following is a table which converts the HiTest Basic API functions accessing Notes sessions to the equivalent functions and properties using Notes classes through OLE Automation: 116 LotusScript for Visual Basic Programmers
Page 1 and 2:
LotusScript for Visual Basic Progra
Page 3 and 4:
Abstract This redbook describes how
Page 5 and 6:
NotesTimer ................... ....
Page 7 and 8:
Preface This redbook describes how
Page 9 and 10:
Chapter 12, “Using Notes as an OL
Page 11 and 12:
Chapter 1 LotusScript and Visual Ba
Page 13 and 14:
Object-Oriented Terminology LotusSc
Page 15 and 16:
There are many good examples of how
Page 17 and 18:
LotusScript only allows arrays and
Page 19 and 20:
File I/O Code such as the following
Page 21 and 22:
"frmMain::cmdUpdateDB_Click") then
Page 23 and 24:
MessageBox Visual Basic developers
Page 25 and 26:
Extending the Code Visual Basic pro
Page 27 and 28:
Lotus Components You can add Window
Page 29 and 30:
Lotus, creating a cut-down version
Page 31 and 32:
Once you have created the object, y
Page 33 and 34:
Public Function PostError(ErrNumber
Page 35 and 36:
1. Consts move out of the class int
Page 37 and 38:
In Visual Basic sending a message i
Page 39 and 40:
Where LotusScript commands and synt
Page 41 and 42:
Chapter 2 The Notes Integrated Deve
Page 43 and 44:
Action Pane This is the narrow wind
Page 45 and 46:
Run Area The three radio buttons sp
Page 47 and 48:
4. Click the Methods twistie, and a
Page 49 and 50:
When you enter structured programmi
Page 51 and 52:
ut the results are different. Such
Page 53 and 54:
Before we let the code run to the b
Page 55 and 56:
The following figure shows the hier
Page 57 and 58:
NotesACL Every NotesDatabase contai
Page 59 and 60:
NotesAgent NotesAgent is contained
Page 61 and 62:
Method Description New Creates a ne
Page 63 and 64:
Method Description UnprocessedSearc
Page 65 and 66:
NotesDateTime NotesDateTime is cont
Page 67 and 68:
Property Description Name Read-only
Page 69 and 70:
Method Description Save Saves any c
Page 71 and 72: Property Description UniversalID Re
Page 73 and 74: NotesEmbeddedObject The NotesEmbedd
Page 75 and 76: NotesInternational The NotesInterna
Page 77 and 78: NotesLog Property Description IsNam
Page 79 and 80: NotesName The NotesName class will
Page 81 and 82: NotesRichTextItem NotesRichTextItem
Page 83 and 84: Method Description CreateNewsletter
Page 85 and 86: NotesTimer The NotesTimer class wil
Page 87 and 88: Method Description GetPrevSibling G
Page 89 and 90: NotesUIWorkspace NotesUIWorkspace c
Page 91 and 92: Method Description FindFreeTimeDial
Page 93 and 94: NotesUIDatabase The NotesUIDatabase
Page 95 and 96: The following figure shows how it w
Page 97 and 98: Dim doc As Object We create a refer
Page 99 and 100: Declaring Notes Classes in Visual B
Page 101 and 102: In Visual Basic, we can access the
Page 103 and 104: Dim doc As Object Dim item As Objec
Page 105 and 106: The following figure shows a Visual
Page 107 and 108: Chapter 5 Converting HiTest Applica
Page 109 and 110: We declare an hgstatus variable. Al
Page 111 and 112: Converting a HiTest Application Usi
Page 113 and 114: 2. Put the following code on the Cr
Page 115 and 116: Converting a HiTest Application to
Page 117 and 118: 6. Enter the following code on the
Page 119 and 120: 10. From the Notes menu, choose Fil
Page 121: Accessing Notes Session Properties
Page 125 and 126: HiTest Functions Notes Class method
Page 127 and 128: Accessing Notes Sessions in LotusSc
Page 129 and 130: Chapter 7 Accessing Notes Databases
Page 131 and 132: We set the property of hgdatabase.
Page 133 and 134: HiTest Name LotusScript Notes Class
Page 135 and 136: All of the methods mentioned above
Page 137 and 138: REM view becomes a NotesView object
Page 139 and 140: We create a new database on a local
Page 141 and 142: Dim hgviewid As Long Dim hgview As
Page 143 and 144: Following is an explanation of the
Page 145 and 146: We declare a session, db and view w
Page 147 and 148: The HiTest Visual Basic API does no
Page 149 and 150: Chapter 9 Accessing Notes Documents
Page 153 and 154: We create and open a new document u
Page 155 and 156: HiTest Function Name Notes Classes
Page 157 and 158: Set doc = dc.GetFirstDocument(1247)
Page 159 and 160: NotesUIDocument = EditDocument([boo
Page 161 and 162: Set dc = db.AllDocuments Set doc =
Page 163 and 164: We enter text in the Subject, Categ
Page 165 and 166: Attachments Internally, Lotus Notes
Page 167 and 168: hgstatus = HTDocumentClose(hgdest_d
Page 169 and 170: Windows 3.1. For details on the OLE
Page 173 and 174:
Dim db As NotesDatabase Dim view As
Page 175 and 176:
Perform the following steps to crea
Page 177 and 178:
Tip You can select Display as icon
Page 179 and 180:
Creating a Linked Object 3. Choose
Page 181 and 182:
Creating an Embedded Object Using L
Page 183 and 184:
Messagebox msg$, boxType, "Successf
Page 185 and 186:
Embedding a New Object in a Documen
Page 187 and 188:
Note If you do not want to create t
Page 189 and 190:
answer% = Messagebox ("Object has b
Page 191 and 192:
16. Click Yes to confirm that you w
Page 193 and 194:
7. Select the Show twistie when row
Page 195 and 196:
Editing a Linked Object Note If you
Page 197 and 198:
Editing an Embedded or a Linked Obj
Page 199 and 200:
The object’s application is launc
Page 201 and 202:
Following is a description of the L
Page 203 and 204:
(10) Select Case object.Type Case E
Page 205 and 206:
This statement assigns object as a
Page 207 and 208:
HiTest Class Agent Attachment CDRec
Page 209 and 210:
HiTest Class Datetime Document HiTe
Page 211 and 212:
HiTest Class Item HiTest Functions
Page 213 and 214:
HiTest Class User View Viewcell HiT
Page 215 and 216:
other operating environments may va
Page 217 and 218:
How To Get ITSO Redbooks This secti
Page 219 and 220:
How Customers Can Get ITSO Redbooks
Page 221 and 222:
H handling errors, 95 hierarchical
show all

LotusScript for Visual Basic Programmers - IBM Redbooks

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?