IFaxRoutingMethod::get_ImageName

The IFaxRoutingMethod::get_ImageName method retrieves the ImageName property for a FaxRoutingMethod object. The ImageName property is a null-terminated string that contains the executable image name of the fax routing extension DLL that implements the fax routing method.

Visual Basic Reference

HRESULT get_ImageName(
  BSTR *pVal  // receives image name for fax routing extension
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the unique executable image name of the fax routing extension DLL that exports the specified fax routing method.

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 ImageName property to uniquely identify the fax routing extension DLL that exports a fax routing method. Note that it is possible for multiple routing extensions to have the same user-friendly name.

The IFaxRoutingMethod::get_ImageName 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_ExtensionName, SysFreeString