source: BMXNET_RPMS_dotNET_UTILITIES-BMX/trunk/cs/bmx_0200scr/BMX2/BMXNet/bmxnet.xml@ 818

Last change on this file since 818 was 818, checked in by Sam Habiel, 14 years ago

Some profiling code in BMXNetLib.cs conditional on #DEBUG.
File size: 19.1 KB
Line 
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>BMXNet20</name>
5 </assembly>
6 <members>
7 <member name="P:IndianHealthService.BMXNet.RPMSDb.ResultSets">
8 <summary>
9 Returns the array of RMPSResultSets retrieved from RPMS
10 </summary>
11 </member>
12 <member name="P:IndianHealthService.BMXNet.RPMSDb.CurrentRecordSet">
13 <summary>
14 Sets and Returns the current recordset
15 </summary>
16 </member>
17 <member name="T:IndianHealthService.BMXNet.BMXNetConnectInfo">
18 <summary>
19 Contains methods and properties to support RPMS Login for .NET applications
20 </summary>
21 </member>
22 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.SubscribeEvent(System.String)">
23 <summary>
24 Register interest in an RPMS event.
25 </summary>
26 <param name="EventName"></param>
27 <returns></returns>
28 </member>
29 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.UnSubscribeEvent(System.String)">
30 <summary>
31 Unregister an RPMS event
32 </summary>
33 <param name="EventName"></param>
34 <returns></returns>
35 </member>
36 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.RaiseEvent(System.String,System.String,System.Boolean)">
37 <summary>
38 Raise an RPMS event
39 </summary>
40 <param name="EventName">The name of the event to raise</param>
41 <param name="Param">Parameters associated with the event</param>
42 <param name="RaiseBack">True if the event should be raised back to the caller</param>
43 <returns></returns>
44 </member>
45 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.Login">
46 <summary>
47 For backwards compatibility. Internally calls LoadConnectInfo()
48 </summary>
49 </member>
50 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.ChangeServerInfo">
51 <summary>
52 Change the internet address and port of the RPMS server
53 Throws a BMXNetException if user cancels
54 </summary>
55 </member>
56 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo">
57 <summary>
58 Called to connect to an M server
59 Server address, port, Access and Verify codes will be
60 prompted for depending on whether these values are
61 cached.
62 </summary>
63 </member>
64 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo(System.String,System.Int32)">
65 <summary>
66 Called to connect to the M server specified by
67 server address and listener port. The default namespace on the server will be used.
68 Access and Verify codes will be prompted if
69 valid values for the current Windows Identity are
70 not cached on the server.
71 </summary>
72 <param name="MServerAddress">The IP address or name of the MServer</param>
73 <param name="Port">The port on which the BMXNet Monitor is listening</param>
74 </member>
75 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo(System.String,System.Int32,System.String)">
76 <summary>
77 Called to connect to the M server specified by
78 server address, listener port and namespace.
79 Access and Verify codes will be prompted if
80 valid values for the current Windows Identity are
81 not cached on the server.
82 </summary>
83 <param name="MServerAddress">The IP address or name of the MServer</param>
84 <param name="Port">The port on which the BMXNet Monitor is listening</param>
85 <param name="Namespace">The namespace in which the BMXNet application will run</param>
86 </member>
87 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo(System.String,System.String)">
88 <summary>
89 Called to connect to an M server
90 using specific Access and Verify codes.
91 Server address and port will be prompted if they
92 are not cached in local storage.
93 </summary>
94 <param name="AccessCode">The user's access code</param>
95 <param name="VerifyCode">The user's verify code</param>
96 </member>
97 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo(System.String,System.Int32,System.String,System.String)">
98 <summary>
99 Called to connect to a specific M server
100 using specific Access and Verify codes.
101 </summary>
102 <param name="AccessCode">The user's access code</param>
103 <param name="VerifyCode">The user's verify code</param>
104 <param name="MServerAddress">The IP address or name of the MServer</param>
105 <param name="Port">The port on which the BMXNet Monitor is listening</param>
106 </member>
107 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.LoadConnectInfo(System.String,System.Int32,System.String,System.String,System.String)">
108 <summary>
109 Called to connect to a specific namespace on the M server
110 using specific Access and Verify codes.
111 </summary>
112 <param name="AccessCode">The user's access code</param>
113 <param name="VerifyCode">The user's verify code</param>
114 <param name="MServerAddress">The IP address or name of the MServer</param>
115 <param name="Port">The port on which the BMXNet Monitor is listening</param>
116 <param name="Namespace">The namespace in which the BMXNet application will run</param>
117 </member>
118 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.RPMSDataTable(System.String,System.String)">
119 <summary>
120 Creates and names a DataTable using the command in CommandString
121 and the name in TableName.
122 </summary>
123 <param name="CommandString"> The SQL or RPC call</param>
124 <param name="TableName">The name of the resulting table</param>
125 <returns>
126 Returns the resulting DataTable.
127 </returns>
128 </member>
129 <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.RPMSDataTable(System.String,System.String,System.Data.DataSet)">
130 <summary>
131 Creates and names a DataTable using the command in CommandString
132 and the name in TableName then adds it to DataSet.
133 </summary>
134 <param name="CommandString">The SQL or RPC call</param>
135 <param name="TableName">The name of the resulting table</param>
136 <param name="dsDataSet">The dataset in which to place the table</param>
137 <returns>
138 Returns the resulting DataTable.
139 </returns>
140 </member>
141 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.EventPollingEnabled">
142 <summary>
143 Enables and disables event polling for the RPMS connection
144 </summary>
145 </member>
146 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.EventPollingInterval">
147 <summary>
148 Sets and retrieves the interval in milliseconds for RPMS event polling
149 </summary>
150 </member>
151 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.AutoFire">
152 <summary>
153 Sets and retrieves the number of times that the Event Timer will generage a BMXNet AutoFire event.
154 For example, if AutoFire == 3, then every 3rd time the Event Timer fires, it will generate an AutoFire event.
155 </summary>
156 </member>
157 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.ReceiveTimeout">
158 <summary>
159 Set and retrieve the timeout, in milliseconds, to receive a response from the RPMS server.
160 If the retrieve time exceeds the timeout, an exception will be thrown and the connection will be closed.
161 The default is 30 seconds.
162 </summary>
163 </member>
164 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.DUZ">
165 <summary>
166 Returns a string representation of DUZ
167 </summary>
168 </member>
169 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.DUZ2">
170 <summary>
171 Sets and Returns DUZ(2)
172 </summary>
173 </member>
174 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.MServerAddress">
175 <summary>
176 Gets the address of the RPMS Server
177 </summary>
178 </member>
179 <member name="P:IndianHealthService.BMXNet.BMXNetConnectInfo.MServerPort">
180 <summary>
181 Gets the port on which the MServer is connected
182 </summary>
183 </member>
184 <member name="T:IndianHealthService.BMXNet.BMXNetConnectInfo.ServerData">
185 <summary>
186 Serializes RPMS server address and port
187 </summary>
188 </member>
189 <member name="T:IndianHealthService.BMXNet.DServerInfo">
190 <summary>
191 Prompts for RPMS Server address and port
192 Obtains current values, if any, from isolated storage
193 and uses them as defaults.
194 If OK, then writes values to isolated storage and returns
195 Address and Port as properties.
196
197 </summary>
198 </member>
199 <member name="F:IndianHealthService.BMXNet.DServerInfo.components">
200 <summary>
201 Required designer variable.
202 </summary>
203 </member>
204 <member name="M:IndianHealthService.BMXNet.DServerInfo.Dispose(System.Boolean)">
205 <summary>
206 Clean up any resources being used.
207 </summary>
208 </member>
209 <member name="M:IndianHealthService.BMXNet.DServerInfo.InitializeComponent">
210 <summary>
211 Required method for Designer support - do not modify
212 the contents of this method with the code editor.
213 </summary>
214 </member>
215 <member name="M:IndianHealthService.BMXNet.DServerInfo.UpdateDialogData(System.Boolean)">
216 <summary>
217 If b is true, moves member vars into control data
218 otherwise, moves control data into member vars
219 </summary>
220 <param name="b"></param>
221 </member>
222 <member name="P:IndianHealthService.BMXNet.DServerInfo.MServerAddress">
223 <summary>
224 Gets/sets the internet address of the RPMS Server
225 </summary>
226 </member>
227 <member name="P:IndianHealthService.BMXNet.DServerInfo.MServerNamespace">
228 <summary>
229 Gets/sets the namespace of the RPMS Server
230 </summary>
231 </member>
232 <member name="P:IndianHealthService.BMXNet.DServerInfo.MServerPort">
233 <summary>
234 Gets/sets the TCP/IP Port of the RPMS Server
235 </summary>
236 </member>
237 <member name="T:IndianHealthService.BMXNet.DSelectDivision">
238 <summary>
239 Summary description for DSelectDivision.
240 </summary>
241 </member>
242 <member name="M:IndianHealthService.BMXNet.DSelectDivision.InitializeComponent">
243 <summary>
244 Required method for Designer support - do not modify
245 the contents of this method with the code editor.
246 </summary>
247 </member>
248 <member name="M:IndianHealthService.BMXNet.DSelectDivision.UpdateDialogData(System.Boolean)">
249 <summary>
250 If b is true, moves member vars into control data
251 otherwise, moves control data into member vars
252 </summary>
253 <param name="b"></param>
254 </member>
255 <member name="M:IndianHealthService.BMXNet.DSelectDivision.Dispose(System.Boolean)">
256 <summary>
257 Clean up any resources being used.
258 </summary>
259 </member>
260 <member name="T:IndianHealthService.BMXNet.BMXNetLib">
261 <summary>
262 BMXNetLib implements low-level socket connectivity to RPMS databases.
263 The VA RPC Broker must be running on the RPMS server in order for
264 BMXNetLib to connect.
265 </summary>
266 </member>
267 <member name="M:IndianHealthService.BMXNet.BMXNetLib.PieceLength(System.String,System.String)">
268 <summary>
269 Corresponds to M's $L(STRING,DELIMITER)
270 </summary>
271 <param name="sInput"></param>
272 <param name="sDelim"></param>
273 <returns></returns>
274 </member>
275 <member name="M:IndianHealthService.BMXNet.BMXNetLib.Piece(System.String,System.String,System.Int32)">
276 <summary>
277 Corresponds to M's $$Piece function
278 </summary>
279 <param name="sInput"></param>
280 <param name="sDelim"></param>
281 <param name="nNumber"></param>
282 <returns></returns>
283 </member>
284 <member name="M:IndianHealthService.BMXNet.BMXNetLib.ADEBLDPadString(System.String)">
285 <summary>
286 Given strInput = "13" builds "013" if nLength = 3. Default for nLength is 3.
287 </summary>
288 <param name="strInput"></param>
289 <returns></returns>
290 </member>
291 <member name="M:IndianHealthService.BMXNet.BMXNetLib.ADEBLDPadString(System.String,System.Int32)">
292 <summary>
293 Given strInput = "13" builds "013" if nLength = 3 Default for nLength is 3.
294 </summary>
295 <param name="strInput"></param>
296 <param name="nLength">Default = 3</param>
297 <returns></returns>
298 </member>
299 <member name="M:IndianHealthService.BMXNet.BMXNetLib.ADEBLDB(System.String)">
300 <summary>
301 Concatenates zero-padded length of sInput to sInput
302 Given "Hello" returns "004Hello"
303 If nSize = 5, returns "00004Hello"
304 Default for nSize is 3.
305 </summary>
306 <param name="sInput"></param>
307 <returns></returns>
308 </member>
309 <member name="M:IndianHealthService.BMXNet.BMXNetLib.ADEBLDB(System.String,System.Int32)">
310 <summary>
311 Concatenates zero-padded length of sInput to sInput
312 Given "Hello" returns "004Hello"
313 If nSize = 5, returns "00004Hello"
314 Default for nSize is 3.
315 </summary>
316 <param name="sInput"></param>
317 <param name="nSize"></param>
318 <returns></returns>
319 </member>
320 <member name="M:IndianHealthService.BMXNet.BMXNetLib.ADEBHDR(System.String,System.String,System.String,System.String)">
321 <summary>
322 Build protocol header
323 </summary>
324 <param name="sWKID"></param>
325 <param name="sWINH"></param>
326 <param name="sPRCH"></param>
327 <param name="sWISH"></param>
328 <returns></returns>
329 </member>
330 <member name="M:IndianHealthService.BMXNet.BMXNetLib.FindSubString(System.String,System.String)">
331 <summary>
332 Returns index of first instance of sSubString in sString.
333 If sSubString not found, returns -1.
334 </summary>
335 <param name="sString"></param>
336 <param name="sSubString"></param>
337 <returns></returns>
338 </member>
339 <member name="M:IndianHealthService.BMXNet.BMXNetLib.Lock(System.String,System.String,System.String)">
340 <summary>
341 Lock a local or global M variable
342 Returns true if lock is obtained during TimeOut seconds
343 Use + to increment, - to decrement lock.
344 </summary>
345 <param name="Variable"></param>
346 <param name="Increment"></param>
347 <param name="TimeOut"></param>
348 <returns></returns>
349 </member>
350 <member name="P:IndianHealthService.BMXNet.BMXNetLib.BMXRWL">
351 <summary>
352 Returns a reference to the internal ReaderWriterLock member.
353 </summary>
354 </member>
355 <member name="P:IndianHealthService.BMXNet.BMXNetLib.RWLTimeout">
356 <summary>
357 Sets and returns the timeout in milliseconds for locking the transmit port.
358 If the transmit port is unavailable an ApplicationException will be thrown.
359 </summary>
360 </member>
361 <member name="P:IndianHealthService.BMXNet.BMXNetLib.ReceiveTimeout">
362 <summary>
363 Set and retrieve the timeout, in milliseconds, to receive a response from the RPMS server.
364 If the retrieve time exceeds the timeout, an exception will be thrown and the connection will be closed.
365 The default is 30 seconds.
366 </summary>
367 </member>
368 <member name="P:IndianHealthService.BMXNet.BMXNetLib.AppContext">
369 <summary>
370 Gets/sets the Kernel Application context
371 Throws an exception if unable to set the context.
372 </summary>
373 </member>
374 <member name="T:IndianHealthService.BMXNet.DLoginInfo">
375 <summary>
376 Summary description for DLoginInfo.
377 </summary>
378 </member>
379 <member name="F:IndianHealthService.BMXNet.DLoginInfo.components">
380 <summary>
381 Required designer variable.
382 </summary>
383 </member>
384 <member name="M:IndianHealthService.BMXNet.DLoginInfo.InitializeComponent">
385 <summary>
386 Required method for Designer support - do not modify
387 the contents of this method with the code editor.
388 </summary>
389 </member>
390 <member name="M:IndianHealthService.BMXNet.DLoginInfo.Dispose(System.Boolean)">
391 <summary>
392 Clean up any resources being used.
393 </summary>
394 </member>
395 <member name="M:IndianHealthService.BMXNet.DLoginInfo.UpdateDialogData(System.Boolean)">
396 <summary>
397 If b is true, moves member vars into control data
398 otherwise, moves control data into member vars
399 </summary>
400 <param name="b"></param>
401 </member>
402 <member name="P:IndianHealthService.BMXNet.DLoginInfo.AccessCode">
403 <summary>
404 Gets the access code entered by the user.
405 </summary>
406 </member>
407 <member name="P:IndianHealthService.BMXNet.DLoginInfo.VerifyCode">
408 <summary>
409 Gets the verify code entered by the user.
410 </summary>
411 </member>
412 <member name="T:IndianHealthService.BMXNet.BMXNetException">
413 <summary>
414 Custom exception class for BMXNet
415 </summary>
416 </member>
417 </members>
418</doc>
Note: See TracBrowser for help on using the repository browser.