IltmsDevice::get_FriendlyName

#include "ltms.h"

C Syntax

HRESULT IltmsDevice_get_FriendlyName(pDevice, pVal)

C++ Syntax

HRESULT get_FriendlyName(pVal)

IltmsDevice *pDevice;

pointer to an interface

BSTR * pVal;

pointer to a string

Retrieves the device's descriptive name.

Parameter

Description

pDevice

Pointer to an IltmsDevice  interface.

pVal

Pointer to a character string containing the device's friendly name.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString function. 

Required DLLs and Libraries

LTMS

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Elements:

IltmsDevice Interface, IltmsDevice::get_Name

Topics:

Media Streaming Function Groups 

Example

For a C++ example, refer to Print Live Streams Example For C++

Help Version 20.0.2019.8.26
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Streaming C API Help