ILTDVDBurner::GetDriveId

#include "ILTDVDBurner2.h"

C Syntax

HRESULT LTDVDBurner__getDriveId(pDVDBurner, Drive, pVal)

C++ Syntax

HRESULT GetDriveId(Drive, pVal)

 

ILTDVDBurner *pDVDBurner;

/* pointer to an interface */

long Drive;

/* drive index */

BSTR *pVal;

/* pointer to a string */

Retrieves the ID that uniquely identifies the drive in the system.

Parameter

Description

pDVDBurner

Pointer to an ILTDVDBurner interface.

Drive

Value that represents a zero-based index of the drive for which to retrieve the ID.

pVal

Pointer to a character string to be updated with the drive ID.

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 retrieved ID can be saved for later usage as it is guaranteed to be unique and not to change.

If the function succeeds, the user is responsible for freeing the retrieved id string by calling SysFreeString.

Required DLLs and Libraries

LTDVDBRN
DSKernel

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

See Also

Functions:

ILTDVDBurner::get_DriveCount

Topics:

Video Streaming Function Groups, Multimedia Function Group, DVD Function Groups

Example

For a C example, refer to ILTDVDBurner::GetDriveId Example for C.

For a C++ example, refer to ILTDVDBurner::GetDriveId Example for C++.