IFunctionDiscoveryProvider::Initialize method (functiondiscoveryprovider.h)

Article
10/13/2021

[Function Discovery is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Initializes the Function Discovery provider object. This method is intended to be called immediately after the object is created.

Syntax

HRESULT Initialize(
  [in]  IFunctionDiscoveryProviderFactory *pIFunctionDiscoveryProviderFactory,
  [in]  IFunctionDiscoveryNotification    *pIFunctionDiscoveryNotification,
  [in]  LCID                              lcidUserDefault,
  [out] DWORD                             *pdwStgAccessCapabilities
);

Parameters

[in] pIFunctionDiscoveryProviderFactory

A pointer to the IFunctionDiscoveryProviderFactory interface. The provider should use this interface to create new Function Discovery objects.

[in] pIFunctionDiscoveryNotification

A pointer to an IFunctionDiscoveryNotification interface. The provider should use this interface to send OnUpdate, OnEvent, and OnError notifications to the Function Discovery notification queue. Queued notifications are sent to client programs by Function Discovery.

[in] lcidUserDefault

The locale identifier of the caller. The provider should use lcidUserDefault to return localized strings for the resource enumerated by the provider.

[out] pdwStgAccessCapabilities

Specifies the least restrictive possible access mode of the property stores associated with the function instances created by this provider.

If the DWORD value is set to -1, InstancePropertyStoreValidateAccess will be called every time OpenPropertyStore is called on a function instance created by this provider. Otherwise, the value specified by this parameter determines the least restrictive possible access mode for all property stores associated with all function instances created by this provider. A more restrictive access mode will be applied to an individual property store if a client calls OpenPropertyStore with the dwStgAccess parameter set to a value that is more restrictive than the specified pdwStgAccessCapabilities value.

For efficiency, specify a pdwStgAccessCapabilities value whenever possible.

The following modes are supported:

STGM_READ

STGM_READWRITE

STGM_WRITE

Return value

Possible return values include, but are not limited to, the following.

Return code	Description
S_OK	The method completed successfully.
E_INVALIDARG	One of the parameters contains an invalid argument.

Remarks

If your provider is going to create Function Discovery objects, queue notifications, or enumerate resources with localized strings, you must call AddRef on and cache the initialized pIFunctionDiscoveryProviderFactory, pIFunctionDiscoveryNotification, and lcidUserDefault parameters for later use when you implement the Initialize method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	functiondiscoveryprovider.h

Share via