TakeOwnerShipEx method of the CIM_Directory class

Article
01/06/2021

The TakeOwnerShipEx method obtains ownership of the logical directory entry file specified in the object path. This method is an extended version of the TakeOwnerShip method and is inherited from CIM_LogicalFile. If the logical file is a directory, then this method acts recursively, taking ownership of all of the files and sub-directories that the directory contains.

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

uint32 TakeOwnerShipEx(
  [out] string REF StopFileName,
  [in]  string     StartFileName,
  [in]  boolean    Recursive
);

Parameters

StopFileName [out]: String that represents the name of the file (or directory) where the method failed. This parameter is null if the method succeeds.
StartFileName [in]: String that represents the child file (or directory) to use as a starting point for this method. Typically, this parameter is the StopFileName parameter that specifies the file or directory at which an error occurred from the previous method call. If this parameter is null, the operation is performed on the file (or directory) specified in the ExecMethod call.
Recursive [in]: If True, the method is applied recursively to files and directories within the directory specified by the CIM_Directory instance. For file instances, this parameter is ignored.

Return value

Returns a value of 0 on success, and any other number to indicate an error.

Success.

Access denied.

Unspecified failure.

Invalid object.

Object already exists.

File system not NTFS.

The platform is not Windows.

Drive not the same.

Directory not empty.

Sharing violation.

Invalid start file.

Privilege not held.

Invalid parameter.

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.

Examples

The following Visual Basic Script code calls the TakeOwnerShipEx method to take ownership of the C:\temp folder.

strComputer = "." 
Set objWMIService = GetObject( _
    "winmgmts:\\" & strComputer & "\root\CIMV2") 
' Obtain the definition of the class.
Set objShare = objWMIService.Get("Win32_Directory")
' Obtain an InParameters object specific
' to the method.
Set objInParam = objShare.Methods_("TakeOwnerShipEx"). _
    inParameters.SpawnInstance_()

' Add the input parameters.
objInParam.Properties_.Item("Recursive") =  true

' Execute the method and obtain the return status.
' The OutParameters object in objOutParams
' is created by the provider.
Set objOutParams = objWMIService.ExecMethod( _
    "Win32_Directory.Name='C:\Temp'", "TakeOwnerShipEx", objInParam)
wscript.echo objOutParams.ReturnValue

Requirements

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