GetEffectivePermission method of the CIM_LogicalFile class

Article
01/06/2021

The GetEffectivePermission method determines whether the caller has the aggregated permissions on the CIM_LogicalFile object, and the share on which the file or directory resides, as specified by the Permissions argument.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

boolean GetEffectivePermission(
  [in] uint32 Permissions
);

Parameters

Permissions [in]: List of permissions that the user can inquire about.
FILE_READ_DATA (file) or FILE_LIST_DIRECTORY (directory) (1): Grants the right to read data from the file. For a directory, this value grants the right to list the contents of the directory.
FILE_WRITE_DATA (file) or FILE_ADD_FILE (directory) (2): Grants the right to write data to the file. For a directory, this value grants the right to create a file in the directory.
FILE_APPEND_DATA (file) or FILE_ADD_SUBDIRECTORY (directory) (4): Grants the right to append data to the file. For a directory, this value grants the right to create a subdirectory.
FILE_READ_EA (8): Grants the right to read extended attributes.
FILE_WRITE_EA (16): Grants the right to write extended attributes.
FILE_EXECUTE (file) or FILE_TRAVERSE (directory) (32): Grants the right to execute a file. For a directory, the directory can be traversed.
FILE_DELETE_CHILD (directory) (64): Grants the right to delete a directory and all the files it contains, even if the files are read-only.
FILE_READ_ATTRIBUTES (128): Grants the right to read file attributes.
FILE_WRITE_ATTRIBUTES (256): Grants the right to change file attributes.
DELETE (65536): Grants delete access.
READ_CONTROL (131072): Grants read access to the security descriptor and owner.
WRITE_DAC (262144): Grants write access to the discretionary ACL.
WRITE_OWNER (524288): Assigns the write owner.
SYNCHRONIZE (1048576): Synchronizes access and allows a process to wait for an object to enter the signaled state.

Return value

Returns True if the call has the necessary permission; otherwise, it returns false.

Remarks

This method is currently not implemented by WMI. To use this method, you must implement it in your own provider.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
Header	Aclui.h
MOF	CIMWin32.mof
DLL	CIMWin32.dll