Win32 API

https://learn.microsoft.com/en-us/windows/win32/api/
Admin
The Win32 API is a programming reference for building desktop Windows applications, providing access...
Tokens:12,708,677
Snippets:129,540
Trust Score:10
Update:5 days ago
Show doc for...
Tokens:
Raw
### SetupDiBuildClassInfoListExW

Source: https://learn.microsoft.com/en-us/windows/win32/api/_devinst

Returns a list of setup class GUIDs that includes every class installed on the local system or a remote system. (Unicode)

```APIDOC
## SetupDiBuildClassInfoListExW

### Description
The SetupDiBuildClassInfoListEx function returns a list of setup class GUIDs that includes every class installed on the local system or a remote system. (Unicode)

### Method
Function

### Endpoint
SetupDiBuildClassInfoListExW

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### Example 3: List present network adapter devices

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsw

Builds a list of all present devices from the network adapter device setup class. Uses the GUID_DEVCLASS_NET class GUID and the DIGCF_PRESENT flag.

```cpp
Handle = SetupDiGetClassDevs(&GUID_DEVCLASS_NET, NULL, NULL, DIGCF_PRESENT);

```

--------------------------------

### SetupDiGetClassDescriptionExW

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdescriptionexw

Retrieves the description of a setup class installed on a local or remote computer.

```APIDOC
## [WINSETUPAPI] SetupDiGetClassDescriptionExW

### Description
Retrieves the description of a setup class installed on a local or remote computer.

### Method
WINSETUPAPI BOOL

### Signature
```c
WINSETUPAPI BOOL SetupDiGetClassDescriptionExW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCWSTR     MachineName,
                  PVOID      Reserved
);
```

### Parameters
- **ClassGuid** (const GUID*) - Required - A pointer to the GUID for the setup class whose description is to be retrieved.
- **ClassDescription** (PWSTR) - Required - A pointer to a character buffer that receives the class description.
- **ClassDescriptionSize** (DWORD) - Required - The size, in characters, of the buffer pointed to by ClassDescription. The maximum length of a NULL-terminated class description is LINE_LEN.
- **RequiredSize** (PDWORD) - Optional - A pointer to a DWORD-typed variable that receives the size, in characters, required to store the requested NULL-terminated class description. Can be NULL.
- **MachineName** (PCWSTR) - Optional - A pointer to a NULL-terminated string that supplies the name of a remote computer on which the setup class resides. Can be NULL for local computer.
- **Reserved** (PVOID) - Required - Reserved for system use. Must be set to NULL.

### Return Value
Returns TRUE if successful. Otherwise, returns FALSE and the logged error can be retrieved with GetLastError.

### Remarks
If there is a friendly name in the registry key for the class, this routine returns the friendly name. Otherwise, it returns the class name. This function does not enforce a restriction on the length of the class description it can return; it returns the required size even if greater than LINE_LEN. However, LINE_LEN is the maximum length of a valid NULL-terminated class description.

### Requirements
- **Minimum supported client**: Available in Microsoft Windows 2000 and later versions of Windows.
- **Target Platform**: Desktop
- **Header**: setupapi.h (include Setupapi.h)
- **Library**: Setupapi.lib

### See Also
- SetupDiBuildClassInfoList
- SetupDiBuildClassInfoListEx
- SetupDiGetDeviceInfoListDetail
- SetupDiGetINFClass
```

--------------------------------

### Example 1: Build a list of all devices in the system

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsa

Calls SetupDiGetClassDevs with NULL parameters and DIGCF_ALLCLASSES to retrieve all devices, including those not currently present.

```cpp
Handle = SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES);

```

--------------------------------

### EnumerateTraceGuidsEx example: enumerate registered providers and get provider info

Source: https://learn.microsoft.com/en-us/windows/win32/api/evntrace/nf-evntrace-enumeratetraceguidsex

This example shows how to call EnumerateTraceGuidsEx to get the list of registered provider GUIDs and then retrieve detailed information about each provider. It handles the ERROR_INSUFFICIENT_BUFFER error by reallocating the buffer and looping until the call succeeds. The example prints the provider GUID, the PID of the registering process, registration flags, and enabled sessions.

```C++
#include <windows.h>
#include <stdio.h>
#include <evntcons.h>

DWORD GetProviderInfo(GUID ProviderGuid, PTRACE_GUID_INFO& pInfo);

int wmain(void)
{
    ULONG status = ERROR_SUCCESS;
    GUID* pTemp = NULL;
    GUID* pGuids = NULL;
    DWORD GuidListSize = 0;
    DWORD GuidCount = 0;
    DWORD RequiredListSize = 0;
    WCHAR ProviderGuid[50];
    PTRACE_GUID_INFO pInfo = NULL;
    PTRACE_PROVIDER_INSTANCE_INFO pInstance = NULL;
    PTRACE_ENABLE_INFO pEnable = NULL;


    // Get the required buffer size for the query.

    status = EnumerateTraceGuidsEx(TraceGuidQueryList, NULL, 0, pGuids, GuidListSize, &RequiredListSize);

    // The number of registered providers could change between the
    // time you called to get the buffer size and the time you called
    // to get the actual data, so call EnumerateTraceGuidsEx in a loop
    // until you no longer get ERROR_INSUFFICIENT_BUFFER.

    while (ERROR_INSUFFICIENT_BUFFER == status)
    {
        pTemp = (GUID*)realloc(pGuids, RequiredListSize);

        if (NULL == pTemp)
        {
            printf("Error allocating memory for list of provider GUIDs.\n");
            goto cleanup;
        }

        pGuids = pTemp;
        pTemp = NULL;

        GuidListSize = RequiredListSize;

        ZeroMemory(pGuids, GuidListSize);

        status = EnumerateTraceGuidsEx(TraceGuidQueryList, NULL, 0, pGuids, GuidListSize, &RequiredListSize);
    }

    if (ERROR_SUCCESS == status)
    {
        GuidCount = GuidListSize / sizeof(GUID);

        // For each registered provider on the computer, get information
        // about how it was registered. If a session enabled the
        // provider, get information on how the session enabled the provider.

        for (USHORT i = 0; i < GuidCount; i++)
        {
            StringFromGUID2(pGuids[i], ProviderGuid, sizeof(ProviderGuid));

            printf("Provider: %ls\n", ProviderGuid);

            status = GetProviderInfo(pGuids[i], pInfo);

            if (ERROR_SUCCESS == status)
            {
                pInstance = (PTRACE_PROVIDER_INSTANCE_INFO)((PBYTE)pInfo + sizeof(TRACE_GUID_INFO));

                if (pInfo->InstanceCount > 1)
                {
                    printf("There are %d providers that use the same GUID.\n", pInfo->InstanceCount);
                }

                for (DWORD j = 0; j < pInfo->InstanceCount; j++)
                {
                    printf("\tThe PID of the process that registered the provider is %lu.\n", pInstance->Pid);

                    if ((pInstance->Flags & TRACE_PROVIDER_FLAG_PRE_ENABLE) == TRACE_PROVIDER_FLAG_PRE_ENABLE)
                    {
                        printf("\tThe provider is not registered; however, one or more sessions have enabled the provider.\n");
                    }
                    else
                    {
                        if ((pInstance->Flags & TRACE_PROVIDER_FLAG_LEGACY) == TRACE_PROVIDER_FLAG_LEGACY)
                        {
                            printf("\tThe provider used RegisterTraceGuids to register itself.\n");
                        }
                        else
                        {
                            printf("\tThe provider used EventRegister to register itself.\n");
                        }
                    }

                    if (pInstance->EnableCount > 0)
                    {
                        printf("\tThe provider is enabled to the following sessions.\n");

                        pEnable = (PTRACE_ENABLE_INFO)((PBYTE)pInstance + sizeof(TRACE_PROVIDER_INSTANCE_INFO));

```

--------------------------------

### SetupDiGetClassDevs - Build list of present devices

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsa

Example 2: Build a list of all devices that are present in the system.

```APIDOC
## SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES | DIGCF_PRESENT)

### Description
Builds a list of all devices that are present in the system.

### Parameters
- **ClassGuid** (NULL) - Optional - Must be NULL to include all classes.
- **Enumerator** (NULL) - Optional - Must be NULL to include all enumerators.
- **hwndParent** (NULL) - Optional - Must be NULL for no parent window.
- **Flags** (DIGCF_ALLCLASSES | DIGCF_PRESENT) - Required - Includes all classes and only present devices.

### Code Example
```
Handle = SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES | DIGCF_PRESENT);
```
```

--------------------------------

### SetupDiBuildClassInfoList

Source: https://learn.microsoft.com/en-us/windows/win32/api/_devinst

Returns a list of setup class GUIDs that identify the classes that are installed on a local computer.

```APIDOC
## SetupDiBuildClassInfoList

### Description
The SetupDiBuildClassInfoList function returns a list of setup class GUIDs that identify the classes that are installed on a local computer.

### Method
Function

### Endpoint
SetupDiBuildClassInfoList

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### SetupDiInstallDevice

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdiinstalldevice

Documentation for the SetupDiInstallDevice function, including syntax, parameters, return value, remarks, and requirements.

```APIDOC
## SetupDiInstallDevice

### Description
Installs a driver from the INF file for a device. This function performs many tasks for device installation, including creating a driver key, processing INF sections, copying files, loading drivers, and starting the device.

### Syntax
```c
WINSETUPAPI BOOL SetupDiInstallDevice(
  _In_ HDEVINFO         DeviceInfoSet,
  _In_ PSP_DEVINFO_DATA DeviceInfoData
);
```

### Parameters
- **DeviceInfoSet** (HDEVINFO) - Required - A handle to the device information set that contains the device to install.
- **DeviceInfoData** (PSP_DEVINFO_DATA) - Required - A pointer to an SP_DEVINFO_DATA structure that specifies the device in the device information set.

### Return Value
Returns **TRUE** if successful. Otherwise, returns **FALSE** and the logged error can be retrieved with a call to GetLastError.

### Remarks
Installs a driver from the INF file. The driver is a "driver node" and includes services, driver files, co-installers, property-page providers, and control-panel applets. Also registers required device interfaces. A successful installation includes creating a driver key, processing INF sections, copying the INF file, performing file operations, loading drivers, calling AddDevice routines, and starting the device. Windows does not start the device if DI_NEEDRESTART, DI_NEEDREBOOT, or DI_DONOTCALLCONFIGMG is set. Only a class installer should call this function, and only when handling a DIF_INSTALLDEVICE request. The caller must be a member of the Administrators group.

### Requirements
- Minimum supported client: Windows 2000 Professional
- Minimum supported server: Windows 2000 Server
- Header: SetupAPI.h
- Library: SetupAPI.lib
- DLL: SetupAPI.dll
- Unicode: Not supported

### See Also
- DIF_INSTALLDEVICE
- GetLastError
- SP_DEVINFO_DATA
- SP_DEVINSTALL_PARAMS
- SetupDiCallClassInstaller
- SetupDiSetDeviceInstallParams
```

--------------------------------

### SetupInstallFileW

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. (Unicode)

```APIDOC
## SetupInstallFileW

### Description
Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. (Unicode)

### Method
Function

### Endpoint
SetupInstallFileW

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### SetupDiBuildClassInfoListExA

Source: https://learn.microsoft.com/en-us/windows/win32/api/_devinst

Returns a list of setup class GUIDs that includes every class installed on the local system or a remote system. (ANSI)

```APIDOC
## SetupDiBuildClassInfoListExA

### Description
The SetupDiBuildClassInfoListEx function returns a list of setup class GUIDs that includes every class installed on the local system or a remote system. (ANSI)

### Method
Function

### Endpoint
SetupDiBuildClassInfoListExA

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### SetupOpenFileQueue

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Creates a setup file queue.

```APIDOC
## SetupOpenFileQueue

### Description
Creates a setup file queue.

### Method
Function

### Endpoint
SetupOpenFileQueue

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### Example: calling EnumerateTraceGuids

Source: https://learn.microsoft.com/en-us/windows/win32/api/evntrace/nf-evntrace-enumeratetraceguids

Example showing how to call EnumerateTraceGuids. It first calls with a small buffer to get the actual count, then retries with a larger buffer if ERROR_MORE_DATA is returned. It prints the GUID and enabled status for each provider.

```cpp
#include <windows.h>
#include <evntrace.h>
#include <vector>
#include <stdio.h>

int
wmain()
{
    ULONG status = 0;

    try
    {
        ULONG guidCount;
        std::vector<TRACE_GUID_PROPERTIES> guidPropValues;
        std::vector<TRACE_GUID_PROPERTIES*> guidPropPointers;

        // First call is just to get the actual count, so allocate a small buffer.
        guidCount = 1;

        // May need to retry multiple times since new providers could be added
        // between calls.
        for (;;)
        {
            ULONG const allocated = guidCount;
            guidPropValues.resize(allocated);
            guidPropPointers.resize(allocated);

            // Initialize the pointers to point at the values.
            for (ULONG i = 0; i != allocated; i += 1)
            {
                guidPropPointers[i] = &guidPropValues[i];
            }

            guidCount = 0;
            status = EnumerateTraceGuids(guidPropPointers.data(), allocated, &guidCount);
            if (status != ERROR_MORE_DATA)
            {
                guidPropValues.resize(guidCount);
                break;
            }

        }

        if (status != ERROR_SUCCESS)
        {
            printf("EnumerateTraceGuids error: %u\n", status);
        }
        else
        {
            printf("GuidCount = %lu\n", guidCount);
            for (auto const& v : guidPropValues)
            {
                printf("%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x - %hs\n",
                    v.Guid.Data1, v.Guid.Data2, v.Guid.Data3,
                    v.Guid.Data4[0], v.Guid.Data4[1],
                    v.Guid.Data4[2], v.Guid.Data4[3], v.Guid.Data4[4],
                    v.Guid.Data4[5], v.Guid.Data4[6], v.Guid.Data4[7],
                    v.IsEnable ? "Enabled" : "Disabled");
            }
        }
    }
    catch (std::bad_alloc const&)
    {
        printf("Out of memory!\n");
        status = ERROR_OUTOFMEMORY;
    }

    return status;
}
```

--------------------------------

### SetupInstallFile

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi

Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. Available in ANSI and Unicode versions.

```APIDOC
## SetupInstallFile

### Description
Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. (ANSI and Unicode versions)

### Syntax
```cpp
BOOL SetupInstallFile(
  HINF InfHandle,
  PINFCONTEXT InfContext,
  PCTSTR SourceFile,
  PCTSTR SourcePathRoot,
  PCTSTR DestinationName,
  DWORD CopyStyle,
  PSP_FILE_CALLBACK CopyMsgHandler,
  PVOID Context
);
```

### Parameters
- **InfHandle** (HINF) - Required - Handle to the INF file. Can be NULL if InfContext is provided.
- **InfContext** (PINFCONTEXT) - Optional - Pointer to the context for a line in an INF file. Can be NULL.
- **SourceFile** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the source file name. Can be NULL.
- **SourcePathRoot** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the root path of the source file. Can be NULL.
- **DestinationName** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the destination file name. Can be NULL.
- **CopyStyle** (DWORD) - Required - Flags that control the copy operation. Possible values include SP_COPY_DELETESOURCE, SP_COPY_REPLACE, and SP_COPY_NEWER.
- **CopyMsgHandler** (PSP_FILE_CALLBACK) - Optional - Pointer to a callback function. Can be NULL.
- **Context** (PVOID) - Optional - Pointer to a context for the callback function. Can be NULL.

### Return Value
Returns TRUE if successful, otherwise FALSE. To get extended error information, call GetLastError.

```

--------------------------------

### Example: CreateSessionManager

Source: https://learn.microsoft.com/en-us/windows/win32/api/audiopolicy/nn-audiopolicy-iaudiosessionmanager2

Example code showing how to get a reference to the IAudioSessionManager2 interface of the audio device.

```APIDOC
## Example: CreateSessionManager

### Description
Demonstrates how to obtain a reference to the IAudioSessionManager2 interface of the default audio device.

### Code (C++)
```cpp
HRESULT CreateSessionManager(IAudioSessionManager2** ppSessionManager)
{
 
    HRESULT hr = S_OK;
    
    IMMDevice* pDevice = NULL;
    IMMDeviceEnumerator* pEnumerator = NULL;
    IAudioSessionManager2* pSessionManager = NULL;


    // Create the device enumerator.
    CHECK_HR( hr = CoCreateInstance(
        __uuidof(MMDeviceEnumerator), 
        NULL, CLSCTX_ALL, 
        __uuidof(IMMDeviceEnumerator), 
        (void**)&pEnumerator));

    // Get the default audio device.
    CHECK_HR( hr = pEnumerator->GetDefaultAudioEndpoint(
                    eRender, eConsole, &pDevice));

    // Get the session manager.
    CHECK_HR( hr = pDevice->Activate(
        __uuidof(IAudioSessionManager2), CLSCTX_ALL,
        NULL, (void**)&pSessionManager));

    // Return the pointer to the caller.
    *(ppSessionManager) = pSessionManager;
    (*ppSessionManager)->AddRef();

done:

    // Clean up.
    SAFE_RELEASE(pSessionManager);
    SAFE_RELEASE(pEnumerator);
    SAFE_RELEASE(pDevice);

    return hr;
}
```

```

--------------------------------

### SetupDiGetClassDevs - Build list of all devices

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsa

Example 1: Build a list of all devices in the system, including devices that are not currently present.

```APIDOC
## SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES)

### Description
Builds a list of all devices in the system, including devices that are not currently present.

### Parameters
- **ClassGuid** (NULL) - Optional - Must be NULL to include all classes.
- **Enumerator** (NULL) - Optional - Must be NULL to include all enumerators.
- **hwndParent** (NULL) - Optional - Must be NULL for no parent window.
- **Flags** (DIGCF_ALLCLASSES) - Required - Specifies that all device classes are included.

### Code Example
```
Handle = SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES);
```
```

--------------------------------

### Pen::GetDashOffset

Source: https://learn.microsoft.com/en-us/windows/win32/api/_gdiplus

Gets the distance from the start of the line to the start of the first space in a dashed line.

```APIDOC
## Pen::GetDashOffset

### Description
Gets the distance from the start of the line to the start of the first space in a dashed line.

### Method
GetDashOffset

### Parameters
None.

### Return Value
The distance from the start of the line to the start of the first space in a dashed line.

```

--------------------------------

### SetupDiInstallDevice

Source: https://learn.microsoft.com/en-us/windows/win32/api/_devinst

Default handler for the DIF_INSTALLDEVICE installation request.

```APIDOC
## SetupDiInstallDevice

### Description
Default handler for the DIF_INSTALLDEVICE installation request.

### Function
SetupDiInstallDevice
```

--------------------------------

### SetupDiGetClassDevs - Build list of present network adapter devices

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsa

Example 3: Build a list of all devices that are present in the system that are from the network adapter device setup class.

```APIDOC
## SetupDiGetClassDevs(&GUID_DEVCLASS_NET, NULL, NULL, DIGCF_PRESENT)

### Description
Builds a list of all devices that are present in the system that are from the network adapter device setup class.

### Parameters
- **ClassGuid** (&GUID_DEVCLASS_NET) - Required - Specifies the network adapter device setup class.
- **Enumerator** (NULL) - Optional - Must be NULL to include all enumerators.
- **hwndParent** (NULL) - Optional - Must be NULL for no parent window.
- **Flags** (DIGCF_PRESENT) - Required - Only include present devices.

### Code Example
```
Handle = SetupDiGetClassDevs(&GUID_DEVCLASS_NET, NULL, NULL, DIGCF_PRESENT);
```
```

--------------------------------

### Example: Get region data from a path

Source: https://learn.microsoft.com/en-us/windows/win32/api/gdiplusheaders/nf-gdiplusheaders-region-getdatasize

Example that creates a region from a path and then gets the data that describes the region. It uses GetDataSize to determine the buffer size, allocates the buffer, and calls GetData to fill it.

```cpp
VOID Example_GetData(HDC)
{
   Point points[] = 
      Point(110, 20),
      Point(120, 30),
      Point(100, 60),
      Point(120, 70),
      Point(150, 60),
      Point(140, 10)};

   GraphicsPath path;
   path.AddClosedCurve(points, 6);

   // Create a region from a path.
   Region pathRegion(&path); 

   // Get the region data.
   UINT bufferSize = 0;
   UINT sizeFilled = 0;
   BYTE* pData = NULL;

   bufferSize = pathRegion.GetDataSize();
   pData = (BYTE*)malloc(bufferSize*sizeof(BYTE));
   pathRegion.GetData(pData, bufferSize, &sizeFilled);
}
```

--------------------------------

### Example: Get pixel color and fill a rectangle

Source: https://learn.microsoft.com/en-us/windows/win32/api/gdiplusheaders/nf-gdiplusheaders-bitmap-getpixel

C++ example that creates a Bitmap from a JPEG file, calls Bitmap::GetPixel to get the color of a pixel at (25, 25), and fills a rectangle with that color.

```cpp
VOID Example_GetPixel(HDC hdc)

{

   Graphics graphics(hdc);

   // Create a Bitmap object from a JPEG file.
   Bitmap myBitmap(L"Climber.jpg");

   // Get the value of a pixel from myBitmap.
   Color pixelColor;
   myBitmap.GetPixel(25, 25, &pixelColor);

   // Fill a rectangle with the pixel color.
   SolidBrush brush(pixelColor);
   graphics.FillRectangle(&brush, Rect(0, 0, 100, 100));
}
```

--------------------------------

### Example 5: List devices with unknown setup class

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsw

Builds a list of all present devices that do not belong to any known device setup class (Windows Vista and later). You cannot set ClassGuid to GUID_DEVCLASS_UNKNOWN; instead, enumerate all devices and use SetupDiGetDevicePropertyW with DEVPKEY_Device_Class to detect devices where the property is not found (ERROR_NOT_FOUND).

```cpp
HDEVINFO DeviceInfoSet = SetupDiGetClassDevsW(
    NULL,
    NULL,
    NULL,
    DIGCF_ALLCLASSES | DIGCF_PRESENT);

SP_DEVINFO_DATA DeviceInfoData;
ZeroMemory(&DeviceInfoData, sizeof(SP_DEVINFO_DATA));
DeviceInfoData.cbSize = sizeof(SP_DEVINFO_DATA);
DWORD DeviceIndex = 0;
DEVPROPTYPE PropType;

GUID     DevGuid;
DWORD Size;

while (SetupDiEnumDeviceInfo(
    DeviceInfoSet,
    DeviceIndex,
    &DeviceInfoData)) {
    DeviceIndex++;

    if (!SetupDiGetDevicePropertyW(
        DeviceInfoSet,
        &DeviceInfoData,
        &DEVPKEY_Device_Class,
        &PropType,
        (PBYTE)&DevGuid,
        sizeof(GUID),
        &Size,
        0) || PropType != DEVPROP_TYPE_GUID) {

        DWORD Error = GetLastError();

        if (Error == ERROR_NOT_FOUND) {
            //
            // This device has an unknown device setup class.
            //

        }
    }
}

if (DeviceInfoSet) {
    SetupDiDestroyDeviceInfoList(DeviceInfoSet);
}

return 0;

```

--------------------------------

### SetupInstallFileExW

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the filename and path information. (Unicode)

```APIDOC
## SetupInstallFileExW

### Description
Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the filename and path information. (Unicode)

### Method
Function

### Endpoint
SetupInstallFileExW

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### IMFTimedTextCue::GetStartTime

Source: https://learn.microsoft.com/en-us/windows/win32/api/mfmediaengine/nf-mfmediaengine-imftimedtextcue-getstarttime

Gets the start time of the cue in the track. Returns a double representing the start time.

```APIDOC
## IMFTimedTextCue::GetStartTime

### Description
Gets the start time of the cue in the track.

### Method
GetStartTime

### Syntax
```cpp
double GetStartTime();
```

### Return Value
Type: **double**
Returns the start time of the cue in the track.

### Requirements
- **Minimum supported client**: Windows 10 [desktop apps only]
- **Minimum supported server**: Windows Server 2016 [desktop apps only]
- **Target Platform**: Windows
- **Header**: mfmediaengine.h

```

--------------------------------

### SetupDiGetDeviceInstanceIdA

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetdeviceinstanceida

Documentation for the SetupDiGetDeviceInstanceIdA function, including syntax, parameters, return value, remarks, and requirements.

```APIDOC
## SetupDiGetDeviceInstanceIdA

### Description
Retrieves the device instance ID that is associated with a device information element.

### Syntax
```cpp
WINSETUPAPI BOOL SetupDiGetDeviceInstanceIdA(
  [in]            HDEVINFO         DeviceInfoSet,
  [in]            PSP_DEVINFO_DATA DeviceInfoData,
  [out, optional] PSTR             DeviceInstanceId,
  [in]            DWORD            DeviceInstanceIdSize,
  [out, optional] PDWORD           RequiredSize
);
```

### Parameters
- **DeviceInfoSet** (HDEVINFO) - [in] - A handle to the device information set that contains the device information element that represents the device for which to retrieve a device instance ID.
- **DeviceInfoData** (PSP_DEVINFO_DATA) - [in] - A pointer to an SP_DEVINFO_DATA structure that specifies the device information element in DeviceInfoSet.
- **DeviceInstanceId** (PSTR) - [out, optional] - A pointer to the character buffer that will receive the NULL-terminated device instance ID for the specified device information element.
- **DeviceInstanceIdSize** (DWORD) - [in] - The size, in characters, of the DeviceInstanceId buffer.
- **RequiredSize** (PDWORD) - [out, optional] - A pointer to the variable that receives the number of characters required to store the device instance ID.

### Return Value
Returns TRUE if successful; otherwise, returns FALSE and the logged error can be retrieved by calling GetLastError.

### Remarks
In Windows Vista and later, the unified device property model uses the DEVPKEY_Device_InstanceId property key to represent the device instance identifier. The setupapi.h header defines SetupDiGetDeviceInstanceId as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant.

### Requirements
- **Minimum supported client**: Available in Microsoft Windows 2000 and later versions of Windows.
- **Target Platform**: Desktop
- **Header**: setupapi.h (include Setupapi.h)
- **Library**: Setupapi.lib
```

--------------------------------

### UninstallApplication

Source: https://learn.microsoft.com/en-us/windows/win32/api/appmgmt

Uninstalls a group policy application that handles setup and installation using Windows Installer .msi files.

```APIDOC
## UninstallApplication

### Description
The UninstallApplication function uninstalls a group policy application that handles setup and installation using Windows Installer .msi files.

### Method
Function

### Endpoint
UninstallApplication

### Parameters
No parameters are documented.

### Response
No response details are documented.
```

--------------------------------

### SetupInstallFileEx

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi

Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the filename and path information. Available in ANSI and Unicode versions.

```APIDOC
## SetupInstallFileEx

### Description
Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the filename and path information. (ANSI and Unicode versions)

### Syntax
```cpp
BOOL SetupInstallFileEx(
  HINF InfHandle,
  PINFCONTEXT InfContext,
  PCTSTR SourceFile,
  PCTSTR SourcePathRoot,
  PCTSTR DestinationName,
  DWORD CopyStyle,
  PSP_FILE_CALLBACK CopyMsgHandler,
  PVOID Context,
  PBOOL FileWasInUse
);
```

### Parameters
- **InfHandle** (HINF) - Required - Handle to the INF file. Can be NULL if InfContext is provided.
- **InfContext** (PINFCONTEXT) - Optional - Pointer to the context for a line in an INF file. Can be NULL.
- **SourceFile** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the source file name. Can be NULL.
- **SourcePathRoot** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the root path of the source file. Can be NULL.
- **DestinationName** (PCTSTR) - Optional - Pointer to a null-terminated string that specifies the destination file name. Can be NULL.
- **CopyStyle** (DWORD) - Required - Flags that control the copy operation. Possible values include SP_COPY_DELETESOURCE, SP_COPY_REPLACE, and SP_COPY_NEWER.
- **CopyMsgHandler** (PSP_FILE_CALLBACK) - Optional - Pointer to a callback function. Can be NULL.
- **Context** (PVOID) - Optional - Pointer to a context for the callback function. Can be NULL.
- **FileWasInUse** (PBOOL) - Optional - Pointer to a variable that receives whether the file was in use. Can be NULL.

### Return Value
Returns TRUE if successful, otherwise FALSE. To get extended error information, call GetLastError.

```

--------------------------------

### DllInstall

Source: https://learn.microsoft.com/en-us/windows/win32/api/_shell

Handles installation and setup for a DLL.

```APIDOC
## DllInstall

### Description
Handles installation and setup for a DLL.

### Method
POST

### Endpoint
DllInstall
```

--------------------------------

### DevCreateObjectQuery Example

Source: https://learn.microsoft.com/en-us/windows/win32/api/devquery/nf-devquery-devcreateobjectquery

Example of implementing the PDEV_QUERY_RESULT_CALLBACK method and calling DevCreateObjectQuery to query for device objects with a specific class GUID.

```APIDOC
## DevCreateObjectQuery

### Description
This example demonstrates how to implement the **PDEV_QUERY_RESULT_CALLBACK** method to print status messages when the query state changes, and when items have been added to, updated, or removed from the query result. It then shows a simple query scenario where **DevCreateObjectQuery** is called with a **DEVPROPCOMPKEY** array and a **DEVPROP_FILTER_EXPRESSION** to query for **DevObjectTypeDevice** objects with a **DEVPKEY_Device_ClassGuid** property with a value of **GUID_DEVCLASS_NET**.

### Method
DevCreateObjectQuery

### Parameters
- **DEVPROPCOMPKEY** array - Required - Array of property keys to query.
- **DEVPROP_FILTER_EXPRESSION** - Required - Filter expression to apply to the query.

### Request Example
```cpp
// Implementation of PDEV_QUERY_RESULT_CALLBACK
// ...

// Call DevCreateObjectQuery with DEVPROPCOMPKEY array and DEVPROP_FILTER_EXPRESSION
// to query for DevObjectTypeDevice objects with DEVPKEY_Device_ClassGuid = GUID_DEVCLASS_NET
```
```

--------------------------------

### Example 2: Build a list of all present devices

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdigetclassdevsa

Calls SetupDiGetClassDevs with DIGCF_ALLCLASSES | DIGCF_PRESENT to retrieve only devices that are currently present in the system.

```cpp
Handle = SetupDiGetClassDevs(NULL, NULL, NULL, DIGCF_ALLCLASSES | DIGCF_PRESENT);

```

--------------------------------

### SetupDiOpenDeviceInterfaceA

Source: https://learn.microsoft.com/en-us/windows/win32/api/setupapi/nf-setupapi-setupdiopendeviceinterfacea

Documentation for the SetupDiOpenDeviceInterfaceA function, including its syntax, parameters, and return value.

```APIDOC
## SetupDiOpenDeviceInterfaceA

### Description
Retrieves information about a device interface and adds the interface to the specified device information set for a local system or a remote system.

### Syntax
```cpp
WINSETUPAPI BOOL SetupDiOpenDeviceInterfaceA(
  [in]            HDEVINFO                  DeviceInfoSet,
  [in]            PCSTR                     DevicePath,
  [in]            DWORD                     OpenFlags,
  [out, optional] PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData
);
```

### Parameters
- **DeviceInfoSet** (HDEVINFO) - Required - A pointer to a device information set that contains, or will contain, a device information element that represents the device that supports the interface to open.
- **DevicePath** (PCSTR) - Required - A pointer to a NULL-terminated string that supplies the name of the device interface to be opened. This name is a Win32 device path that is typically received in a PnP notification structure or obtained by a previous call to SetupDiEnumDeviceInterfaces and its related functions.
- **OpenFlags** (DWORD) - Required - Flags that determine how the device interface element is to be opened. The only valid flag is DIODI_NO_ADD.
- **DeviceInterfaceData** (PSP_DEVICE_INTERFACE_DATA) - Optional - A pointer to a caller-initialized SP_DEVICE_INTERFACE_DATA structure that receives the requested interface data. This pointer is optional and can be NULL. If a buffer is supplied, the caller must set the cbSize member of the structure to sizeof(SP_DEVICE_INTERFACE_DATA) before calling SetupDiOpenDeviceInterface.

### Return Value
Returns a BOOL value. TRUE if successful, FALSE otherwise.
```

--------------------------------

### IShellApp::IsInstalled

Source: https://learn.microsoft.com/en-us/windows/win32/api/shappmgr/nf-shappmgr-ishellapp-isinstalled

Gets a value indicating whether a specified application is currently installed. Returns S_OK if installed, S_FALSE if not.

```APIDOC
## IShellApp::IsInstalled

### Description
Gets a value indicating whether a specified application is currently installed.

### Method
HRESULT

### Syntax
```cpp
HRESULT IsInstalled();
```

### Return Value
Type: **HRESULT**

This method can return one of these values.

| Return code | Description |
|-------------|-------------|
| **S_OK** | The application is installed. |
| **S_FALSE** | The application is not installed. |

### Remarks
Application publishers should determine if the application is currently installed and return S_OK if so, or S_FALSE if not.

### Requirements
| Requirement | Value |
|-------------|-------|
| **Minimum supported client** | Windows XP, Windows 2000 Professional [desktop apps only] |
| **Minimum supported server** | Windows Server 2003 [desktop apps only] |
| **Target Platform** | Windows |
| **Header** | shappmgr.h |
| **DLL** | Shell32.dll |

### See Also
- IAppPublisher
- IPublishedApp
- IShellApp
```

--------------------------------

### SetupGetFileQueueFlags

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Gets the flags from a setup file queue.

```APIDOC
## SetupGetFileQueueFlags

### Description
Gets the flags from a setup file queue.

### Method
Function

### Endpoint
SetupGetFileQueueFlags

### Parameters
- **QueueHandle** (HSPFILEQ) - Required - Handle to the setup file queue.
- **Flags** (PDWORD) - Required - Receives the flags.

### Response
#### Success Response
- **Flags** (DWORD) - The flags associated with the queue.

#### Response Example
```
Flags: 0x00000001
```
```

--------------------------------

### SetupInstallFileA

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. (ANSI)

```APIDOC
## SetupInstallFileA

### Description
Installs a file as specified either by an INFCONTEXT returned by SetupFindXXXLine or explicitly by the file name and path. (ANSI)

### Method
Function

### Endpoint
SetupInstallFileA

### Parameters
No parameters documented.

### Response
No response documented.

```

--------------------------------

### SetupInitializeFileLog

Source: https://learn.microsoft.com/en-us/windows/win32/api/_setup

Initializes a file to record installation operations and outcomes. This can be the system log or any other file.

```APIDOC
## SetupInitializeFileLog

### Description
Initializes a file to record installation operations and outcomes. This can be the system log, where the system tracks the files installed as part of Windows, or any other file. (Unicode)

### Method
Function

### Endpoint
SetupInitializeFileLog

### Parameters
No parameters documented.

### Response
No response documented.

```
Tokens:
Raw