source: BMXNET_RPMS_dotNET_UTILITIES-BMX/branch/IHS BMX Framework/IndianHealthService.BMXNet.Doc/Help/html/780f3839-95cb-6b71-9d69-31e84c9041ec.htm@ 1146

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

Initial Import of BMX4
File size: 33.8 KB
Line 
1<html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"><head><META NAME="save" CONTENT="history" /><title>LoginProcess Class</title><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><link rel="stylesheet" type="text/css" href="ms-help://Dx/DxRuntime/DxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"> </script><script type="text/javascript" src="../scripts/SplitScreen.js"> </script><script type="text/javascript" src="../scripts/Dropdown.js"> </script><script type="text/javascript" src="../scripts/script_manifold.js"> </script><script type="text/javascript" src="../scripts/LanguageFilter.js"> </script><script type="text/javascript" src="../scripts/DataStore.js"> </script><script type="text/javascript" src="../scripts/CommonUtilities.js"> </script><script type="text/javascript" src="../scripts/MemberFilter.js"> </script><meta name="guid" content="780f3839-95cb-6b71-9d69-31e84c9041ec" /></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collall.gif" title="CollapseAll image" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expall.gif" title="ExpandAll image" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected.gif" title="DropDown image" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected_hover.gif" title="DropDownHover image" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /><img id="checkBoxSelectImage" style="display:none; height:0; width:0;" src="../icons/ch_selected.gif" /><img id="checkBoxUnSelectImage" style="display:none; height:0; width:0;" src="../icons/ch_unselected.gif" /><img id="checkBoxSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/ch_selected_hover.gif" /><img id="checkBoxUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/ch_unselected_hover.gif" /><img id="radioSelectImage" style="display:none; height:0; width:0;" src="../icons/r_select.gif" /><img id="radioUnSelectImage" style="display:none; height:0; width:0;" src="../icons/r_unselect.gif" /><img id="radioSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/r_select_hover.gif" /><img id="radioUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/r_unselect_hover.gif" /><img id="curvedLeftSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_lft_cnr.gif" /><img id="curvedRightSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_rt_cnr.gif" /><img id="curvedLeftUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_lft_cnr.gif" /><img id="curvedRightUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_rt_cnr.gif" /><img id="gradLeftSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_lft_grad.gif" /><img id="gradRightSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_rt_grad.gif" /><img id="gradLeftUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_lft_grad.gif" /><img id="gradRightUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_rt_grad.gif" /><img id="twirlSelectImage" style="display:none; height:0; width:0;" src="../icons/twirl_selected.gif" /><img id="twirlUnSelectImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected.gif" /><img id="twirlSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_selected_hover.gif" /><img id="twirlUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected_hover.gif" /><img id="NSRBottomImage" style="display:none; height:0; width:0;" src="../icons/NSRbottomgrad.gif" /><div id="header"><table id="topTable"><tr id="headerTableRow3"><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img ID="toggleAllImage" class="toggleAll" src="../icons/collall.gif" title="CollapseAll image" /><label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span> | <span id="languageFilterToolTip" style="cursor:default;" onmouseover="languageFilterImage.src=dropDownHoverImage.src;" onmouseout="languageFilterImage.src=dropDownImage.src;" tabindex="0"><img id="languageFilterImage" src="../icons/twirl_unselected.gif" title="DropDown image" /><label id="VisualBasicLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual Basic</label><label id="CSharpLabel" for="languageFilterImage" style="display: none;">Language Filter: C#</label><label id="ManagedCPlusPlusLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual C++</label><label id="JavaScriptLabel" for="languageFilterImage" style="display: none;">Language Filter: JavaScript</label></span><div id="languageSpan"><div id="VisualBasic" onclick="changeLanguage(data, 'VisualBasic', 'vb');"><img id="VisualBasicImage" onmouseover="mouseOverCheck(VisualBasicImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(VisualBasicImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> Visual Basic</div><br /><div id="CSharp" onclick="changeLanguage(data, 'CSharp', 'cs');"><img id="CSharpImage" onmouseover="mouseOverCheck(CSharpImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(CSharpImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> C#</div><br /><div id="ManagedCPlusPlus" onclick="changeLanguage(data, 'ManagedCPlusPlus', 'cpp');"><img id="ManagedCPlusPlusImage" onmouseover="mouseOverCheck(ManagedCPlusPlusImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(ManagedCPlusPlusImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> Visual C++</div><br /><div id="JavaScript" onclick="changeLanguage(data, 'JavaScript', 'cs');"><img id="JavaScriptImage" onmouseover="mouseOverCheck(JavaScriptImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(JavaScriptImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> JavaScript</div><br /></div> | <a href="#exampleToggle" onclick="OpenSection(exampleToggle)">Example</a> | <a href="#membersToggle" onclick="OpenSection(membersToggle)">Members</a> | <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a></td></tr><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">.NET Framework Class Library</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">LoginProcess Class</span></td></tr><tr><td class="nsrBottom" background="../icons/NSRbottomgrad.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()" /><div class="header"><font color="darkgray" /><p><font color="#a9a9a9">BMXNET 4.0 Developer API</font></p></div><div class="summary">
2 This class models the workflow of the LoginProcess. It correographs UI and non-UI
3 login methods, login cancelling, management dialogs, and provides hooks (events) to
4 customize the login workflow.
5 </div><p />
6 <b>Namespace:</b>
7  <a href="d9079e16-88e2-6ec8-dc63-50485499bb1a.htm">IndianHealthService.BMXNet.WinForm</a><br />
8 <b>Assembly:</b>
9  <span sdata="assembly">BMXWIN40</span> (in BMXWIN40.dll)<h1 class="heading"><span onclick="ExpandCollapse(syntaxToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(syntaxToggle, event)" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection" style=""><div id="syntaxCodeBlocks"><table class="filter" cellspacing="0" cellpadding="0"><tr id="curvedSyntaxTabs"><td class="leftTab" x-lang="CSharp"> </td><td class="middleTab" x-lang="CSharp"> </td><td class="rightTab" x-lang="CSharp"> </td><td class="leftTab" x-lang="VisualBasic"> </td><td class="middleTab" x-lang="VisualBasic"> </td><td class="rightTab" x-lang="VisualBasic"> </td><td class="leftTab" x-lang="ManagedCPlusPlus"> </td><td class="middleTab" x-lang="ManagedCPlusPlus"> </td><td class="rightTab" x-lang="ManagedCPlusPlus"> </td></tr><tr class="tabs" id="syntaxTabs"><td class="leftGrad" x-lang="CSharp"> </td><td class="tab" x-lang="CSharp" onclick="changeLanguage(data, 'CSharp', 'cs');">C#</td><td class="rightGrad" x-lang="CSharp"> </td><td class="leftGrad" x-lang="VisualBasic"> </td><td class="tab" x-lang="VisualBasic" onclick="changeLanguage(data, 'VisualBasic', 'vb');">Visual Basic</td><td class="rightGrad" x-lang="VisualBasic"> </td><td class="leftGrad" x-lang="ManagedCPlusPlus"> </td><td class="tab" x-lang="ManagedCPlusPlus" onclick="changeLanguage(data, 'ManagedCPlusPlus', 'cpp');">Visual C++</td><td class="rightGrad" x-lang="ManagedCPlusPlus"> </td></tr></table><div id="syntaxBlocks"><div class="code" x-lang="CSharp"><div id="CSharpDeclarationSection"><pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">LoginProcess</span></pre></div></div><div class="code" x-lang="VisualBasic"><div id="VisualBasicDeclarationSection"><pre><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">LoginProcess</span></pre></div></div><div class="code" x-lang="ManagedCPlusPlus"><div id="ManagedCPlusPlusDeclarationSection"><pre><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">LoginProcess</span></pre></div></div></div></div></div><h1 class="heading"><span onclick="ExpandCollapse(membersToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(membersToggle, event)" tabindex="0"><img id="membersToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Members</span></h1><div id="membersSection" class="section" name="collapseableSection" style=""><div id="allMemberSection"><table class="filter" cellspacing="0" cellpadding="0"><tr id="curvedMemberTabs"><td class="leftTab" value="all"> </td><td class="middleTab" value="all"> </td><td class="rightTab" value="all"> </td><td class="leftTab" value="property"> </td><td class="middleTab" value="property"> </td><td class="rightTab" value="property"> </td><td class="leftTab" value="method"> </td><td class="middleTab" value="method"> </td><td class="rightTab" value="method"> </td><td class="leftTab" value="event"> </td><td class="middleTab" value="event"> </td><td class="rightTab" value="event"> </td></tr><tr class="tabs" id="memberTabs"><td class="leftGrad" value="all"> </td><td class="tab" value="all" onclick="toggleClass('memberTabs','value','all','activeTab','tab'); curvedToggleClass('curvedMemberTabs', 'value', 'all'); processSubgroup('all','member'); process('memberList','filterElement','member');">All Members</td><td class="rightGrad" value="all"> </td><td class="leftGrad" value="property"> </td><td class="tab" value="property" onclick="toggleClass('memberTabs','value','property','activeTab','tab'); curvedToggleClass('curvedMemberTabs', 'value', 'property'); processSubgroup('property','member'); process('memberList','filterElement','member');">Properties <img src="../icons/pubproperty.gif" title="Public property" /></td><td class="rightGrad" value="property"> </td><td class="leftGrad" value="method"> </td><td class="tab" value="method" onclick="toggleClass('memberTabs','value','method','activeTab','tab'); curvedToggleClass('curvedMemberTabs', 'value', 'method'); processSubgroup('method','member'); process('memberList','filterElement','member');">Methods <img src="../icons/pubmethod.gif" title="Public method" /></td><td class="rightGrad" value="method"> </td><td class="leftGrad" value="event"> </td><td class="tab" value="event" onclick="toggleClass('memberTabs','value','event','activeTab','tab'); curvedToggleClass('curvedMemberTabs', 'value', 'event'); processSubgroup('event','member'); process('memberList','filterElement','member');">Events <img src="../icons/pubevent.gif" title="Public event" /></td><td class="rightGrad" value="event"> </td></tr></table><div class="memberSection"><table class="memberOptions"><tr><td class="line"><div id="public" onclick="var checked=toggleCheck(publicImage); toggleCheckState('public',checked); process('memberList','filterElement','member');"><img id="publicImage" onmouseover="mouseOverCheck(publicImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(publicImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Public</div><br /><div id="protected" onclick="var checked=toggleCheck(protectedImage); toggleCheckState('protected',checked); process('memberList','filterElement','member');"><img id="protectedImage" onmouseover="mouseOverCheck(protectedImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(protectedImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Protected</div></td><td class="line"><div id="instance" onclick="var checked=toggleCheck(instanceImage); toggleCheckState('instance',checked); process('memberList','filterElement','member');"><img id="instanceImage" onmouseover="mouseOverCheck(instanceImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(instanceImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Instance</div><br /><div id="static" onclick="var checked=toggleCheck(staticImage); toggleCheckState('static',checked); process('memberList','filterElement','member');"><img id="staticImage" onmouseover="mouseOverCheck(staticImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(staticImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Static <img src="../icons/static.gif" title="Static member" /></div></td><td class="line"><div id="declared" onclick="var checked=toggleCheck(declaredImage); toggleCheckState('declared',checked); process('memberList','filterElement','member');"><img id="declaredImage" onmouseover="mouseOverCheck(declaredImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(declaredImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Declared</div><br /><div id="inherited" onclick="var checked=toggleCheck(inheritedImage); toggleCheckState('inherited',checked); process('memberList','filterElement','member');"><img id="inheritedImage" onmouseover="mouseOverCheck(inheritedImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(inheritedImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> Inherited</div></td><td class="line"><div id="xna" onclick="var checked=toggleCheck(xnaImage); toggleCheckState('xna',checked); process('memberList','filterElement','member');"><img id="xnaImage" onmouseover="mouseOverCheck(xnaImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(xnaImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> XNA Framework Only <img src="../icons/xna.gif" title="Supported by the XNA Framework" /></div><br /><div id="compact" onclick="var checked=toggleCheck(compactImage); toggleCheckState('compact',checked); process('memberList','filterElement','member');"><img id="compactImage" onmouseover="mouseOverCheck(compactImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" onmouseout="mouseOutCheck(compactImage,checkBoxSelectImage,checkBoxUnSelectImage,checkBoxSelectHoverImage,checkBoxUnSelectHoverImage)" src="../icons/ch_selected.gif" /> .NET Compact Framework Only <img src="../icons/CFW.gif" title="Supported by the .NET Compact Framework" /></div></td><td class="line"><br /></td></tr></table><table class="members" id="memberList" cellspacing="0" frame="lhs"><tr><th class="iconColumn"> </th><th class="nameColumn">Member</th><th class="descriptionColumn">Description</th></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="47c8c5b5-1d95-4ed8-356f-8fcdaad6d207.htm">AttemptAccessVerifyLogin(RpmsConnectionSpec, String, String)</a></td><td><div class="summary">
10 Attempt a headless non-interactive UI login. This would be useful for an ASP.NET or NT-service type application
11 </div></td></tr><tr data="event; public; instance; declared; none; none"><td><img src="../icons/pubevent.gif" title="Public event" /></td><td><a href="29f0ed88-341f-2b16-de35-f1f90679e8ec.htm">AttemptingLogin</a></td><td><div class="summary">
12 Triggered before every login attempt. See <a href="95233203-75c0-8ba4-c234-fd7b3355da46.htm">AttemptingLoginEventArgs</a> for details .
13 </div></td></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="7bce220d-a840-0101-d9fc-7f78c937c179.htm">AttemptUserInputLogin(String, Int32, Boolean, IWin32Window)</a></td><td><div class="summary">
14 Attempt an interactive UI login. There are several useful arguments to control the process and appearance of the this process.
15 </div></td></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="63f80c3d-bcf4-531c-2489-4aa13c9f8084.htm">AttemptWindowsAuthLogin<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td><div class="summary">
16 Using the current default connection spec, attempt a WindowsAuthentication Login and answer true if it was successful.
17 </div></td></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="90cc25d9-0bff-06ee-6fed-d7635d9ed4e5.htm">AttemptWindowsAuthLogin(RpmsConnectionSpec)</a></td><td><div class="summary">
18 Attempt a WindowsAuthentication Login and answer true if it was successful.
19 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="38f150f9-4c85-75b2-e7ec-fa80372439ba.htm">AutoSetDivisionToLastLookup</a></td><td><div class="summary">
20 If set to True, RPMS is checked and if there was a previously set division for the user it will be used, otherwise
21 MustResolveDivision will be set to True and the division will need to be set for the user.
22 The default is True
23 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="d0d51c7e-4694-8948-a350-56c1eca7b775.htm">Cancel</a></td><td><div class="summary">
24 During a LoginAttempted the LoginProcess can be Cancelled by setting Cancel to True.
25 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="fd82b8a2-3b9c-ee8a-da5f-a6484c590351.htm">ConnectionSpec</a></td><td><div class="summary">
26 The active ConnectionSpec being used to login. With care, the property can be changed or the instance can be modified during the AttemptingLogin and LoginAttempted events
27 with care.
28 </div></td></tr><tr data="method; public; instance; inherited; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals(Object)</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="ffbb3326-a9bd-39a4-39fd-9e490a889a92.htm">FailureException</a></td><td><div class="summary">
29 If an exception occured during the last login attempt, FailureException will be set to it.
30 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="9b0b14d3-8972-78bc-5571-9da67a686305.htm">FailureMessage</a></td><td><div class="summary">
31 A reasonable message to display to the user if the last login attempt failed.
32 </div></td></tr><tr data="method; protected; instance; inherited; none; none"><td><img src="../icons/protmethod.gif" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="property; protected; instance; declared; none; none"><td><img src="../icons/protproperty.gif" title="Protected property" /></td><td><a href="13f06791-04a8-f44f-c659-cd40b08f2d07.htm">Framework</a></td><td /></tr><tr data="method; public; instance; inherited; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="method; public; instance; inherited; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="2d0c11c5-4747-201b-f138-d03dec8b4fb4.htm">HandleLoginAttemptedFailed<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td><div class="summary">
33 Will trigger the LoginAttempted event
34 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="570728ef-f3e5-8675-be58-04e5b88dcdd8.htm">HasDefaultConnectionWithUseWindowsAuth</a></td><td><div class="summary">
35 Answer True if there is a default managed connection that uses WindowsAuthenication
36 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="b423eaea-c610-3909-6d1f-3fcceea47bd2.htm">IsSwitchServerModeEnabled</a></td><td><div class="summary">
37 If set to True, the Connection combo box on the Login screen with be dropped down when the
38 dialog is displayed. This is useful for applications that have an option to change Connections.
39 The default is False.
40 </div></td></tr><tr data="event; public; instance; declared; none; none"><td><img src="../icons/pubevent.gif" title="Public event" /></td><td><a href="9973766b-535f-c26a-35c6-b75488396dd1.htm">LoginAttempted</a></td><td><div class="summary">
41 Triggered after every login attempt. See <a href="32781dfc-71f8-a357-9cae-ede2c1b83425.htm">LoginAttemptedEventArgs</a> for details .
42 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="3d505937-26f1-2bde-9d37-a63159504ea4.htm">LoginAttempts</a></td><td><div class="summary">
43 The number of login attempts so far. This value can be modified during the AttemptingLogin and LoginAttempted events.
44 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="5acd8ab3-6524-b10e-dee9-488438bba3aa.htm">MaxAttempts</a></td><td><div class="summary">
45 The number of login attempts before cancelling the LoginProcess. The default value is 3. This value can be modified during the AttemptingLogin and LoginAttempted events.
46 </div></td></tr><tr data="method; protected; instance; inherited; none; none"><td><img src="../icons/protmethod.gif" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="b3a237e9-2678-1812-28e0-25a33824fcb1.htm">MustResolveDivision</a></td><td><div class="summary">
47 If the division for the user has not been determine after the LoginProcess, MustResolveDivision will be set to True.
48 The default if False.
49 </div></td></tr><tr data="method; public; instance; declared; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="a5d71b3f-d6b5-c111-fe78-8d70c217d82d.htm">Succeeded<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td><div class="summary">
50 If the application is managing the actual login, send Succeeded() to indicate success.
51 </div></td></tr><tr data="method; public; instance; inherited; none; none"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="b0c6f96b-7d83-ab5d-cf2a-5cd571bdfd28.htm">WasLoginAttempted</a></td><td><div class="summary">
52 True if a login was attempted. False if the user is presented with a LoginDialog and "Cancel" is selected.
53 The value is changed during every login attempt cycle.
54 </div></td></tr><tr data="property; public; instance; declared; none; none"><td><img src="../icons/pubproperty.gif" title="Public property" /></td><td><a href="91a06004-957e-b0d9-d5bd-8b77f08bf56c.htm">WasSuccessful</a></td><td><div class="summary">
55 True if the most recent login attempt was successful.
56 </div></td></tr></table></div></div></div><h1 class="heading"><span onclick="ExpandCollapse(exampleToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(exampleToggle, event)" tabindex="0"><img id="exampleToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Examples</span></h1><div id="exampleSection" class="section" name="collapseableSection" style="">
57 See the SDK for other examples.
58 <div class="code"><table width="100%" cellspacing="0" cellpadding="0"><tr><th><span class="copyCode" onclick="CopyCode(this)" onkeypress="CopyCode_CheckKey(this, event)" onmouseover="ChangeCopyCodeIcon(this)" onmouseout="ChangeCopyCodeIcon(this)" tabindex="0"><img class="copyCodeImage" name="ccImage" align="absmiddle" title="Copy image" src="../icons/copycode.gif" />Copy Code</span></th></tr><tr><td colspan="2"><pre>
59 this.Framework = WinFramework.CreateWithNetworkBroker(true);
60 this.Framework.LoadSettings(LocalPersistentStore.CreateIn(Environment.SpecialFolder.LocalApplicationData, EntryAssemblyInfo.AssemblyCompany + "/" + EntryAssemblyInfo.AssemblyProduct, false), "settings");
61 this.Framework.LoadConnectionSpecs(LocalPersistentStore.CreateIn(Environment.SpecialFolder.LocalApplicationData, EntryAssemblyInfo.AssemblyCompany + "/" + EntryAssemblyInfo.AssemblyProduct, false), "connectiosn");
62 LoginProcess login = this.Framework.CreateLoginProcess();
63
64 //Attempt a non-UI WindowsAuth if and only if there is a default connection with WindowsAuth
65 //Of course, an application can set its own policy of when to AttemptWindowsAuthLogin()
66
67 if (login.HasDefaultConnectionWithUseWindowsAuth)
68 {
69 login.AttemptWindowsAuthLogin();
70 }
71
72 //If not attempted yet, i.e. skipped the AttemptWindowsAuthLogin(), or was unsuccessul, try and UI login
73 if (!login.WasLoginAttempted || !login.WasSuccessful)
74 {
75 login.AttemptUserInputLogin(IndianHealthService.BMXNet.Util.EntryAssemblyInfo.AssemblyTitle+" Login", 3,!this.Framework.BootStrapSettings.Get("lockedit",false), this);
76 }
77
78 //If the login process was unable to login after the max tries (or fow other configuration reasons), exit the application
79 if (!login.WasSuccessful)
80 {
81 this.Close();
82 return;
83 }
84
85 // Making sure that the user's division is set. Can use AttemptUserInputSetDivision() or the application can devise another solution
86 if ((this.Framework.User.Division == null) &amp;&amp; !this.Framework.AttemptUserInputSetDivision("Set Initial Division", this))
87 {
88 this.Close();
89 return;
90 }
91
92 // Logged in with valid user and division
93 this.RemoteSession = this.Framework.PrimaryRemoteSession;
94 </pre></td></tr></table></div></div><h1 class="heading"><span onclick="ExpandCollapse(familyToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(familyToggle, event)" tabindex="0"><img id="familyToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Inheritance Hierarchy</span></h1><div id="familySection" class="section" name="collapseableSection" style=""><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Object</a><br />  <span class="selflink">IndianHealthService.BMXNet.WinForm<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>LoginProcess</span><br /></div><h1 class="heading"><span onclick="ExpandCollapse(seeAlsoToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(seeAlsoToggle, event)" tabindex="0"><img id="seeAlsoToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />See Also</span></h1><div id="seeAlsoSection" class="section" name="collapseableSection" style=""><div class="seeAlsoStyle"><a href="d9079e16-88e2-6ec8-dc63-50485499bb1a.htm">IndianHealthService.BMXNet.WinForm Namespace</a></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" title="Footer image" /></div>
95 <p />
96 <span>
97 Send
98 <a href="javascript:sendfeedback('Documentation Feedback (Sandcastle CTP): ', 'LoginProcess Class', '');">
99
100 comments
101 </a>
102 about this topic to Microsoft.
103 </span>
104 </div></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.