source: BMXNET_RPMS_dotNET_UTILITIES-BMX/trunk/cs/bmx_0200scr/BMX2/BMXNet/bin/Release/bmxnet.xml@ 822

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

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