IltmfCaptureInput::get_Name

Summary

Retrieves the inputs unique name.

Syntax

#include "ltmf.h"

Language Syntax
C HRESULT IltmfCaptureInput_get_Name(pCaptureInput, pVal)
C++ HRESULT get_Name(pVal)

Parameters

IltmfCaptureInput *pCaptureInput

Pointer to an IltmfCaptureInput interface.

BSTR *pVal

Pointer to a character string containing the inputs name.

Returns

Value Meaning
S_OK The function was successful.
<> S_OK An error occurred. Refer to the Error Codes or the HRESULT error codes in the MediaFoundation documentation.

Comments

The returned string can be used to uniquely identify an input. A program can save this value to persistent storage and used later with the ltmfCaptureInputs::Find function to restore the input selection.

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

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to Selecting ltmfCapture Object Inputs for C++.

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

LEADTOOLS Media Foundation C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.