IFaxServer::put_Branding

The IFaxServer::put_Branding method changes the Branding property for a FaxServer object. The Branding property is a Boolean value that indicates whether the fax server generates branding information at the top of fax transmissions.

Visual Basic Reference

HRESULT put_Branding(
  BOOL newVal  // new value for branding flag
);

Parameters

newVal

[in] Specifies the new value to assign to the Branding property. If this value is TRUE, the fax server generates a brand (banner) at the top of fax transmissions.

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 brand is an informational header at the top of most fax pages that typically contains the transmission time, the page count, and the transmitting station identifier. Branding may be required by law in some locales.

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, IFaxServer, IFaxServer::get_Branding