System.Security.Principal.Windows.xml 86 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Security.Principal.Windows</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle">
  8. <summary>Provides a safe handle to a Windows thread or process access token. For more information, see Access Tokens.</summary>
  9. </member>
  10. <member name="M:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle.#ctor(System.IntPtr)">
  11. <summary>Initializes a new instance of the <see cref="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle" /> class.</summary>
  12. <param name="handle">An <see cref="T:System.IntPtr" /> object that represents the pre-existing handle to use. Using <see cref="F:System.IntPtr.Zero" /> returns an invalid handle.</param>
  13. </member>
  14. <member name="P:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle.InvalidHandle">
  15. <summary>Returns an invalid handle by instantiating a <see cref="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle" /> object with <see cref="F:System.IntPtr.Zero" />.</summary>
  16. <returns>Returns a <see cref="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle" /> object.</returns>
  17. </member>
  18. <member name="P:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle.IsInvalid">
  19. <summary>Gets a value that indicates whether the handle is invalid.</summary>
  20. <returns>
  21. <see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</returns>
  22. </member>
  23. <member name="T:System.Security.Principal.IdentityNotMappedException">
  24. <summary>Represents an exception for a principal whose identity could not be mapped to a known identity.</summary>
  25. </member>
  26. <member name="M:System.Security.Principal.IdentityNotMappedException.#ctor">
  27. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.IdentityNotMappedException" /> class.</summary>
  28. </member>
  29. <member name="M:System.Security.Principal.IdentityNotMappedException.#ctor(System.String)">
  30. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.IdentityNotMappedException" /> class by using the specified error message.</summary>
  31. <param name="message">The error message that explains the reason for the exception.</param>
  32. </member>
  33. <member name="M:System.Security.Principal.IdentityNotMappedException.#ctor(System.String,System.Exception)">
  34. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.IdentityNotMappedException" /> class by using the specified error message and inner exception.</summary>
  35. <param name="message">The error message that explains the reason for the exception.</param>
  36. <param name="inner">The exception that is the cause of the current exception. If <paramref name="inner" /> is not null, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>
  37. </member>
  38. <member name="M:System.Security.Principal.IdentityNotMappedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  39. <summary>Gets serialization information with the data needed to create an instance of this <see cref="T:System.Security.Principal.IdentityNotMappedException" /> object.</summary>
  40. <param name="serializationInfo">The object that holds the serialized object data about the exception being thrown.</param>
  41. <param name="streamingContext">The object that contains contextual information about the source or destination.</param>
  42. </member>
  43. <member name="P:System.Security.Principal.IdentityNotMappedException.UnmappedIdentities">
  44. <summary>Represents the collection of unmapped identities for an <see cref="T:System.Security.Principal.IdentityNotMappedException" /> exception.</summary>
  45. <returns>The collection of unmapped identities.</returns>
  46. </member>
  47. <member name="T:System.Security.Principal.IdentityReference">
  48. <summary>Represents an identity and is the base class for the <see cref="T:System.Security.Principal.NTAccount" /> and <see cref="T:System.Security.Principal.SecurityIdentifier" /> classes. This class does not provide a public constructor, and therefore cannot be inherited.</summary>
  49. </member>
  50. <member name="M:System.Security.Principal.IdentityReference.Equals(System.Object)">
  51. <summary>Returns a value that indicates whether the specified object equals this instance of the <see cref="T:System.Security.Principal.IdentityReference" /> class.</summary>
  52. <param name="o">An object to compare with this <see cref="T:System.Security.Principal.IdentityReference" /> instance, or a null reference.</param>
  53. <returns>
  54. <see langword="true" /> if <paramref name="o" /> is an object with the same underlying type and value as this <see cref="T:System.Security.Principal.IdentityReference" /> instance; otherwise, <see langword="false" />.</returns>
  55. </member>
  56. <member name="M:System.Security.Principal.IdentityReference.GetHashCode">
  57. <summary>Serves as a hash function for <see cref="T:System.Security.Principal.IdentityReference" />. <see cref="M:System.Security.Principal.IdentityReference.GetHashCode" /> is suitable for use in hashing algorithms and data structures like a hash table.</summary>
  58. <returns>The hash code for this <see cref="T:System.Security.Principal.IdentityReference" /> object.</returns>
  59. </member>
  60. <member name="M:System.Security.Principal.IdentityReference.IsValidTargetType(System.Type)">
  61. <summary>Returns a value that indicates whether the specified type is a valid translation type for the <see cref="T:System.Security.Principal.IdentityReference" /> class.</summary>
  62. <param name="targetType">The type being queried for validity to serve as a conversion from <see cref="T:System.Security.Principal.IdentityReference" />. The following target types are valid:
  63. <see cref="T:System.Security.Principal.NTAccount" /><see cref="T:System.Security.Principal.SecurityIdentifier" /></param>
  64. <returns>
  65. <see langword="true" /> if <paramref name="targetType" /> is a valid translation type for the <see cref="T:System.Security.Principal.IdentityReference" /> class; otherwise, <see langword="false" />.</returns>
  66. </member>
  67. <member name="M:System.Security.Principal.IdentityReference.op_Equality(System.Security.Principal.IdentityReference,System.Security.Principal.IdentityReference)">
  68. <summary>Compares two <see cref="T:System.Security.Principal.IdentityReference" /> objects to determine whether they are equal. They are considered equal if they have the same canonical name representation as the one returned by the <see cref="P:System.Security.Principal.IdentityReference.Value" /> property or if they are both <see langword="null" />.</summary>
  69. <param name="left">The left <see cref="T:System.Security.Principal.IdentityReference" /> operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  70. <param name="right">The right <see cref="T:System.Security.Principal.IdentityReference" /> operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  71. <returns>
  72. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
  73. </member>
  74. <member name="M:System.Security.Principal.IdentityReference.op_Inequality(System.Security.Principal.IdentityReference,System.Security.Principal.IdentityReference)">
  75. <summary>Compares two <see cref="T:System.Security.Principal.IdentityReference" /> objects to determine whether they are not equal. They are considered not equal if they have different canonical name representations than the one returned by the <see cref="P:System.Security.Principal.IdentityReference.Value" /> property or if one of the objects is <see langword="null" /> and the other is not.</summary>
  76. <param name="left">The left <see cref="T:System.Security.Principal.IdentityReference" /> operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  77. <param name="right">The right <see cref="T:System.Security.Principal.IdentityReference" /> operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  78. <returns>
  79. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
  80. </member>
  81. <member name="M:System.Security.Principal.IdentityReference.ToString">
  82. <summary>Returns the string representation of the identity represented by the <see cref="T:System.Security.Principal.IdentityReference" /> object.</summary>
  83. <returns>The identity in string format.</returns>
  84. </member>
  85. <member name="M:System.Security.Principal.IdentityReference.Translate(System.Type)">
  86. <summary>Translates the account name represented by the <see cref="T:System.Security.Principal.IdentityReference" /> object into another <see cref="T:System.Security.Principal.IdentityReference" />-derived type.</summary>
  87. <param name="targetType">The target type for the conversion from <see cref="T:System.Security.Principal.IdentityReference" />.</param>
  88. <returns>The converted identity.</returns>
  89. </member>
  90. <member name="P:System.Security.Principal.IdentityReference.Value">
  91. <summary>Gets the string value of the identity represented by the <see cref="T:System.Security.Principal.IdentityReference" /> object.</summary>
  92. <returns>The string value of the identity represented by the <see cref="T:System.Security.Principal.IdentityReference" /> object.</returns>
  93. </member>
  94. <member name="T:System.Security.Principal.IdentityReferenceCollection">
  95. <summary>Represents a collection of <see cref="T:System.Security.Principal.IdentityReference" /> objects and provides a means of converting sets of <see cref="T:System.Security.Principal.IdentityReference" />-derived objects to <see cref="T:System.Security.Principal.IdentityReference" />-derived types.</summary>
  96. </member>
  97. <member name="M:System.Security.Principal.IdentityReferenceCollection.#ctor">
  98. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> class with zero items in the collection.</summary>
  99. </member>
  100. <member name="M:System.Security.Principal.IdentityReferenceCollection.#ctor(System.Int32)">
  101. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> class by using the specified initial size.</summary>
  102. <param name="capacity">The initial number of items in the collection. The value of <paramref name="capacity" /> is a hint only; it is not necessarily the maximum number of items created.</param>
  103. </member>
  104. <member name="M:System.Security.Principal.IdentityReferenceCollection.Add(System.Security.Principal.IdentityReference)">
  105. <summary>Adds an <see cref="T:System.Security.Principal.IdentityReference" /> object to the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  106. <param name="identity">The <see cref="T:System.Security.Principal.IdentityReference" /> object to add to the collection.</param>
  107. <exception cref="T:System.ArgumentNullException">
  108. <paramref name="identity" /> is <see langword="null" />.</exception>
  109. </member>
  110. <member name="M:System.Security.Principal.IdentityReferenceCollection.Clear">
  111. <summary>Clears all <see cref="T:System.Security.Principal.IdentityReference" /> objects from the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  112. </member>
  113. <member name="M:System.Security.Principal.IdentityReferenceCollection.Contains(System.Security.Principal.IdentityReference)">
  114. <summary>Indicates whether the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection contains the specified <see cref="T:System.Security.Principal.IdentityReference" /> object.</summary>
  115. <param name="identity">The <see cref="T:System.Security.Principal.IdentityReference" /> object to check for.</param>
  116. <returns>
  117. <see langword="true" /> if the collection contains the specified object.</returns>
  118. <exception cref="T:System.ArgumentNullException">
  119. <paramref name="identity" /> is <see langword="null" />.</exception>
  120. </member>
  121. <member name="M:System.Security.Principal.IdentityReferenceCollection.CopyTo(System.Security.Principal.IdentityReference[],System.Int32)">
  122. <summary>Copies the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection to an <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> array, starting at the specified index.</summary>
  123. <param name="array">An <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> array object to which the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection is to be copied.</param>
  124. <param name="offset">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection is to be copied.</param>
  125. </member>
  126. <member name="P:System.Security.Principal.IdentityReferenceCollection.Count">
  127. <summary>Gets the number of items in the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  128. <returns>The number of <see cref="T:System.Security.Principal.IdentityReference" /> objects in the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</returns>
  129. </member>
  130. <member name="M:System.Security.Principal.IdentityReferenceCollection.GetEnumerator">
  131. <summary>Gets an enumerator that can be used to iterate through the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  132. <returns>An enumerator for the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</returns>
  133. </member>
  134. <member name="P:System.Security.Principal.IdentityReferenceCollection.Item(System.Int32)">
  135. <summary>Sets or gets the node at the specified index of the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  136. <param name="index">The zero-based index in the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</param>
  137. <returns>The <see cref="T:System.Security.Principal.IdentityReference" /> at the specified index in the collection. If <paramref name="index" /> is greater than or equal to the number of nodes in the collection, the return value is <see langword="null" />.</returns>
  138. </member>
  139. <member name="M:System.Security.Principal.IdentityReferenceCollection.Remove(System.Security.Principal.IdentityReference)">
  140. <summary>Removes the specified <see cref="T:System.Security.Principal.IdentityReference" /> object from the collection.</summary>
  141. <param name="identity">The <see cref="T:System.Security.Principal.IdentityReference" /> object to remove.</param>
  142. <returns>
  143. <see langword="true" /> if the specified object was removed from the collection.</returns>
  144. <exception cref="T:System.ArgumentNullException">
  145. <paramref name="identity" /> is <see langword="null" />.</exception>
  146. </member>
  147. <member name="P:System.Security.Principal.IdentityReferenceCollection.System#Collections#Generic#ICollection{System#Security#Principal#IdentityReference}#IsReadOnly" />
  148. <member name="M:System.Security.Principal.IdentityReferenceCollection.System#Collections#IEnumerable#GetEnumerator">
  149. <summary>Gets an enumerator that can be used to iterate through the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
  150. <returns>An enumerator for the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</returns>
  151. </member>
  152. <member name="M:System.Security.Principal.IdentityReferenceCollection.Translate(System.Type)">
  153. <summary>Converts the objects in the collection to the specified type. Calling this method is the same as calling <see cref="M:System.Security.Principal.IdentityReferenceCollection.Translate(System.Type,System.Boolean)" /> with the second parameter set to <see langword="false" />, which means that exceptions will not be thrown for items that fail conversion.</summary>
  154. <param name="targetType">The type to which items in the collection are being converted.</param>
  155. <returns>A <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection that represents the converted contents of the original collection.</returns>
  156. </member>
  157. <member name="M:System.Security.Principal.IdentityReferenceCollection.Translate(System.Type,System.Boolean)">
  158. <summary>Converts the objects in the collection to the specified type and uses the specified fault tolerance to handle or ignore errors associated with a type not having a conversion mapping.</summary>
  159. <param name="targetType">The type to which items in the collection are being converted.</param>
  160. <param name="forceSuccess">A Boolean value that determines how conversion errors are handled.
  161. If <paramref name="forceSuccess" /> is <see langword="true" />, conversion errors due to a mapping not being found for the translation result in a failed conversion and exceptions being thrown.
  162. If <paramref name="forceSuccess" /> is <see langword="false" />, types that failed to convert due to a mapping not being found for the translation are copied without being converted into the collection being returned.</param>
  163. <returns>A <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection that represents the converted contents of the original collection.</returns>
  164. </member>
  165. <member name="T:System.Security.Principal.NTAccount">
  166. <summary>Represents a user or group account.</summary>
  167. </member>
  168. <member name="M:System.Security.Principal.NTAccount.#ctor(System.String)">
  169. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.NTAccount" /> class by using the specified name.</summary>
  170. <param name="name">The name used to create the <see cref="T:System.Security.Principal.NTAccount" /> object. This parameter cannot be <see langword="null" /> or an empty string.</param>
  171. <exception cref="T:System.ArgumentNullException">
  172. <paramref name="name" /> is <see langword="null" />.</exception>
  173. <exception cref="T:System.ArgumentException">
  174. <paramref name="name" /> is an empty string.
  175. -or-
  176. <paramref name="name" /> is too long.</exception>
  177. </member>
  178. <member name="M:System.Security.Principal.NTAccount.#ctor(System.String,System.String)">
  179. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.NTAccount" /> class by using the specified domain name and account name.</summary>
  180. <param name="domainName">The name of the domain. This parameter can be <see langword="null" /> or an empty string. Domain names that are null values are treated like an empty string.</param>
  181. <param name="accountName">The name of the account. This parameter cannot be <see langword="null" /> or an empty string.</param>
  182. <exception cref="T:System.ArgumentNullException">
  183. <paramref name="accountName" /> is <see langword="null" />.</exception>
  184. <exception cref="T:System.ArgumentException">
  185. <paramref name="accountName" /> is an empty string.
  186. -or-
  187. <paramref name="accountName" /> is too long.
  188. -or-
  189. <paramref name="domainName" /> is too long.</exception>
  190. </member>
  191. <member name="M:System.Security.Principal.NTAccount.Equals(System.Object)">
  192. <summary>Returns a value that indicates whether this <see cref="T:System.Security.Principal.NTAccount" /> object is equal to a specified object.</summary>
  193. <param name="o">An object to compare with this <see cref="T:System.Security.Principal.NTAccount" /> object, or <see langword="null" />.</param>
  194. <returns>
  195. <see langword="true" /> if <paramref name="o" /> is an object with the same underlying type and value as this <see cref="T:System.Security.Principal.NTAccount" /> object; otherwise, <see langword="false" />.</returns>
  196. </member>
  197. <member name="M:System.Security.Principal.NTAccount.GetHashCode">
  198. <summary>Serves as a hash function for the current <see cref="T:System.Security.Principal.NTAccount" /> object. The <see cref="M:System.Security.Principal.NTAccount.GetHashCode" /> method is suitable for hashing algorithms and data structures like a hash table.</summary>
  199. <returns>A hash value for the current <see cref="T:System.Security.Principal.NTAccount" /> object.</returns>
  200. </member>
  201. <member name="M:System.Security.Principal.NTAccount.IsValidTargetType(System.Type)">
  202. <summary>Returns a value that indicates whether the specified type is a valid translation type for the <see cref="T:System.Security.Principal.NTAccount" /> class.</summary>
  203. <param name="targetType">The type being queried for validity to serve as a conversion from <see cref="T:System.Security.Principal.NTAccount" />. The following target types are valid:
  204. - <see cref="T:System.Security.Principal.NTAccount" />
  205. - <see cref="T:System.Security.Principal.SecurityIdentifier" /></param>
  206. <returns>
  207. <see langword="true" /> if <paramref name="targetType" /> is a valid translation type for the <see cref="T:System.Security.Principal.NTAccount" /> class; otherwise <see langword="false" />.</returns>
  208. </member>
  209. <member name="M:System.Security.Principal.NTAccount.op_Equality(System.Security.Principal.NTAccount,System.Security.Principal.NTAccount)">
  210. <summary>Compares two <see cref="T:System.Security.Principal.NTAccount" /> objects to determine whether they are equal. They are considered equal if they have the same canonical name representation as the one returned by the <see cref="P:System.Security.Principal.NTAccount.Value" /> property or if they are both <see langword="null" />.</summary>
  211. <param name="left">The left operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  212. <param name="right">The right operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  213. <returns>
  214. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise <see langword="false" />.</returns>
  215. </member>
  216. <member name="M:System.Security.Principal.NTAccount.op_Inequality(System.Security.Principal.NTAccount,System.Security.Principal.NTAccount)">
  217. <summary>Compares two <see cref="T:System.Security.Principal.NTAccount" /> objects to determine whether they are not equal. They are considered not equal if they have different canonical name representations than the one returned by the <see cref="P:System.Security.Principal.NTAccount.Value" /> property or if one of the objects is <see langword="null" /> and the other is not.</summary>
  218. <param name="left">The left operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  219. <param name="right">The right operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  220. <returns>
  221. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise <see langword="false" />.</returns>
  222. </member>
  223. <member name="M:System.Security.Principal.NTAccount.ToString">
  224. <summary>Returns the account name, in Domain \ Account format, for the account represented by the <see cref="T:System.Security.Principal.NTAccount" /> object.</summary>
  225. <returns>The account name, in Domain \ Account format.</returns>
  226. </member>
  227. <member name="M:System.Security.Principal.NTAccount.Translate(System.Type)">
  228. <summary>Translates the account name represented by the <see cref="T:System.Security.Principal.NTAccount" /> object into another <see cref="T:System.Security.Principal.IdentityReference" />-derived type.</summary>
  229. <param name="targetType">The target type for the conversion from <see cref="T:System.Security.Principal.NTAccount" />. The target type must be a type that is considered valid by the <see cref="M:System.Security.Principal.NTAccount.IsValidTargetType(System.Type)" /> method.</param>
  230. <returns>The converted identity.</returns>
  231. <exception cref="T:System.ArgumentNullException">
  232. <paramref name="targetType" /> is <see langword="null" />.</exception>
  233. <exception cref="T:System.ArgumentException">
  234. <paramref name="targetType" /> is not an <see cref="T:System.Security.Principal.IdentityReference" /> type.</exception>
  235. <exception cref="T:System.Security.Principal.IdentityNotMappedException">Some or all identity references could not be translated.</exception>
  236. <exception cref="T:System.SystemException">The source account name is too long.
  237. -or-
  238. A Win32 error code was returned.</exception>
  239. </member>
  240. <member name="P:System.Security.Principal.NTAccount.Value">
  241. <summary>Returns a string representation of this <see cref="T:System.Security.Principal.NTAccount" /> object.</summary>
  242. <returns>The string representation of this <see cref="T:System.Security.Principal.NTAccount" /> object.</returns>
  243. </member>
  244. <member name="T:System.Security.Principal.SecurityIdentifier">
  245. <summary>Represents a security identifier (SID) and provides marshaling and comparison operations for SIDs.</summary>
  246. </member>
  247. <member name="M:System.Security.Principal.SecurityIdentifier.#ctor(System.Byte[],System.Int32)">
  248. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class by using a specified binary representation of a security identifier (SID).</summary>
  249. <param name="binaryForm">The byte array that represents the SID.</param>
  250. <param name="offset">The byte offset to use as the starting index in <paramref name="binaryForm" />.</param>
  251. </member>
  252. <member name="M:System.Security.Principal.SecurityIdentifier.#ctor(System.IntPtr)">
  253. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class by using an integer that represents the binary form of a security identifier (SID).</summary>
  254. <param name="binaryForm">An integer that represents the binary form of a SID.</param>
  255. </member>
  256. <member name="M:System.Security.Principal.SecurityIdentifier.#ctor(System.Security.Principal.WellKnownSidType,System.Security.Principal.SecurityIdentifier)">
  257. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class by using the specified well known security identifier (SID) type and domain SID.</summary>
  258. <param name="sidType">One of the enumeration values. This value must not be <see cref="F:System.Security.Principal.WellKnownSidType.LogonIdsSid" />.</param>
  259. <param name="domainSid">The domain SID. This value is required for the following <see cref="T:System.Security.Principal.WellKnownSidType" /> values. This parameter is ignored for any other <see cref="T:System.Security.Principal.WellKnownSidType" /> values.
  260. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountAdministratorSid" />
  261. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountGuestSid" />
  262. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountKrbtgtSid" />
  263. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountDomainAdminsSid" />
  264. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountDomainUsersSid" />
  265. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountDomainGuestsSid" />
  266. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountComputersSid" />
  267. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountControllersSid" />
  268. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountCertAdminsSid" />
  269. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountSchemaAdminsSid" />
  270. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountEnterpriseAdminsSid" />
  271. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountPolicyAdminsSid" />
  272. - <see cref="F:System.Security.Principal.WellKnownSidType.AccountRasAndIasServersSid" /></param>
  273. </member>
  274. <member name="M:System.Security.Principal.SecurityIdentifier.#ctor(System.String)">
  275. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class by using the specified security identifier (SID) in Security Descriptor Definition Language (SDDL) format.</summary>
  276. <param name="sddlForm">SDDL string for the SID used to create the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</param>
  277. </member>
  278. <member name="P:System.Security.Principal.SecurityIdentifier.AccountDomainSid">
  279. <summary>Returns the account domain security identifier (SID) portion from the SID represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object if the SID represents a Windows account SID. If the SID does not represent a Windows account SID, this property returns <see langword="null" />.</summary>
  280. <returns>The account domain SID portion from the SID represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object if the SID represents a Windows account SID; otherwise, it returns <see langword="null" />.</returns>
  281. </member>
  282. <member name="P:System.Security.Principal.SecurityIdentifier.BinaryLength">
  283. <summary>Returns the length, in bytes, of the security identifier (SID) represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</summary>
  284. <returns>The length, in bytes, of the SID represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</returns>
  285. </member>
  286. <member name="M:System.Security.Principal.SecurityIdentifier.CompareTo(System.Security.Principal.SecurityIdentifier)">
  287. <summary>Compares the current <see cref="T:System.Security.Principal.SecurityIdentifier" /> object with the specified <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</summary>
  288. <param name="sid">The object to compare with the current object.</param>
  289. <returns>A signed number indicating the relative values of this instance and <paramref name="sid" />.
  290. Return Value
  291. Description
  292. Less than zero
  293. This instance is less than <paramref name="sid" />.
  294. Zero
  295. This instance is equal to <paramref name="sid" />.
  296. Greater than zero
  297. This instance is greater than <paramref name="sid" />.</returns>
  298. </member>
  299. <member name="M:System.Security.Principal.SecurityIdentifier.Equals(System.Object)">
  300. <summary>Returns a value that indicates whether this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is equal to a specified object.</summary>
  301. <param name="o">An object to compare with this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object, or <see langword="null" />.</param>
  302. <returns>
  303. <see langword="true" /> if <paramref name="o" /> is an object with the same underlying type and value as this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object; otherwise, <see langword="false" />.</returns>
  304. </member>
  305. <member name="M:System.Security.Principal.SecurityIdentifier.Equals(System.Security.Principal.SecurityIdentifier)">
  306. <summary>Indicates whether the specified <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is equal to the current <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</summary>
  307. <param name="sid">The object to compare with the current object.</param>
  308. <returns>
  309. <see langword="true" /> if the value of <paramref name="sid" /> is equal to the value of the current <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</returns>
  310. </member>
  311. <member name="M:System.Security.Principal.SecurityIdentifier.GetBinaryForm(System.Byte[],System.Int32)">
  312. <summary>Copies the binary representation of the specified security identifier (SID) represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class to a byte array.</summary>
  313. <param name="binaryForm">The byte array to receive the copied SID.</param>
  314. <param name="offset">The byte offset to use as the starting index in <paramref name="binaryForm" />.</param>
  315. </member>
  316. <member name="M:System.Security.Principal.SecurityIdentifier.GetHashCode">
  317. <summary>Serves as a hash function for the current <see cref="T:System.Security.Principal.SecurityIdentifier" /> object. The <see cref="M:System.Security.Principal.SecurityIdentifier.GetHashCode" /> method is suitable for hashing algorithms and data structures like a hash table.</summary>
  318. <returns>A hash value for the current <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</returns>
  319. </member>
  320. <member name="M:System.Security.Principal.SecurityIdentifier.IsAccountSid">
  321. <summary>Returns a value that indicates whether the security identifier (SID) represented by this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is a valid Windows account SID.</summary>
  322. <returns>
  323. <see langword="true" /> if the SID represented by this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is a valid Windows account SID; otherwise, <see langword="false" />.</returns>
  324. </member>
  325. <member name="M:System.Security.Principal.SecurityIdentifier.IsEqualDomainSid(System.Security.Principal.SecurityIdentifier)">
  326. <summary>Returns a value that indicates whether the security identifier (SID) represented by this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is from the same domain as the specified SID.</summary>
  327. <param name="sid">The SID to compare with this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</param>
  328. <returns>
  329. <see langword="true" /> if the SID represented by this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object is in the same domain as the <paramref name="sid" /> SID; otherwise, <see langword="false" />.</returns>
  330. </member>
  331. <member name="M:System.Security.Principal.SecurityIdentifier.IsValidTargetType(System.Type)">
  332. <summary>Returns a value that indicates whether the specified type is a valid translation type for the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class.</summary>
  333. <param name="targetType">The type being queried for validity to serve as a conversion from <see cref="T:System.Security.Principal.SecurityIdentifier" />. The following target types are valid:
  334. - <see cref="T:System.Security.Principal.NTAccount" />
  335. - <see cref="T:System.Security.Principal.SecurityIdentifier" /></param>
  336. <returns>
  337. <see langword="true" /> if <paramref name="targetType" /> is a valid translation type for the <see cref="T:System.Security.Principal.SecurityIdentifier" /> class; otherwise, <see langword="false" />.</returns>
  338. </member>
  339. <member name="M:System.Security.Principal.SecurityIdentifier.IsWellKnown(System.Security.Principal.WellKnownSidType)">
  340. <summary>Returns a value that indicates whether the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object matches the specified well known security identifier (SID) type.</summary>
  341. <param name="type">A value to compare with the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</param>
  342. <returns>
  343. <see langword="true" /> if <paramref name="type" /> is the SID type for the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object; otherwise, <see langword="false" />.</returns>
  344. </member>
  345. <member name="F:System.Security.Principal.SecurityIdentifier.MaxBinaryLength">
  346. <summary>Returns the maximum size, in bytes, of the binary representation of the security identifier.</summary>
  347. </member>
  348. <member name="F:System.Security.Principal.SecurityIdentifier.MinBinaryLength">
  349. <summary>Returns the minimum size, in bytes, of the binary representation of the security identifier.</summary>
  350. </member>
  351. <member name="M:System.Security.Principal.SecurityIdentifier.op_Equality(System.Security.Principal.SecurityIdentifier,System.Security.Principal.SecurityIdentifier)">
  352. <summary>Compares two <see cref="T:System.Security.Principal.SecurityIdentifier" /> objects to determine whether they are equal. They are considered equal if they have the same canonical representation as the one returned by the <see cref="P:System.Security.Principal.SecurityIdentifier.Value" /> property or if they are both <see langword="null" />.</summary>
  353. <param name="left">The left operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  354. <param name="right">The right operand to use for the equality comparison. This parameter can be <see langword="null" />.</param>
  355. <returns>
  356. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
  357. </member>
  358. <member name="M:System.Security.Principal.SecurityIdentifier.op_Inequality(System.Security.Principal.SecurityIdentifier,System.Security.Principal.SecurityIdentifier)">
  359. <summary>Compares two <see cref="T:System.Security.Principal.SecurityIdentifier" /> objects to determine whether they are not equal. They are considered not equal if they have different canonical name representations than the one returned by the <see cref="P:System.Security.Principal.SecurityIdentifier.Value" /> property or if one of the objects is <see langword="null" /> and the other is not.</summary>
  360. <param name="left">The left operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  361. <param name="right">The right operand to use for the inequality comparison. This parameter can be <see langword="null" />.</param>
  362. <returns>
  363. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
  364. </member>
  365. <member name="M:System.Security.Principal.SecurityIdentifier.ToString">
  366. <summary>Returns the security identifier (SID), in Security Descriptor Definition Language (SDDL) format, for the account represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object. An example of the SDDL format is S-1-5-9.</summary>
  367. <returns>The SID, in SDDL format, for the account represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</returns>
  368. </member>
  369. <member name="M:System.Security.Principal.SecurityIdentifier.Translate(System.Type)">
  370. <summary>Translates the account name represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object into another <see cref="T:System.Security.Principal.IdentityReference" />-derived type.</summary>
  371. <param name="targetType">The target type for the conversion from <see cref="T:System.Security.Principal.SecurityIdentifier" />. The target type must be a type that is considered valid by the <see cref="M:System.Security.Principal.SecurityIdentifier.IsValidTargetType(System.Type)" /> method.</param>
  372. <returns>The converted identity.</returns>
  373. <exception cref="T:System.ArgumentNullException">
  374. <paramref name="targetType" /> is <see langword="null" />.</exception>
  375. <exception cref="T:System.ArgumentException">
  376. <paramref name="targetType" /> is not an <see cref="T:System.Security.Principal.IdentityReference" /> type.</exception>
  377. <exception cref="T:System.Security.Principal.IdentityNotMappedException">Some or all identity references could not be translated.</exception>
  378. <exception cref="T:System.SystemException">A Win32 error code was returned.</exception>
  379. </member>
  380. <member name="P:System.Security.Principal.SecurityIdentifier.Value">
  381. <summary>Returns an uppercase Security Descriptor Definition Language (SDDL) string for the security identifier (SID) represented by this <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</summary>
  382. <returns>An uppercase SDDL string for the SID represented by the <see cref="T:System.Security.Principal.SecurityIdentifier" /> object.</returns>
  383. </member>
  384. <member name="T:System.Security.Principal.TokenAccessLevels">
  385. <summary>Defines the privileges of the user account associated with the access token.</summary>
  386. </member>
  387. <member name="F:System.Security.Principal.TokenAccessLevels.AdjustDefault">
  388. <summary>The user can change the default owner, primary group, or discretionary access control list (DACL) of the token.</summary>
  389. </member>
  390. <member name="F:System.Security.Principal.TokenAccessLevels.AdjustGroups">
  391. <summary>The user can change the attributes of the groups in the token.</summary>
  392. </member>
  393. <member name="F:System.Security.Principal.TokenAccessLevels.AdjustPrivileges">
  394. <summary>The user can enable or disable privileges in the token.</summary>
  395. </member>
  396. <member name="F:System.Security.Principal.TokenAccessLevels.AdjustSessionId">
  397. <summary>The user can adjust the session identifier of the token.</summary>
  398. </member>
  399. <member name="F:System.Security.Principal.TokenAccessLevels.AllAccess">
  400. <summary>The user has all possible access to the token.</summary>
  401. </member>
  402. <member name="F:System.Security.Principal.TokenAccessLevels.AssignPrimary">
  403. <summary>The user can attach a primary token to a process.</summary>
  404. </member>
  405. <member name="F:System.Security.Principal.TokenAccessLevels.Duplicate">
  406. <summary>The user can duplicate the token.</summary>
  407. </member>
  408. <member name="F:System.Security.Principal.TokenAccessLevels.Impersonate">
  409. <summary>The user can impersonate a client.</summary>
  410. </member>
  411. <member name="F:System.Security.Principal.TokenAccessLevels.MaximumAllowed">
  412. <summary>The maximum value that can be assigned for the <see cref="T:System.Security.Principal.TokenAccessLevels" /> enumeration.</summary>
  413. </member>
  414. <member name="F:System.Security.Principal.TokenAccessLevels.Query">
  415. <summary>The user can query the token.</summary>
  416. </member>
  417. <member name="F:System.Security.Principal.TokenAccessLevels.QuerySource">
  418. <summary>The user can query the source of the token.</summary>
  419. </member>
  420. <member name="F:System.Security.Principal.TokenAccessLevels.Read">
  421. <summary>The user has standard read rights and the <see cref="F:System.Security.Principal.TokenAccessLevels.Query" /> privilege for the token.</summary>
  422. </member>
  423. <member name="F:System.Security.Principal.TokenAccessLevels.Write">
  424. <summary>The user has standard write rights and the <see cref="F:System.Security.Principal.TokenAccessLevels.AdjustPrivileges" />, <see cref="F:System.Security.Principal.TokenAccessLevels.AdjustGroups" /> and <see cref="F:System.Security.Principal.TokenAccessLevels.AdjustDefault" /> privileges for the token.</summary>
  425. </member>
  426. <member name="T:System.Security.Principal.WellKnownSidType">
  427. <summary>Defines a set of commonly used security identifiers (SIDs).</summary>
  428. </member>
  429. <member name="F:System.Security.Principal.WellKnownSidType.AccountAdministratorSid">
  430. <summary>Indicates a SID that matches the account administrators group.</summary>
  431. </member>
  432. <member name="F:System.Security.Principal.WellKnownSidType.AccountCertAdminsSid">
  433. <summary>Indicates a SID that matches the certificate administrators group.</summary>
  434. </member>
  435. <member name="F:System.Security.Principal.WellKnownSidType.AccountComputersSid">
  436. <summary>Indicates a SID that matches the account computer group.</summary>
  437. </member>
  438. <member name="F:System.Security.Principal.WellKnownSidType.AccountControllersSid">
  439. <summary>Indicates a SID that matches the account controller group.</summary>
  440. </member>
  441. <member name="F:System.Security.Principal.WellKnownSidType.AccountDomainAdminsSid">
  442. <summary>Indicates a SID that matches the account domain administrator group.</summary>
  443. </member>
  444. <member name="F:System.Security.Principal.WellKnownSidType.AccountDomainGuestsSid">
  445. <summary>Indicates a SID that matches the account domain guests group.</summary>
  446. </member>
  447. <member name="F:System.Security.Principal.WellKnownSidType.AccountDomainUsersSid">
  448. <summary>Indicates a SID that matches the account domain users group.</summary>
  449. </member>
  450. <member name="F:System.Security.Principal.WellKnownSidType.AccountEnterpriseAdminsSid">
  451. <summary>Indicates a SID that matches the enterprise administrators group.</summary>
  452. </member>
  453. <member name="F:System.Security.Principal.WellKnownSidType.AccountGuestSid">
  454. <summary>Indicates a SID that matches the account guest group.</summary>
  455. </member>
  456. <member name="F:System.Security.Principal.WellKnownSidType.AccountKrbtgtSid">
  457. <summary>Indicates a SID that matches the account Kerberos target group.</summary>
  458. </member>
  459. <member name="F:System.Security.Principal.WellKnownSidType.AccountPolicyAdminsSid">
  460. <summary>Indicates a SID that matches the policy administrators group.</summary>
  461. </member>
  462. <member name="F:System.Security.Principal.WellKnownSidType.AccountRasAndIasServersSid">
  463. <summary>Indicates a SID that matches the RAS and IAS server account.</summary>
  464. </member>
  465. <member name="F:System.Security.Principal.WellKnownSidType.AccountSchemaAdminsSid">
  466. <summary>Indicates a SID that matches the schema administrators group.</summary>
  467. </member>
  468. <member name="F:System.Security.Principal.WellKnownSidType.AnonymousSid">
  469. <summary>Indicates a SID for the anonymous account.</summary>
  470. </member>
  471. <member name="F:System.Security.Principal.WellKnownSidType.AuthenticatedUserSid">
  472. <summary>Indicates a SID for an authenticated user.</summary>
  473. </member>
  474. <member name="F:System.Security.Principal.WellKnownSidType.BatchSid">
  475. <summary>Indicates a SID for a batch process. This SID is added to the process of a token when it logs on as a batch job.</summary>
  476. </member>
  477. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinAccountOperatorsSid">
  478. <summary>Indicates a SID that matches the account operators account.</summary>
  479. </member>
  480. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinAdministratorsSid">
  481. <summary>Indicates a SID that matches the administrator account.</summary>
  482. </member>
  483. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinAuthorizationAccessSid">
  484. <summary>Indicates a SID that matches the Windows Authorization Access group.</summary>
  485. </member>
  486. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinBackupOperatorsSid">
  487. <summary>Indicates a SID that matches the backup operators group.</summary>
  488. </member>
  489. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinDomainSid">
  490. <summary>Indicates a SID that matches the domain account.</summary>
  491. </member>
  492. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinGuestsSid">
  493. <summary>Indicates a SID that matches the guest account.</summary>
  494. </member>
  495. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinIncomingForestTrustBuildersSid">
  496. <summary>Indicates a SID that allows a user to create incoming forest trusts. It is added to the token of users who are a member of the Incoming Forest Trust Builders built-in group in the root domain of the forest.</summary>
  497. </member>
  498. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinNetworkConfigurationOperatorsSid">
  499. <summary>Indicates a SID that matches the network operators group.</summary>
  500. </member>
  501. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinPerformanceLoggingUsersSid">
  502. <summary>Indicates a SID that matches the group of users that have remote access to monitor the computer.</summary>
  503. </member>
  504. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinPerformanceMonitoringUsersSid">
  505. <summary>Indicates a SID that matches the group of users that have remote access to schedule logging of performance counters on this computer.</summary>
  506. </member>
  507. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinPowerUsersSid">
  508. <summary>Indicates a SID that matches the power users group.</summary>
  509. </member>
  510. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinPreWindows2000CompatibleAccessSid">
  511. <summary>Indicates a SID that matches pre-Windows 2000 compatible accounts.</summary>
  512. </member>
  513. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinPrintOperatorsSid">
  514. <summary>Indicates a SID that matches the print operators group.</summary>
  515. </member>
  516. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinRemoteDesktopUsersSid">
  517. <summary>Indicates a SID that matches remote desktop users.</summary>
  518. </member>
  519. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinReplicatorSid">
  520. <summary>Indicates a SID that matches the replicator account.</summary>
  521. </member>
  522. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinSystemOperatorsSid">
  523. <summary>Indicates a SID that matches the system operators group.</summary>
  524. </member>
  525. <member name="F:System.Security.Principal.WellKnownSidType.BuiltinUsersSid">
  526. <summary>Indicates a SID that matches built-in user accounts.</summary>
  527. </member>
  528. <member name="F:System.Security.Principal.WellKnownSidType.CreatorGroupServerSid">
  529. <summary>Indicates a creator group server SID.</summary>
  530. </member>
  531. <member name="F:System.Security.Principal.WellKnownSidType.CreatorGroupSid">
  532. <summary>Indicates a SID that matches the creator group of an object.</summary>
  533. </member>
  534. <member name="F:System.Security.Principal.WellKnownSidType.CreatorOwnerServerSid">
  535. <summary>Indicates a creator owner server SID.</summary>
  536. </member>
  537. <member name="F:System.Security.Principal.WellKnownSidType.CreatorOwnerSid">
  538. <summary>Indicates a SID that matches the owner or creator of an object.</summary>
  539. </member>
  540. <member name="F:System.Security.Principal.WellKnownSidType.DialupSid">
  541. <summary>Indicates a SID for a dial-up account.</summary>
  542. </member>
  543. <member name="F:System.Security.Principal.WellKnownSidType.DigestAuthenticationSid">
  544. <summary>Indicates a SID present when the Microsoft Digest authentication package authenticated the client.</summary>
  545. </member>
  546. <member name="F:System.Security.Principal.WellKnownSidType.EnterpriseControllersSid">
  547. <summary>Indicates a SID for an enterprise controller.</summary>
  548. </member>
  549. <member name="F:System.Security.Principal.WellKnownSidType.InteractiveSid">
  550. <summary>Indicates a SID for an interactive account. This SID is added to the process of a token when it logs on interactively.</summary>
  551. </member>
  552. <member name="F:System.Security.Principal.WellKnownSidType.LocalServiceSid">
  553. <summary>Indicates a SID that matches a local service.</summary>
  554. </member>
  555. <member name="F:System.Security.Principal.WellKnownSidType.LocalSid">
  556. <summary>Indicates a local SID.</summary>
  557. </member>
  558. <member name="F:System.Security.Principal.WellKnownSidType.LocalSystemSid">
  559. <summary>Indicates a SID that matches the local system.</summary>
  560. </member>
  561. <member name="F:System.Security.Principal.WellKnownSidType.LogonIdsSid">
  562. <summary>Indicates a SID that matches logon IDs.</summary>
  563. </member>
  564. <member name="F:System.Security.Principal.WellKnownSidType.MaxDefined">
  565. <summary>Indicates the maximum defined SID in the <see cref="T:System.Security.Principal.WellKnownSidType" /> enumeration.</summary>
  566. </member>
  567. <member name="F:System.Security.Principal.WellKnownSidType.NetworkServiceSid">
  568. <summary>Indicates a SID that matches a network service.</summary>
  569. </member>
  570. <member name="F:System.Security.Principal.WellKnownSidType.NetworkSid">
  571. <summary>Indicates a SID for a network account. This SID is added to the process of a token when it logs on across a network.</summary>
  572. </member>
  573. <member name="F:System.Security.Principal.WellKnownSidType.NTAuthoritySid">
  574. <summary>Indicates a SID for the Windows NT authority.</summary>
  575. </member>
  576. <member name="F:System.Security.Principal.WellKnownSidType.NtlmAuthenticationSid">
  577. <summary>Indicates a SID present when the Microsoft NTLM authentication package authenticated the client.</summary>
  578. </member>
  579. <member name="F:System.Security.Principal.WellKnownSidType.NullSid">
  580. <summary>Indicates a null SID.</summary>
  581. </member>
  582. <member name="F:System.Security.Principal.WellKnownSidType.OtherOrganizationSid">
  583. <summary>Indicates a SID present when the user authenticated across a forest with the selective authentication option enabled. If this SID is present, then <see cref="F:System.Security.Principal.WellKnownSidType.ThisOrganizationSid" /> cannot be present.</summary>
  584. </member>
  585. <member name="F:System.Security.Principal.WellKnownSidType.ProxySid">
  586. <summary>Indicates a proxy SID.</summary>
  587. </member>
  588. <member name="F:System.Security.Principal.WellKnownSidType.RemoteLogonIdSid">
  589. <summary>Indicates a SID that matches remote logons.</summary>
  590. </member>
  591. <member name="F:System.Security.Principal.WellKnownSidType.RestrictedCodeSid">
  592. <summary>Indicates a SID for restricted code.</summary>
  593. </member>
  594. <member name="F:System.Security.Principal.WellKnownSidType.SChannelAuthenticationSid">
  595. <summary>Indicates a SID present when the Secure Channel (SSL/TLS) authentication package authenticated the client.</summary>
  596. </member>
  597. <member name="F:System.Security.Principal.WellKnownSidType.SelfSid">
  598. <summary>Indicates a SID for self.</summary>
  599. </member>
  600. <member name="F:System.Security.Principal.WellKnownSidType.ServiceSid">
  601. <summary>Indicates a SID for a service. This SID is added to the process of a token when it logs on as a service.</summary>
  602. </member>
  603. <member name="F:System.Security.Principal.WellKnownSidType.TerminalServerSid">
  604. <summary>Indicates a SID that matches a terminal server account.</summary>
  605. </member>
  606. <member name="F:System.Security.Principal.WellKnownSidType.ThisOrganizationSid">
  607. <summary>Indicates a SID present when the user authenticated from within the forest or across a trust that does not have the selective authentication option enabled. If this SID is present, then <see cref="F:System.Security.Principal.WellKnownSidType.OtherOrganizationSid" /> cannot be present.</summary>
  608. </member>
  609. <member name="F:System.Security.Principal.WellKnownSidType.WinAccountReadonlyControllersSid">
  610. <summary>Indicates a SID that matches an account read-only controllers group.</summary>
  611. </member>
  612. <member name="F:System.Security.Principal.WellKnownSidType.WinApplicationPackageAuthoritySid">
  613. <summary>Indicates a SID that matches the application package authority.</summary>
  614. </member>
  615. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinAnyPackageSid">
  616. <summary>Indicates a SID that applies to all app containers.</summary>
  617. </member>
  618. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinCertSvcDComAccessGroup">
  619. <summary>Indicates a SID that matches the built-in DCOM certification services access group.</summary>
  620. </member>
  621. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinCryptoOperatorsSid">
  622. <summary>Indicates a SID that allows a user to use cryptographic operations. It is added to the token of users who are a member of the CryptoOperators built-in group.</summary>
  623. </member>
  624. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinDCOMUsersSid">
  625. <summary>Indicates a SID that matches the distributed COM user group.</summary>
  626. </member>
  627. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinEventLogReadersGroup">
  628. <summary>Indicates a SID that matches an event log readers group.</summary>
  629. </member>
  630. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinIUsersSid">
  631. <summary>Indicates a SID that matches the Internet built-in user group.</summary>
  632. </member>
  633. <member name="F:System.Security.Principal.WellKnownSidType.WinBuiltinTerminalServerLicenseServersSid">
  634. <summary>Indicates a SID is present in a server that can issue Terminal Server licenses.</summary>
  635. </member>
  636. <member name="F:System.Security.Principal.WellKnownSidType.WinCacheablePrincipalsGroupSid">
  637. <summary>Indicates a SID that matches a cacheable principals group.</summary>
  638. </member>
  639. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityDocumentsLibrarySid">
  640. <summary>Indicates a SID for documents library capability for app containers.</summary>
  641. </member>
  642. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityEnterpriseAuthenticationSid">
  643. <summary>Indicates a SID for Windows credentials capability for app containers.</summary>
  644. </member>
  645. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityInternetClientServerSid">
  646. <summary>Indicates a SID of Internet client and server capability for app containers.</summary>
  647. </member>
  648. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityInternetClientSid">
  649. <summary>Indicates a SID of Internet client capability for app containers.</summary>
  650. </member>
  651. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityMusicLibrarySid">
  652. <summary>Indicates a SID for music library capability for app containers.</summary>
  653. </member>
  654. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityPicturesLibrarySid">
  655. <summary>Indicates a SID for pictures library capability for app containers.</summary>
  656. </member>
  657. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityPrivateNetworkClientServerSid">
  658. <summary>Indicates a SID of private network client and server capability for app containers.</summary>
  659. </member>
  660. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityRemovableStorageSid">
  661. <summary>Indicates a SID for removable storage capability for app containers.</summary>
  662. </member>
  663. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilitySharedUserCertificatesSid">
  664. <summary>Indicates a SID for shared user certificates capability for app containers.</summary>
  665. </member>
  666. <member name="F:System.Security.Principal.WellKnownSidType.WinCapabilityVideosLibrarySid">
  667. <summary>Indicates a SID for videos library capability for app containers.</summary>
  668. </member>
  669. <member name="F:System.Security.Principal.WellKnownSidType.WinConsoleLogonSid">
  670. <summary>Indicates a SID that matches a console logon group.</summary>
  671. </member>
  672. <member name="F:System.Security.Principal.WellKnownSidType.WinCreatorOwnerRightsSid">
  673. <summary>Indicates a SID that matches a creator and owner rights group.</summary>
  674. </member>
  675. <member name="F:System.Security.Principal.WellKnownSidType.WinEnterpriseReadonlyControllersSid">
  676. <summary>Indicates a SID that matches an enterprise wide read-only controllers group.</summary>
  677. </member>
  678. <member name="F:System.Security.Principal.WellKnownSidType.WinHighLabelSid">
  679. <summary>Indicates a SID that matches a high level of trust label.</summary>
  680. </member>
  681. <member name="F:System.Security.Principal.WellKnownSidType.WinIUserSid">
  682. <summary>Indicates a SID that matches the Internet user group.</summary>
  683. </member>
  684. <member name="F:System.Security.Principal.WellKnownSidType.WinLocalLogonSid">
  685. <summary>Indicates a SID that matches a local logon group.</summary>
  686. </member>
  687. <member name="F:System.Security.Principal.WellKnownSidType.WinLowLabelSid">
  688. <summary>Indicates a SID that matches an low level of trust label.</summary>
  689. </member>
  690. <member name="F:System.Security.Principal.WellKnownSidType.WinMediumLabelSid">
  691. <summary>Indicates a SID that matches an medium level of trust label.</summary>
  692. </member>
  693. <member name="F:System.Security.Principal.WellKnownSidType.WinMediumPlusLabelSid">
  694. <summary>Indicates a SID that matches the medium plus integrity label.</summary>
  695. </member>
  696. <member name="F:System.Security.Principal.WellKnownSidType.WinNewEnterpriseReadonlyControllersSid">
  697. <summary>Indicates a SID that matches a read-only enterprise domain controller.</summary>
  698. </member>
  699. <member name="F:System.Security.Principal.WellKnownSidType.WinNonCacheablePrincipalsGroupSid">
  700. <summary>Indicates a SID that matches a non-cacheable principals group.</summary>
  701. </member>
  702. <member name="F:System.Security.Principal.WellKnownSidType.WinSystemLabelSid">
  703. <summary>Indicates a SID that matches a system label.</summary>
  704. </member>
  705. <member name="F:System.Security.Principal.WellKnownSidType.WinThisOrganizationCertificateSid">
  706. <summary>Indicates a SID that matches a certificate for the given organization.</summary>
  707. </member>
  708. <member name="F:System.Security.Principal.WellKnownSidType.WinUntrustedLabelSid">
  709. <summary>Indicates a SID that matches an untrusted label.</summary>
  710. </member>
  711. <member name="F:System.Security.Principal.WellKnownSidType.WinWriteRestrictedCodeSid">
  712. <summary>Indicates a SID that matches a write restricted code group.</summary>
  713. </member>
  714. <member name="F:System.Security.Principal.WellKnownSidType.WorldSid">
  715. <summary>Indicates a SID that matches everyone.</summary>
  716. </member>
  717. <member name="T:System.Security.Principal.WindowsAccountType">
  718. <summary>Specifies the type of Windows account used.</summary>
  719. </member>
  720. <member name="F:System.Security.Principal.WindowsAccountType.Anonymous">
  721. <summary>An anonymous account.</summary>
  722. </member>
  723. <member name="F:System.Security.Principal.WindowsAccountType.Guest">
  724. <summary>A Windows guest account.</summary>
  725. </member>
  726. <member name="F:System.Security.Principal.WindowsAccountType.Normal">
  727. <summary>A standard user account.</summary>
  728. </member>
  729. <member name="F:System.Security.Principal.WindowsAccountType.System">
  730. <summary>A Windows system account.</summary>
  731. </member>
  732. <member name="T:System.Security.Principal.WindowsBuiltInRole">
  733. <summary>Specifies common roles to be used with <see cref="M:System.Security.Principal.WindowsPrincipal.IsInRole(System.String)" />.</summary>
  734. </member>
  735. <member name="F:System.Security.Principal.WindowsBuiltInRole.AccountOperator">
  736. <summary>Account operators manage the user accounts on a computer or domain.</summary>
  737. </member>
  738. <member name="F:System.Security.Principal.WindowsBuiltInRole.Administrator">
  739. <summary>Administrators have complete and unrestricted access to the computer or domain.</summary>
  740. </member>
  741. <member name="F:System.Security.Principal.WindowsBuiltInRole.BackupOperator">
  742. <summary>Backup operators can override security restrictions for the sole purpose of backing up or restoring files.</summary>
  743. </member>
  744. <member name="F:System.Security.Principal.WindowsBuiltInRole.Guest">
  745. <summary>Guests are more restricted than users.</summary>
  746. </member>
  747. <member name="F:System.Security.Principal.WindowsBuiltInRole.PowerUser">
  748. <summary>Power users possess most administrative permissions with some restrictions. Thus, power users can run legacy applications, in addition to certified applications.</summary>
  749. </member>
  750. <member name="F:System.Security.Principal.WindowsBuiltInRole.PrintOperator">
  751. <summary>Print operators can take control of a printer.</summary>
  752. </member>
  753. <member name="F:System.Security.Principal.WindowsBuiltInRole.Replicator">
  754. <summary>Replicators support file replication in a domain.</summary>
  755. </member>
  756. <member name="F:System.Security.Principal.WindowsBuiltInRole.SystemOperator">
  757. <summary>System operators manage a particular computer.</summary>
  758. </member>
  759. <member name="F:System.Security.Principal.WindowsBuiltInRole.User">
  760. <summary>Users are prevented from making accidental or intentional system-wide changes. Thus, users can run certified applications, but not most legacy applications.</summary>
  761. </member>
  762. <member name="T:System.Security.Principal.WindowsIdentity">
  763. <summary>Represents a Windows user.</summary>
  764. </member>
  765. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.IntPtr)">
  766. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by the specified Windows account token.</summary>
  767. <param name="userToken">The account token for the user on whose behalf the code is running.</param>
  768. <exception cref="T:System.ArgumentException">
  769. <paramref name="userToken" /> is 0.
  770. -or-
  771. <paramref name="userToken" /> is duplicated and invalid for impersonation.</exception>
  772. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  773. -or-
  774. A Win32 error occurred.</exception>
  775. </member>
  776. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.IntPtr,System.String)">
  777. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by the specified Windows account token and the specified authentication type.</summary>
  778. <param name="userToken">The account token for the user on whose behalf the code is running.</param>
  779. <param name="type">(Informational use only.) The type of authentication used to identify the user.</param>
  780. <exception cref="T:System.ArgumentException">
  781. <paramref name="userToken" /> is 0.
  782. -or-
  783. <paramref name="userToken" /> is duplicated and invalid for impersonation.</exception>
  784. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  785. -or-
  786. A Win32 error occurred.</exception>
  787. </member>
  788. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.IntPtr,System.String,System.Security.Principal.WindowsAccountType)">
  789. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by the specified Windows account token, the specified authentication type, and the specified Windows account type.</summary>
  790. <param name="userToken">The account token for the user on whose behalf the code is running.</param>
  791. <param name="type">(Informational use only.) The type of authentication used to identify the user.</param>
  792. <param name="acctType">One of the enumeration values.</param>
  793. <exception cref="T:System.ArgumentException">
  794. <paramref name="userToken" /> is 0.
  795. -or-
  796. <paramref name="userToken" /> is duplicated and invalid for impersonation.</exception>
  797. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  798. -or-
  799. A Win32 error occurred.</exception>
  800. </member>
  801. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.IntPtr,System.String,System.Security.Principal.WindowsAccountType,System.Boolean)">
  802. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by the specified Windows account token, the specified authentication type, the specified Windows account type, and the specified authentication status.</summary>
  803. <param name="userToken">The account token for the user on whose behalf the code is running.</param>
  804. <param name="type">(Informational use only.) The type of authentication used to identify the user.</param>
  805. <param name="acctType">One of the enumeration values.</param>
  806. <param name="isAuthenticated">
  807. <see langword="true" /> to indicate that the user is authenticated; otherwise, <see langword="false" />.</param>
  808. <exception cref="T:System.ArgumentException">
  809. <paramref name="userToken" /> is 0.
  810. -or-
  811. <paramref name="userToken" /> is duplicated and invalid for impersonation.</exception>
  812. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  813. -or-
  814. A Win32 error occurred.</exception>
  815. </member>
  816. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  817. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by information in a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> stream.</summary>
  818. <param name="info">The object containing the account information for the user.</param>
  819. <param name="context">An object that indicates the stream characteristics.</param>
  820. <exception cref="T:System.NotSupportedException">A <see cref="T:System.Security.Principal.WindowsIdentity" /> cannot be serialized across processes.</exception>
  821. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  822. -or-
  823. A Win32 error occurred.</exception>
  824. </member>
  825. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.Security.Principal.WindowsIdentity)">
  826. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class by using the specified <see cref="T:System.Security.Principal.WindowsIdentity" /> object.</summary>
  827. <param name="identity">The object from which to construct the new instance of <see cref="T:System.Security.Principal.WindowsIdentity" />.</param>
  828. </member>
  829. <member name="M:System.Security.Principal.WindowsIdentity.#ctor(System.String)">
  830. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsIdentity" /> class for the user represented by the specified User Principal Name (UPN).</summary>
  831. <param name="sUserPrincipalName">The UPN for the user on whose behalf the code is running.</param>
  832. <exception cref="T:System.UnauthorizedAccessException">Windows returned the Windows NT status code STATUS_ACCESS_DENIED.</exception>
  833. <exception cref="T:System.OutOfMemoryException">There is insufficient memory available.</exception>
  834. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  835. -or-
  836. The computer is not attached to a Windows 2003 or later domain.
  837. -or-
  838. The computer is not running Windows 2003 or later.
  839. -or-
  840. The user is not a member of the domain the computer is attached to.</exception>
  841. </member>
  842. <member name="P:System.Security.Principal.WindowsIdentity.AccessToken">
  843. <summary>Gets this <see cref="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle" /> for this <see cref="T:System.Security.Principal.WindowsIdentity" /> instance.</summary>
  844. <returns>Returns a <see cref="T:Microsoft.Win32.SafeHandles.SafeAccessTokenHandle" />.</returns>
  845. </member>
  846. <member name="P:System.Security.Principal.WindowsIdentity.AuthenticationType">
  847. <summary>Gets the type of authentication used to identify the user.</summary>
  848. <returns>The type of authentication used to identify the user.</returns>
  849. <exception cref="T:System.UnauthorizedAccessException">Windows returned the Windows NT status code STATUS_ACCESS_DENIED.</exception>
  850. <exception cref="T:System.OutOfMemoryException">There is insufficient memory available.</exception>
  851. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.
  852. -or-
  853. The computer is not attached to a Windows 2003 or later domain.
  854. -or-
  855. The computer is not running Windows 2003 or later.
  856. -or-
  857. The user is not a member of the domain the computer is attached to.</exception>
  858. </member>
  859. <member name="P:System.Security.Principal.WindowsIdentity.Claims">
  860. <summary>Gets all claims for the user represented by this Windows identity.</summary>
  861. <returns>A collection of claims for this <see cref="T:System.Security.Principal.WindowsIdentity" /> object.</returns>
  862. </member>
  863. <member name="M:System.Security.Principal.WindowsIdentity.Clone">
  864. <summary>Creates a new object that is a copy of the current instance.</summary>
  865. <returns>A copy of the current instance.</returns>
  866. </member>
  867. <member name="F:System.Security.Principal.WindowsIdentity.DefaultIssuer">
  868. <summary>Identifies the name of the default <see cref="T:System.Security.Claims.ClaimsIdentity" /> issuer.</summary>
  869. </member>
  870. <member name="P:System.Security.Principal.WindowsIdentity.DeviceClaims">
  871. <summary>Gets claims that have the <see cref="F:System.Security.Claims.ClaimTypes.WindowsDeviceClaim" /> property key.</summary>
  872. <returns>A collection of claims that have the <see cref="F:System.Security.Claims.ClaimTypes.WindowsDeviceClaim" /> property key.</returns>
  873. </member>
  874. <member name="M:System.Security.Principal.WindowsIdentity.Dispose">
  875. <summary>Releases all resources used by the <see cref="T:System.Security.Principal.WindowsIdentity" />.</summary>
  876. </member>
  877. <member name="M:System.Security.Principal.WindowsIdentity.Dispose(System.Boolean)">
  878. <summary>Releases the unmanaged resources used by the <see cref="T:System.Security.Principal.WindowsIdentity" /> and optionally releases the managed resources.</summary>
  879. <param name="disposing">
  880. <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
  881. </member>
  882. <member name="M:System.Security.Principal.WindowsIdentity.GetAnonymous">
  883. <summary>Returns a <see cref="T:System.Security.Principal.WindowsIdentity" /> object that you can use as a sentinel value in your code to represent an anonymous user. The property value does not represent the built-in anonymous identity used by the Windows operating system.</summary>
  884. <returns>An object that represents an anonymous user.</returns>
  885. </member>
  886. <member name="M:System.Security.Principal.WindowsIdentity.GetCurrent">
  887. <summary>Returns a <see cref="T:System.Security.Principal.WindowsIdentity" /> object that represents the current Windows user.</summary>
  888. <returns>An object that represents the current user.</returns>
  889. <exception cref="T:System.Security.SecurityException">The caller does not have the correct permissions.</exception>
  890. </member>
  891. <member name="M:System.Security.Principal.WindowsIdentity.GetCurrent(System.Boolean)">
  892. <summary>Returns a <see cref="T:System.Security.Principal.WindowsIdentity" /> object that represents the Windows identity for either the thread or the process, depending on the value of the <paramref name="ifImpersonating" /> parameter.</summary>
  893. <param name="ifImpersonating">
  894. <see langword="true" /> to return the <see cref="T:System.Security.Principal.WindowsIdentity" /> only if the thread is currently impersonating; <see langword="false" /> to return the <see cref="T:System.Security.Principal.WindowsIdentity" /> of the thread if it is impersonating or the <see cref="T:System.Security.Principal.WindowsIdentity" /> of the process if the thread is not currently impersonating.</param>
  895. <returns>An object that represents a Windows user.</returns>
  896. </member>
  897. <member name="M:System.Security.Principal.WindowsIdentity.GetCurrent(System.Security.Principal.TokenAccessLevels)">
  898. <summary>Returns a <see cref="T:System.Security.Principal.WindowsIdentity" /> object that represents the current Windows user, using the specified desired token access level.</summary>
  899. <param name="desiredAccess">A bitwise combination of the enumeration values.</param>
  900. <returns>An object that represents the current user.</returns>
  901. </member>
  902. <member name="P:System.Security.Principal.WindowsIdentity.Groups">
  903. <summary>Gets the groups the current Windows user belongs to.</summary>
  904. <returns>An object representing the groups the current Windows user belongs to.</returns>
  905. </member>
  906. <member name="P:System.Security.Principal.WindowsIdentity.ImpersonationLevel">
  907. <summary>Gets the impersonation level for the user.</summary>
  908. <returns>One of the enumeration values that specifies the impersonation level.</returns>
  909. </member>
  910. <member name="P:System.Security.Principal.WindowsIdentity.IsAnonymous">
  911. <summary>Gets a value that indicates whether the user account is identified as an anonymous account by the system.</summary>
  912. <returns>
  913. <see langword="true" /> if the user account is an anonymous account; otherwise, <see langword="false" />.</returns>
  914. </member>
  915. <member name="P:System.Security.Principal.WindowsIdentity.IsAuthenticated">
  916. <summary>Gets a value indicating whether the user has been authenticated by Windows.</summary>
  917. <returns>
  918. <see langword="true" /> if the user was authenticated; otherwise, <see langword="false" />.</returns>
  919. </member>
  920. <member name="P:System.Security.Principal.WindowsIdentity.IsGuest">
  921. <summary>Gets a value indicating whether the user account is identified as a <see cref="F:System.Security.Principal.WindowsAccountType.Guest" /> account by the system.</summary>
  922. <returns>
  923. <see langword="true" /> if the user account is a <see cref="F:System.Security.Principal.WindowsAccountType.Guest" /> account; otherwise, <see langword="false" />.</returns>
  924. </member>
  925. <member name="P:System.Security.Principal.WindowsIdentity.IsSystem">
  926. <summary>Gets a value indicating whether the user account is identified as a <see cref="F:System.Security.Principal.WindowsAccountType.System" /> account by the system.</summary>
  927. <returns>
  928. <see langword="true" /> if the user account is a <see cref="F:System.Security.Principal.WindowsAccountType.System" /> account; otherwise, <see langword="false" />.</returns>
  929. </member>
  930. <member name="P:System.Security.Principal.WindowsIdentity.Name">
  931. <summary>Gets the user's Windows logon name.</summary>
  932. <returns>The Windows logon name of the user on whose behalf the code is being run.</returns>
  933. </member>
  934. <member name="P:System.Security.Principal.WindowsIdentity.Owner">
  935. <summary>Gets the security identifier (SID) for the token owner.</summary>
  936. <returns>An object for the token owner.</returns>
  937. </member>
  938. <member name="M:System.Security.Principal.WindowsIdentity.RunImpersonated(Microsoft.Win32.SafeHandles.SafeAccessTokenHandle,System.Action)">
  939. <summary>Runs the specified action as the impersonated Windows identity. Instead of using an impersonated method call and running your function in <see cref="T:System.Security.Principal.WindowsImpersonationContext" />, you can use <see cref="M:System.Security.Principal.WindowsIdentity.RunImpersonated(Microsoft.Win32.SafeHandles.SafeAccessTokenHandle,System.Action)" /> and provide your function directly as a parameter.</summary>
  940. <param name="safeAccessTokenHandle">The SafeAccessTokenHandle of the impersonated Windows identity.</param>
  941. <param name="action">The System.Action to run.</param>
  942. </member>
  943. <member name="M:System.Security.Principal.WindowsIdentity.RunImpersonated``1(Microsoft.Win32.SafeHandles.SafeAccessTokenHandle,System.Func{``0})">
  944. <summary>Runs the specified function as the impersonated Windows identity. Instead of using an impersonated method call and running your function in <see cref="T:System.Security.Principal.WindowsImpersonationContext" />, you can use <see cref="M:System.Security.Principal.WindowsIdentity.RunImpersonated(Microsoft.Win32.SafeHandles.SafeAccessTokenHandle,System.Action)" /> and provide your function directly as a parameter.</summary>
  945. <param name="safeAccessTokenHandle">The SafeAccessTokenHandle of the impersonated Windows identity.</param>
  946. <param name="func">The System.Func to run.</param>
  947. <typeparam name="T">The type of object used by and returned by the function.</typeparam>
  948. <returns>The result of the function.</returns>
  949. </member>
  950. <member name="M:System.Security.Principal.WindowsIdentity.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization(System.Object)">
  951. <summary>Implements the <see cref="T:System.Runtime.Serialization.ISerializable" /> interface and is called back by the deserialization event when deserialization is complete.</summary>
  952. <param name="sender">The source of the deserialization event.</param>
  953. </member>
  954. <member name="M:System.Security.Principal.WindowsIdentity.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  955. <summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object with the logical context information needed to recreate an instance of this execution context.</summary>
  956. <param name="info">An object containing the information required to serialize the <see cref="T:System.Collections.Hashtable" />.</param>
  957. <param name="context">An object containing the source and destination of the serialized stream associated with the <see cref="T:System.Collections.Hashtable" />.</param>
  958. </member>
  959. <member name="P:System.Security.Principal.WindowsIdentity.Token">
  960. <summary>Gets the Windows account token for the user.</summary>
  961. <returns>The handle of the access token associated with the current execution thread.</returns>
  962. </member>
  963. <member name="P:System.Security.Principal.WindowsIdentity.User">
  964. <summary>Gets the security identifier (SID) for the user.</summary>
  965. <returns>An object for the user.</returns>
  966. </member>
  967. <member name="P:System.Security.Principal.WindowsIdentity.UserClaims">
  968. <summary>Gets claims that have the <see cref="F:System.Security.Claims.ClaimTypes.WindowsUserClaim" /> property key.</summary>
  969. <returns>A collection of claims that have the <see cref="F:System.Security.Claims.ClaimTypes.WindowsUserClaim" /> property key.</returns>
  970. </member>
  971. <member name="T:System.Security.Principal.WindowsPrincipal">
  972. <summary>Enables code to check the Windows group membership of a Windows user.</summary>
  973. </member>
  974. <member name="M:System.Security.Principal.WindowsPrincipal.#ctor(System.Security.Principal.WindowsIdentity)">
  975. <summary>Initializes a new instance of the <see cref="T:System.Security.Principal.WindowsPrincipal" /> class by using the specified <see cref="T:System.Security.Principal.WindowsIdentity" /> object.</summary>
  976. <param name="ntIdentity">The object from which to construct the new instance of <see cref="T:System.Security.Principal.WindowsPrincipal" />.</param>
  977. <exception cref="T:System.ArgumentNullException">
  978. <paramref name="ntIdentity" /> is <see langword="null" />.</exception>
  979. </member>
  980. <member name="P:System.Security.Principal.WindowsPrincipal.DeviceClaims">
  981. <summary>Gets all Windows device claims from this principal.</summary>
  982. <returns>A collection of all Windows device claims from this principal.</returns>
  983. </member>
  984. <member name="P:System.Security.Principal.WindowsPrincipal.Identity">
  985. <summary>Gets the identity of the current principal.</summary>
  986. <returns>The <see cref="T:System.Security.Principal.WindowsIdentity" /> object of the current principal.</returns>
  987. </member>
  988. <member name="M:System.Security.Principal.WindowsPrincipal.IsInRole(System.Int32)">
  989. <summary>Determines whether the current principal belongs to the Windows user group with the specified relative identifier (RID).</summary>
  990. <param name="rid">The RID of the Windows user group in which to check for the principal's membership status.</param>
  991. <returns>
  992. <see langword="true" /> if the current principal is a member of the specified Windows user group, that is, in a particular role; otherwise, <see langword="false" />.</returns>
  993. </member>
  994. <member name="M:System.Security.Principal.WindowsPrincipal.IsInRole(System.Security.Principal.SecurityIdentifier)">
  995. <summary>Determines whether the current principal belongs to the Windows user group with the specified security identifier (SID).</summary>
  996. <param name="sid">A <see cref="T:System.Security.Principal.SecurityIdentifier" /> that uniquely identifies a Windows user group.</param>
  997. <returns>
  998. <see langword="true" /> if the current principal is a member of the specified Windows user group; otherwise, <see langword="false" />.</returns>
  999. <exception cref="T:System.ArgumentNullException">
  1000. <paramref name="sid" /> is <see langword="null" />.</exception>
  1001. <exception cref="T:System.Security.SecurityException">Windows returned a Win32 error.</exception>
  1002. </member>
  1003. <member name="M:System.Security.Principal.WindowsPrincipal.IsInRole(System.Security.Principal.WindowsBuiltInRole)">
  1004. <summary>Determines whether the current principal belongs to the Windows user group with the specified <see cref="T:System.Security.Principal.WindowsBuiltInRole" />.</summary>
  1005. <param name="role">One of the <see cref="T:System.Security.Principal.WindowsBuiltInRole" /> values.</param>
  1006. <returns>
  1007. <see langword="true" /> if the current principal is a member of the specified Windows user group; otherwise, <see langword="false" />.</returns>
  1008. <exception cref="T:System.ArgumentException">
  1009. <paramref name="role" /> is not a valid <see cref="T:System.Security.Principal.WindowsBuiltInRole" /> value.</exception>
  1010. </member>
  1011. <member name="M:System.Security.Principal.WindowsPrincipal.IsInRole(System.String)">
  1012. <summary>Determines whether the current principal belongs to the Windows user group with the specified name.</summary>
  1013. <param name="role">The name of the Windows user group for which to check membership.</param>
  1014. <returns>
  1015. <see langword="true" /> if the current principal is a member of the specified Windows user group; otherwise, <see langword="false" />.</returns>
  1016. </member>
  1017. <member name="P:System.Security.Principal.WindowsPrincipal.UserClaims">
  1018. <summary>Gets all Windows user claims from this principal.</summary>
  1019. <returns>A collection of all Windows user claims from this principal.</returns>
  1020. </member>
  1021. </members>
  1022. </doc>