Products | Support | Send comments on this topic. | Email a link to this topic. | Back to Getting Started | Help Version 18.0.11.27
LEADTOOLS Media Foundation Help

IltmfCaptureInput::get_Name

Show in webframe

#include "ltmf.h"

C Syntax

HRESULT IltmfCaptureInput_get_Name(pCaptureInput, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmfCaptureInput *pCaptureInput;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves the inputs unique name.

Parameter

Description

pCaptureInput

Pointer to an IltmfCaptureInput interface.

pVal

Pointer to a character string containing the inputs 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 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 method succeeds, the caller must free the returned BSTR by calling the SysFreeString function.

Required DLLs and Libraries

LTMF

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:

ltmfCaptureInputs::Find, ltmfCaptureInput::get_Selected

Topics:

Media Foundation Function Group

Example

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

Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.