In This Topic ▼

IltmsDevice::get_Name

#include "ltms.h"

C Syntax

HRESULT IltmsDevice_get_Name(pDevice, pVal)

C++ Syntax

HRESULT get_Name(pVal)

IltmsDevice *pDevice;

pointer to an interface

BSTR * pVal;

pointer to a string

Retrieves the device's unique name

Parameter

Description

pDevice

Pointer to an IltmsDevice interface.

pVal

Pointer to a character string containing the device's 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 string can be used to uniquely identify a device. A program can save this value to persistent storage and use it later with the IltmsDevices::Find function to restore the device selection.

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_FriendlyName, ltmsDevices::Find

Topics:

Media Streaming Function Groups 

Example

For a C++ example, refer to Print Capture Devices Example For C++

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

LEADTOOLS Media Streaming C API Help