Merge pull request #409 from Alkarex/patch-1
[mono.git] / mcs / class / Mono.Posix / Documentation / en / Mono.Unix.Native / Passwd.xml
1 <Type Name="Passwd" FullName="Mono.Unix.Native.Passwd">
2   <TypeSignature Language="C#" Value="public sealed class Passwd : IEquatable&lt;Mono.Unix.Native.Passwd&gt;" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Passwd extends System.Object implements class System.IEquatable`1&lt;class Mono.Unix.Native.Passwd&gt;" />
4   <AssemblyInfo>
5     <AssemblyName>Mono.Posix</AssemblyName>
6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
9   </AssemblyInfo>
10   <ThreadingSafetyStatement>
11   All public static members of this type are safe for multithreaded operations. 
12   No instance members are guaranteed to be thread safe.
13   </ThreadingSafetyStatement>
14   <Base>
15     <BaseTypeName>System.Object</BaseTypeName>
16   </Base>
17   <Interfaces>
18     <Interface>
19       <InterfaceName>System.IEquatable&lt;Mono.Unix.Native.Passwd&gt;</InterfaceName>
20     </Interface>
21   </Interfaces>
22   <Docs>
23     <summary>Password database entry.</summary>
24     <remarks>An entry from the password database file described in <c>passwd</c>(5), typically <c>/etc/passwd</c>.</remarks>
25     <altmember cref="M:Mono.Unix.Native.Syscall.getpwent" />
26     <altmember cref="M:Mono.Unix.Native.Syscall.getpwnam" />
27     <altmember cref="M:Mono.Unix.Native.Syscall.getpwuid" />
28     <altmember cref="M:Mono.Unix.Native.Syscall.fgetpwent" />
29   </Docs>
30   <Members>
31     <Member MemberName=".ctor">
32       <MemberSignature Language="C#" Value="public Passwd ();" />
33       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
34       <MemberType>Constructor</MemberType>
35       <AssemblyInfo>
36         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
38         <AssemblyVersion>4.0.0.0</AssemblyVersion>
39       </AssemblyInfo>
40       <Parameters />
41       <Docs>
42         <summary>To be added.</summary>
43         <remarks>To be added.</remarks>
44       </Docs>
45     </Member>
46     <Member MemberName="Equals">
47       <MemberSignature Language="C#" Value="public bool Equals (Mono.Unix.Native.Passwd value);" />
48       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Mono.Unix.Native.Passwd value) cil managed" />
49       <MemberType>Method</MemberType>
50       <AssemblyInfo>
51         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
54       </AssemblyInfo>
55       <ReturnValue>
56         <ReturnType>System.Boolean</ReturnType>
57       </ReturnValue>
58       <Parameters>
59         <Parameter Name="value" Type="Mono.Unix.Native.Passwd" />
60       </Parameters>
61       <Docs>
62         <param name="value">To be added.</param>
63         <summary>To be added.</summary>
64         <returns>To be added.</returns>
65         <remarks>To be added.</remarks>
66       </Docs>
67     </Member>
68     <Member MemberName="Equals">
69       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
70       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
71       <MemberType>Method</MemberType>
72       <AssemblyInfo>
73         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
74         <AssemblyVersion>2.0.0.0</AssemblyVersion>
75         <AssemblyVersion>4.0.0.0</AssemblyVersion>
76       </AssemblyInfo>
77       <ReturnValue>
78         <ReturnType>System.Boolean</ReturnType>
79       </ReturnValue>
80       <Parameters>
81         <Parameter Name="obj" Type="System.Object" />
82       </Parameters>
83       <Docs>
84         <param name="obj">To be added.</param>
85         <summary>To be added.</summary>
86         <returns>To be added.</returns>
87         <remarks>To be added.</remarks>
88       </Docs>
89     </Member>
90     <Member MemberName="GetHashCode">
91       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
92       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
93       <MemberType>Method</MemberType>
94       <AssemblyInfo>
95         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
96         <AssemblyVersion>2.0.0.0</AssemblyVersion>
97         <AssemblyVersion>4.0.0.0</AssemblyVersion>
98       </AssemblyInfo>
99       <ReturnValue>
100         <ReturnType>System.Int32</ReturnType>
101       </ReturnValue>
102       <Parameters />
103       <Docs>
104         <summary>To be added.</summary>
105         <returns>To be added.</returns>
106         <remarks>To be added.</remarks>
107       </Docs>
108     </Member>
109     <Member MemberName="op_Equality">
110       <MemberSignature Language="C#" Value="public static bool op_Equality (Mono.Unix.Native.Passwd lhs, Mono.Unix.Native.Passwd rhs);" />
111       <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(class Mono.Unix.Native.Passwd lhs, class Mono.Unix.Native.Passwd rhs) cil managed" />
112       <MemberType>Method</MemberType>
113       <AssemblyInfo>
114         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
115         <AssemblyVersion>2.0.0.0</AssemblyVersion>
116         <AssemblyVersion>4.0.0.0</AssemblyVersion>
117       </AssemblyInfo>
118       <ReturnValue>
119         <ReturnType>System.Boolean</ReturnType>
120       </ReturnValue>
121       <Parameters>
122         <Parameter Name="lhs" Type="Mono.Unix.Native.Passwd" />
123         <Parameter Name="rhs" Type="Mono.Unix.Native.Passwd" />
124       </Parameters>
125       <Docs>
126         <param name="lhs">To be added.</param>
127         <param name="rhs">To be added.</param>
128         <summary>To be added.</summary>
129         <returns>To be added.</returns>
130         <remarks>To be added.</remarks>
131       </Docs>
132     </Member>
133     <Member MemberName="op_Inequality">
134       <MemberSignature Language="C#" Value="public static bool op_Inequality (Mono.Unix.Native.Passwd lhs, Mono.Unix.Native.Passwd rhs);" />
135       <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(class Mono.Unix.Native.Passwd lhs, class Mono.Unix.Native.Passwd rhs) cil managed" />
136       <MemberType>Method</MemberType>
137       <AssemblyInfo>
138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
140         <AssemblyVersion>4.0.0.0</AssemblyVersion>
141       </AssemblyInfo>
142       <ReturnValue>
143         <ReturnType>System.Boolean</ReturnType>
144       </ReturnValue>
145       <Parameters>
146         <Parameter Name="lhs" Type="Mono.Unix.Native.Passwd" />
147         <Parameter Name="rhs" Type="Mono.Unix.Native.Passwd" />
148       </Parameters>
149       <Docs>
150         <param name="lhs">To be added.</param>
151         <param name="rhs">To be added.</param>
152         <summary>To be added.</summary>
153         <returns>To be added.</returns>
154         <remarks>To be added.</remarks>
155       </Docs>
156     </Member>
157     <Member MemberName="pw_dir">
158       <MemberSignature Language="C#" Value="public string pw_dir;" />
159       <MemberSignature Language="ILAsm" Value=".field public string pw_dir" />
160       <MemberType>Field</MemberType>
161       <AssemblyInfo>
162         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
163         <AssemblyVersion>2.0.0.0</AssemblyVersion>
164         <AssemblyVersion>4.0.0.0</AssemblyVersion>
165       </AssemblyInfo>
166       <ReturnValue>
167         <ReturnType>System.String</ReturnType>
168       </ReturnValue>
169       <Docs>
170         <summary>Home directory.</summary>
171         <remarks>To be added.</remarks>
172       </Docs>
173     </Member>
174     <Member MemberName="pw_gecos">
175       <MemberSignature Language="C#" Value="public string pw_gecos;" />
176       <MemberSignature Language="ILAsm" Value=".field public string pw_gecos" />
177       <MemberType>Field</MemberType>
178       <AssemblyInfo>
179         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
180         <AssemblyVersion>2.0.0.0</AssemblyVersion>
181         <AssemblyVersion>4.0.0.0</AssemblyVersion>
182       </AssemblyInfo>
183       <ReturnValue>
184         <ReturnType>System.String</ReturnType>
185       </ReturnValue>
186       <Docs>
187         <summary>Honeywell login info.</summary>
188         <remarks>To be added.</remarks>
189       </Docs>
190     </Member>
191     <Member MemberName="pw_gid">
192       <MemberSignature Language="C#" Value="public uint pw_gid;" />
193       <MemberSignature Language="ILAsm" Value=".field public unsigned int32 pw_gid" />
194       <MemberType>Field</MemberType>
195       <AssemblyInfo>
196         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
197         <AssemblyVersion>2.0.0.0</AssemblyVersion>
198         <AssemblyVersion>4.0.0.0</AssemblyVersion>
199       </AssemblyInfo>
200       <Attributes>
201         <Attribute>
202           <AttributeName>System.CLSCompliant(false)</AttributeName>
203         </Attribute>
204       </Attributes>
205       <ReturnValue>
206         <ReturnType>System.UInt32</ReturnType>
207       </ReturnValue>
208       <Docs>
209         <summary>User gid.</summary>
210         <remarks>To be added.</remarks>
211       </Docs>
212     </Member>
213     <Member MemberName="pw_name">
214       <MemberSignature Language="C#" Value="public string pw_name;" />
215       <MemberSignature Language="ILAsm" Value=".field public string pw_name" />
216       <MemberType>Field</MemberType>
217       <AssemblyInfo>
218         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
219         <AssemblyVersion>2.0.0.0</AssemblyVersion>
220         <AssemblyVersion>4.0.0.0</AssemblyVersion>
221       </AssemblyInfo>
222       <ReturnValue>
223         <ReturnType>System.String</ReturnType>
224       </ReturnValue>
225       <Docs>
226         <summary>User name.</summary>
227         <remarks>To be added.</remarks>
228       </Docs>
229     </Member>
230     <Member MemberName="pw_passwd">
231       <MemberSignature Language="C#" Value="public string pw_passwd;" />
232       <MemberSignature Language="ILAsm" Value=".field public string pw_passwd" />
233       <MemberType>Field</MemberType>
234       <AssemblyInfo>
235         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
236         <AssemblyVersion>2.0.0.0</AssemblyVersion>
237         <AssemblyVersion>4.0.0.0</AssemblyVersion>
238       </AssemblyInfo>
239       <ReturnValue>
240         <ReturnType>System.String</ReturnType>
241       </ReturnValue>
242       <Docs>
243         <summary>Encrypted password.</summary>
244         <remarks>To be added.</remarks>
245       </Docs>
246     </Member>
247     <Member MemberName="pw_shell">
248       <MemberSignature Language="C#" Value="public string pw_shell;" />
249       <MemberSignature Language="ILAsm" Value=".field public string pw_shell" />
250       <MemberType>Field</MemberType>
251       <AssemblyInfo>
252         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
253         <AssemblyVersion>2.0.0.0</AssemblyVersion>
254         <AssemblyVersion>4.0.0.0</AssemblyVersion>
255       </AssemblyInfo>
256       <ReturnValue>
257         <ReturnType>System.String</ReturnType>
258       </ReturnValue>
259       <Docs>
260         <summary>Default shell.</summary>
261         <remarks>To be added.</remarks>
262       </Docs>
263     </Member>
264     <Member MemberName="pw_uid">
265       <MemberSignature Language="C#" Value="public uint pw_uid;" />
266       <MemberSignature Language="ILAsm" Value=".field public unsigned int32 pw_uid" />
267       <MemberType>Field</MemberType>
268       <AssemblyInfo>
269         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
270         <AssemblyVersion>2.0.0.0</AssemblyVersion>
271         <AssemblyVersion>4.0.0.0</AssemblyVersion>
272       </AssemblyInfo>
273       <Attributes>
274         <Attribute>
275           <AttributeName>System.CLSCompliant(false)</AttributeName>
276         </Attribute>
277       </Attributes>
278       <ReturnValue>
279         <ReturnType>System.UInt32</ReturnType>
280       </ReturnValue>
281       <Docs>
282         <summary>User uid.</summary>
283         <remarks>To be added.</remarks>
284       </Docs>
285     </Member>
286     <Member MemberName="ToString">
287       <MemberSignature Language="C#" Value="public override string ToString ();" />
288       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
289       <MemberType>Method</MemberType>
290       <AssemblyInfo>
291         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
292         <AssemblyVersion>2.0.0.0</AssemblyVersion>
293         <AssemblyVersion>4.0.0.0</AssemblyVersion>
294       </AssemblyInfo>
295       <ReturnValue>
296         <ReturnType>System.String</ReturnType>
297       </ReturnValue>
298       <Parameters />
299       <Docs>
300         <summary>To be added.</summary>
301         <returns>To be added.</returns>
302         <remarks>To be added.</remarks>
303       </Docs>
304     </Member>
305   </Members>
306 </Type>