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

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

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