IRTCProfile::get_ClientBanner

The get_ClientBanner property returns a flag that specifies if the Client should display the banner for the profile.

HRESULT get_ClientBanner(VARIANT_BOOL*pfBanner);

Parameters

  • pfBanner
    [out] Pointer to a VARIANT_BOOL containing the banner flag.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_NOT_EXIST No banner.

Remarks

This is an optional field in the profile. If the field is not present in the profile, the method will return E_FAIL.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCProfile is defined as d07eca9e-4062-4dd4-9e7d-722a49ba7303.

See Also

IRTCProfile