mcs/class/Mono.Posix/Documentation/en/Mono.Unix/FileSpecialAttributes.xml

   1 <Type Name="FileSpecialAttributes" FullName="Mono.Unix.FileSpecialAttributes">
   2   <TypeSignature Language="C#" Value="public enum FileSpecialAttributes" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed FileSpecialAttributes extends System.Enum" />
   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   <Base>
  11     <BaseTypeName>System.Enum</BaseTypeName>
  12   </Base>
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.Flags</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <summary>Unix file special attributes.</summary>
  20     <remarks>
  21       Unix file special attributes are a part of the Unix file system entry
  22       (see <see cref="P:Mono.Unix.UnixFileSystemInfo.FileSpecialAttributes" />)
  23       and control filesystem- and operating system-specific behavior.
  24     </remarks>
  25     <altmember cref="P:Mono.Unix.UnixFileSystemInfo.FileSpecialAttributes" />
  26     <altmember cref="P:Mono.Unix.UnixStream.FileSpecialAttributes" />
  27   </Docs>
  28   <Members>
  29     <Member MemberName="SetGroupId">
  30       <MemberSignature Language="C#" Value="SetGroupId" />
  31       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileSpecialAttributes SetGroupId = int32(1024)" />
  32       <MemberType>Field</MemberType>
  33       <AssemblyInfo>
  34         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  35         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  36         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  37       </AssemblyInfo>
  38       <ReturnValue>
  39         <ReturnType>Mono.Unix.FileSpecialAttributes</ReturnType>
  40       </ReturnValue>
  41       <Docs>
  42         <summary>When the file is executed (either as a new process or via
  43           <see cref="M:Mono.Unix.Native.Syscall.exec" />), set the effective
  44           group-id of the process
  45           (<see cref="P:Mono.Unix.UnixEnvironment.EffectiveGroupId" />)
  46           to the owner group of the file
  47           (<see cref="P:Mono.Unix.UnixFileSystemInfo.OwnerGroupId" />).
  48         </summary>
  49       </Docs>
  50     </Member>
  51     <Member MemberName="SetUserId">
  52       <MemberSignature Language="C#" Value="SetUserId" />
  53       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileSpecialAttributes SetUserId = int32(2048)" />
  54       <MemberType>Field</MemberType>
  55       <AssemblyInfo>
  56         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  57         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  58         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  59       </AssemblyInfo>
  60       <ReturnValue>
  61         <ReturnType>Mono.Unix.FileSpecialAttributes</ReturnType>
  62       </ReturnValue>
  63       <Docs>
  64         <summary>When the file is executed (either as a new process or via
  65           <see cref="M:Mono.Unix.Native.Syscall.exec" />), set the effective
  66           user-id of the process
  67           (<see cref="P:Mono.Unix.UnixEnvironment.EffectiveUserId" />)
  68           to the owner of the file
  69           (<see cref="P:Mono.Unix.UnixFileSystemInfo.OwnerUserId" />).
  70         </summary>
  71       </Docs>
  72     </Member>
  73     <Member MemberName="Sticky">
  74       <MemberSignature Language="C#" Value="Sticky" />
  75       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileSpecialAttributes Sticky = int32(512)" />
  76       <MemberType>Field</MemberType>
  77       <AssemblyInfo>
  78         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  79         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  80         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  81       </AssemblyInfo>
  82       <ReturnValue>
  83         <ReturnType>Mono.Unix.FileSpecialAttributes</ReturnType>
  84       </ReturnValue>
  85       <Docs>
  86         <summary>
  87           <para>Sticky bit.</para>
  88           <para>
  89           If set on a file, this is currently meaningless, but in years past it
  90           requested that the operating system keep the program's code in
  91           memory, thus speeding up further program invocations.  This is no
  92           longer necessary with virtual memory.
  93         </para>
  94           <para>
  95           If set on a directory, a file in the directory can be removed
  96           or renamed only if the user has write permission for the directory,
  97           and either:
  98         </para>
  99           <list type="bullet">
 100             <item>
 101               <term>owns the file</term>
 102             </item>
 103             <item>
 104               <term>owns the directory, or</term>
 105             </item>
 106             <item>
 107               <term>is the superuser (<c>root</c>).</term>
 108             </item>
 109           </list>
 110         </summary>
 111       </Docs>
 112     </Member>
 113   </Members>
 114 </Type>