Edit

Share via

FaxExtConfigChange function (faxext.h)

  • Article

A FaxExtConfigChange callback function is a placeholder for a function name defined by the fax extension DLL. The fax extension DLL should not expose this function.

Syntax

HRESULT FaxExtConfigChange(
  [in] DWORD   dwDeviceId,
  [in] LPCWSTR lpcwstrDataGUID,
  [in] LPBYTE  lpData,
  [in] DWORD   dwDataSize
);

Parameters

[in] dwDeviceId

Type: DWORD

Specifies a DWORD value that indicates the device for which the configuration data has changed.

This parameter can be zero, indicating a change in the extension's global configuration data (configuration data that is not associated with a specific device). For more information, see Storing Global Configuration Data.

[in] lpcwstrDataGUID

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character string that specifies the GUID of the data that has changed; for example, "{b8959fc9-4e77-4ee9-8411-009acb1bbf3e}".

[in] lpData

Type: LPBYTE

Pointer to a buffer that contains the new configuration data.

[in] dwDataSize

Type: DWORD

Specifies a DWORD value that indicates the size, in bytes, of the buffer pointed to by the lpData parameter.

Return value

Type: HRESULT

If the function succeeds, the return value is of the type HRESULT, and the value is NOERROR.

Remarks

The fax service calls this function after a change in device configuration data occurs. The fax service calls this function only if the fax extension has registered to receive notifications about configuration changes by calling the FaxExtRegisterForEvents function.

If an extension registers to receive notifications about changes in configuration data, that extension does not receive notifications about new configuration values it sets itself. You can change a device's configuration data by calling the FaxExtSetData function.

The fax extension DLL must register the FaxExtConfigChange callback function by passing its address to the FaxExtRegisterForEvents callback function. The PFAX_EXT_CONFIG_CHANGE data type is a pointer to a FaxExtConfigChange function.

Requirements

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

See also

FaxExtRegisterForEvents

FaxExtSetData