| Platform SDK: Fax Services |
The IFaxRoutingMethod::get_FriendlyName method retrieves the FriendlyName property for a FaxRoutingMethod object. The FriendlyName property is a null-terminated string that contains the user-friendly name for a fax routing method.
HRESULT get_FriendlyName( BSTR *pVal // receives fax routing method's user-friendly name );
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.
A fax client application can use the Guid property to uniquely identify a fax routing method. Note that 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_FriendlyName 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.
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in faxcom.h.
Import Library: Included as a resource in faxcom.dll.
Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxRoutingMethod, IFaxRoutingMethods, IFaxRoutingMethod::get_Guid, IFaxRoutingMethod::get_FunctionName, SysFreeString, FaxRouteMethod