Ignore:
Timestamp:
Jul 6, 2010, 8:09:10 AM (14 years ago)
Author:
Sam Habiel
Message:

Support for other encodings besides ASCII. Constructors available in BMXNetLib and and BMXNetConnectInfo.
Comments in several files.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • BMXNET_RPMS_dotNET_UTILITIES-BMX/trunk/cs/bmx_0200scr/BMX2/BMXNet/bmxnet.xml

    r818 r822  
    22<doc>
    33    <assembly>
    4         <name>BMXNet20</name>
     4        <name>BMXNet21</name>
    55    </assembly>
    66    <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>
    7213        <member name="P:IndianHealthService.BMXNet.RPMSDb.ResultSets">
    8214            <summary>
    … …  
    15221            </summary>
    16222        </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>
    17261        <member name="T:IndianHealthService.BMXNet.BMXNetConnectInfo">
    18262            <summary>
    19263            Contains methods and properties to support RPMS Login for .NET applications
    20264            </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>
    21278        </member>
    22279        <member name="M:IndianHealthService.BMXNet.BMXNetConnectInfo.SubscribeEvent(System.String)">
    … …  
    187444            </summary>
    188445        </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>
    417446    </members>
    418447</doc>
Note: See TracChangeset for help on using the changeset viewer.