ScheduleAutoChk method of the Win32_LogicalDisk class

Article
01/06/2021

The ScheduleAutoChk class method schedules Autochk to be run on the disk drive represented by the Win32_LogicalDisk at the next reboot if the dirty bit is set.

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

Syntax

uint32 ScheduleAutoChk(
  [in] string LogicalDisk[]
);

Parameters

LogicalDisk [in]: Specifies the list of drives to schedule for Autochk at the next reboot. The string syntax consists of the drive letter followed by a colon for the logical disk, for example: "C:"

Note

Always check the validity of the drive letters in the LogicalDisk array when the data comes from an unknown source, or a source that you do not trust.

Return value

Returns a value of 0 (zero) if successful, and some other value if any other error occurs. Values are listed in the following list. For additional error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

No Error (0)
Error - Remote Drive (1)
Error - Removable Drive (2)
Error - Drive Not Root Directory (3)
Error - Unknown Drive (4)

Remarks

This method is only applicable to those instances of logical disk that represent a physical disk in the machine. This method is not applicable to mapped logical drives.

Examples

The following VBScript and PowerShell samples schedule Autochk.exe to run against drive C the next time the computer reboots.

strComputer = "." 
Set objWMIService = GetObject("winmgmts:" _ 
    & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2") 
 
Set objDisk = objWMIService.Get("Win32_LogicalDisk") 
 
errReturn = objDisk.ScheduleAutoChk(Array("C:"))


Invoke-WmiMethod -path win32_logicaldisk -Name ScheduleAutoChk -ArgumentList @(&quot;C:&quot;)

Requirements

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