FaxSetRoutingInfo

A fax management application calls the FaxSetRoutingInfo function to modify the routing information for a fax routing method that is associated with a specific fax device.

BOOL WINAPI FaxSetRoutingInfo(
  HANDLE FaxPortHandle,  // fax port handle
  LPCTSTR RoutingGuid,   // GUID that identifies fax routing method
  CONST BYTE *RoutingInfoBuffer, 
                         // buffer with routing method data
  DWORD RoutingInfoBufferSize 
                         // size of buffer, in bytes
);

Parameters

FaxPortHandle

[in] Specifies a fax port handle returned by a call to the FaxOpenPort function.

RoutingGuid

[in] Pointer to a constant null-terminated character string that specifies the GUID that uniquely identifies the fax routing method of interest.

For information about fax routing methods, see About the Fax Routing Extension API. For information about the relationship between routing methods and GUIDs, see Fax Routing Methods.

RoutingInfoBuffer

[in] Pointer to a buffer that contains the fax routing information. The routing data is typically provided by the fax service administration application, a Microsoft Management Console (MMC) snap-in component.

RoutingInfoBufferSize

[in] Pointer to a DWORD variable that contains the size of the buffer, in bytes, pointed to by the RoutingInfoBuffer parameter.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Remarks

The fax service administration application, an MMC snap-in component that manages the specified fax routing method, typically calls the FaxSetRoutingInfo function. This is because the format of the routing data is unavailable to the fax client application. The routing data is relevant only to the exported fax routing method and the method's administration application.

To obtain a valid port handle to specify in the FaxPortHandle parameter of the FaxSetRoutingInfo function, call the FaxOpenPort function.

The FaxEnumGlobalRoutingInfo function retrieves routing information that applies globally to the fax server, such as routing priority. An application can modify global data with a call to the FaxSetGlobalRoutingInfo function.

For more information, see Managing Fax Routing Data.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Library: Included as a resource in Winfax.dll.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxOpenPort, FaxGetRoutingInfo, FaxEnumRoutingMethods, FaxEnumGlobalRoutingInfo, FaxSetGlobalRoutingInfo, FAX_GLOBAL_ROUTING_INFO