IFaxDevice::GetExtensionProperty method (faxcomex.h)

Article
02/22/2024

The IFaxDevice::get_GetExtensionProperty method retrieves an extension configuration property stored at the device level.

Syntax

HRESULT GetExtensionProperty(
  [in] BSTR    bstrGUID,
       VARIANT *pvProperty
);

Parameters

[in] bstrGUID

Type: BSTR

Specifies a string GUID that uniquely identifies the data to be retrieved.

pvProperty

Type: VARIANT*

VARIANT that specifies the data.

Return value

Type: HRESULT

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

Remarks

Note The returned data is a blob of bytes represented as a variant safe array of unsigned chars (VT_UI1 | VT_ARRAY). The data is relevant only to the specific extension that uses it. For more information see About the Fax Extension Configuration API.

To use this method, a user must have the farQUERY_CONFIG access right.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxcomex.h
DLL	Fxscomex.dll

Share via