SetupRemoveFromDiskSpaceListA function (setupapi.h)
[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]
The SetupRemoveFromDiskSpaceList function removes a file delete or copy operation from a disk-space list.
Syntax
WINSETUPAPI BOOL SetupRemoveFromDiskSpaceListA(
[in] HDSKSPC DiskSpace,
[in] PCSTR TargetFilespec,
[in] UINT Operation,
[in] PVOID Reserved1,
[in] UINT Reserved2
);
Parameters
[in] DiskSpace
Handle to a disk-space list.
[in] TargetFilespec
Pointer to a null-terminated string that specifies the file name of the file to remove from the disk-space list. This is typically a fully qualified path. Otherwise, the path must be relative to the current directory.
[in] Operation
File operation to be removed from the list. This parameter can be one of the following values.
| Value | Meaning |
|---|---|
|
A file delete operation. |
|
A file copy operation. |
[in] Reserved1
Must be zero.
[in] Reserved2
Must be zero.
Return value
If the file was not in the list, the SetupRemoveFromDiskSpaceList function returns a nonzero value and GetLastError returns ERROR_INVALID_DRIVE or ERROR_INVALID_NAME. If the file was in the list then upon success the routine returns a nonzero value and GetLastError returns NO_ERROR.
If the routine fails for some other reason, it returns zero and GetLastError returns extended error information.
Remarks
Note
The setupapi.h header defines SetupRemoveFromDiskSpaceList as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | setupapi.h |
| Library | Setupapi.lib |
| DLL | Setupapi.dll |