SHAssocEnumHandlersForProtocolByApplication function (shobjidl_core.h)

Article
02/22/2024

Gets an enumeration interface that provides access to handlers associated with a given protocol.

Syntax

SHSTDAPI SHAssocEnumHandlersForProtocolByApplication(
  [in]  PCWSTR protocol,
  [in]  REFIID riid,
  [out] void   **enumHandlers
);

Parameters

[in] protocol

Type: PCWSTR

Pointer to a string that specifies the protocol.

[in] riid

Type: REFIID

A reference to the IID of the interface to retrieve through enumHandlers, typically IID_IEnumAssocHandlers.

[out] enumHandlers

Type: void**

When this method returns, contains the interface pointer requested in riid. This is typically IEnumAssocHandlers.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

It is recommended that you use the IID_PPV_ARGS macro, defined in Objbase.h, to package the riid and enumHandlers parameters. This macro provides the correct IID based on the interface pointed to by the value in enumHandlers, which eliminates the possibility of a coding error.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)
Library	Shell32.lib
DLL	Shell32.dll (version 6.1 or later)

Share via