Edit

Share via

IProviderProperties::GetValue method (functiondiscoveryprovider.h)

  • Article

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

Gets the value of the specified property key.

Syntax

HRESULT GetValue(
  [in]  IFunctionInstance *pIFunctionInstance,
  [in]  INT_PTR           iProviderInstanceContext,
  [in]  REFPROPERTYKEY    Key,
  [out] PROPVARIANT       *ppropVar
);

Parameters

[in] pIFunctionInstance

An IFunctionInstance interface pointer.

[in] iProviderInstanceContext

The context associated with the specific function instance.

[in] Key

The property key reference.

[out] ppropVar

The value of the property key specified by Key. The PROPVARIANT type is VT_EMPTY if the key is not found in the property store.

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.
E_POINTER
 ppropVar parameter is NULL.
E_OUTOFMEMORY
 The method is unable to allocate enough memory to perform the operation.

Remarks

To change the value of a property key, use the SetValue method.

If a value for Key could not be found, the return value will be S_OK and ppropVar will be set to VT_NULL.

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

See also

IProviderProperties