IFaxServer::get_Branding

The IFaxServer::get_Branding method retrieves 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 get_Branding(
  BOOL *pVal  // receives branding flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax server generates a brand (banner) at the top of fax transmissions. If this parameter is equal to TRUE, the fax server generates branding information.

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::put_Branding