IRTCClient2::ClientName
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets the name of the application that will be used in the User-Agent header.
Syntax
HRESULT put_ClientName(
BSTR bstrClientName
);
Parameters
- bstrClientName
[in] The name to use in the User-Agent header.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional possible return value.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
Remarks
The server creates the User-Agent header of the SIP request using the information supplied in this method and the information supplied in IRTCClient2::ClientCurVer.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |