IFaxRoutingMethod::get_FunctionName

The IFaxRoutingMethod::get_FunctionName method retrieves the FunctionName property for a FaxRoutingMethod object. The FunctionName property is a null-terminated string that contains the name of the function that executes a specific fax routing procedure.

Visual Basic Reference

HRESULT get_FunctionName(
  BSTR *pVal  // receives function name for fax routing method
);

Parameters

pVal

[out] Pointer to a null-terminated character string that is the name of the function that executes the specified fax routing procedure. The fax routing extension DLL identified by the ImageName property defines and exports the function.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

A fax client application can use the Guid property to uniquely identify a fax routing method. It is possible for multiple routing methods to have the same user-friendly name and even the same function name. For more information, see Fax Routing Methods.

The IFaxRoutingMethod::get_FunctionName method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxRoutingMethod, IFaxRoutingMethods, IFaxRoutingMethod::get_FriendlyName, IFaxRoutingMethod::get_FunctionName, SysFreeString, FaxRouteMethod