IltmmCaptureInput::get_Name

#include "ltmm.h"

C Syntax

HRESULT IltmmCaptureInput__get_Name(pCaptureInput, pVal)

C++ Syntax

HRESULT get_Name(pVal)

 

IltmmCaptureInput *pCaptureInput;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves the input’s unique name.

Parameter

Description

pCaptureInput

Pointer to an IltmmCaptureInput interface.

pVal

Pointer to a character string containing the input’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 an input. A program can save this value to persistent storage and used later with the ltmmCaptureInputs::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

LTMM

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:

ltmmCaptureInputs::Find, ltmmCaptureInput::get_Selected

Topics:

Multimedia Function Group

Example

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

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