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

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

Initial commit of C# Source Code. Now to try to get it to compile.

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