FaxGetRoutingInfo

The FaxGetRoutingInfo function returns to a fax client application routing information for a fax routing method that is associated with a specific fax device.

BOOL WINAPI FaxGetRoutingInfo(
  HANDLE FaxPortHandle,  // fax port handle
  LPCTSTR RoutingGuid,   // GUID that identifies fax routing method
  LPBYTE *RoutingInfoBuffer, 
                         // buffer to receive routing method data
  LPDWORD 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

[out] Pointer to the address of a buffer to receive the fax routing information.

RoutingInfoBufferSize

[out] Pointer to a DWORD variable to receive 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, a Microsoft Management Console (MMC) snap-in component that manages the specified fax routing method, typically calls the FaxGetRoutingInfo function. This is because the format of the routing data is unavailable to a fax client application. The routing data is relevant only to the exported fax routing method and to the fax service administration application.

An application that manages a specific fax routing method can call the FaxSetRoutingInfo function to modify the routing information for the method on a specified fax device. To enumerate all fax routing methods associated with a device, call the FaxEnumRoutingMethods 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.

The FaxGetRoutingInfo function allocates the memory required for the buffer pointed to by the RoutingInfoBuffer parameter. An application must call the FaxFreeBuffer function to deallocate the resources associated with this parameter.

For more information, see Managing Fax Routing Data and Freeing Fax Resources.

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, FaxFreeBuffer, FaxSetRoutingInfo, FaxEnumRoutingMethods, FaxEnumGlobalRoutingInfo, FaxSetGlobalRoutingInfo, FAX_GLOBAL_ROUTING_INFO