Skip to content

Latest commit

 

History

History
150 lines (111 loc) · 5.92 KB

nf-strmif-idvdinfo2-getdvdtextstringasnative.md

File metadata and controls

150 lines (111 loc) · 5.92 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:strmif.IDvdInfo2.GetDVDTextStringAsNative
IDvdInfo2::GetDVDTextStringAsNative (strmif.h)
The GetDVDTextStringAsNative method retrieves a DVD text string for a specified language, and returns the text string as an array of bytes.
GetDVDTextStringAsNative
GetDVDTextStringAsNative method [DirectShow]
GetDVDTextStringAsNative method [DirectShow]
IDvdInfo2 interface
IDvdInfo2 interface [DirectShow]
GetDVDTextStringAsNative method
IDvdInfo2.GetDVDTextStringAsNative
IDvdInfo2::GetDVDTextStringAsNative
IDvdInfo2GetDVDTextStringAsNative
dshow.idvdinfo2_getdvdtextstringasnative
strmif/IDvdInfo2::GetDVDTextStringAsNative
dshow\idvdinfo2_getdvdtextstringasnative.htm
dshow
a162b4ad-28f2-49fc-9b32-72538be9ddd5
4/26/2023
GetDVDTextStringAsNative, GetDVDTextStringAsNative method [DirectShow], GetDVDTextStringAsNative method [DirectShow],IDvdInfo2 interface, IDvdInfo2 interface [DirectShow],GetDVDTextStringAsNative method, IDvdInfo2.GetDVDTextStringAsNative, IDvdInfo2::GetDVDTextStringAsNative, IDvdInfo2GetDVDTextStringAsNative, dshow.idvdinfo2_getdvdtextstringasnative, strmif/IDvdInfo2::GetDVDTextStringAsNative
strmif.h
Dshow.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Strmiids.lib
Windows
19H1
IDvdInfo2::GetDVDTextStringAsNative
strmif/IDvdInfo2::GetDVDTextStringAsNative
c++
APIRef
kbSyntax
COM
Strmiids.lib
Strmiids.dll
IDvdInfo2.GetDVDTextStringAsNative

IDvdInfo2::GetDVDTextStringAsNative

-description

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetDVDTextStringAsNative method retrieves a DVD text string for a specified language, and returns the text string as an array of bytes.

-parameters

-param ulLangIndex [in]

Zero-based index of the language. To find the number of text-string languages on the DVD, call IDvdInfo2::GetDVDTextNumberOfLanguages.

-param ulStringIndex [in]

Zero-based index of the string to retrieve. To find the number of strings for a given language, call IDvdInfo2::GetDVDTextLanguageInfo.

-param pbBuffer [out]

Pointer to a buffer that receives the text string. If pchBuffer is NULL, this method returns the size of the string in pulActualSize.

-param ulMaxBufferSize [in]

Size of the pchBuffer in bytes

-param pulActualSize [out]

Receives the actual length of the string in bytes, including the terminating NULL.

-param pType [out]

Receives a member of the DVD_TextStringType enumeration. The value indicates the type of text string, such as movie title or song name. This parameter can also receive values that are not defined in the DVD_TextStringType enumeration.

-returns

Returns one of the following HRESULT values.

Return code Description
S_OK
Success.
E_POINTER
Invalid argument.
E_UNEXPECTED
An unexpected internal error occurred.

-remarks

This method returns a DVD text string as a raw byte array, with no conversions. You can use this method to get text strings that are encoded using character sets other than Unicode or 7-bit ASCII (ISO/IEC 646), such as JIS Roman Kanji. To find the character set, call IDvdInfo2::GetDVDTextLanguageInfo.

For Unicode and ASCII text strings, you can use the IDvdInfo2::GetDVDTextStringAsUnicode method, which returns a wide-character string.

The returned string always includes a single terminating NULL byte. If the buffer is smaller than the length of the DVD text string, the string is truncated. To find the required size of the buffer, call the method once with pchBuffer equal to NULL and ulMaxBufferSize equal to zero. The size is returned in pulActualSize. Then allocate a buffer and call the method again.

-see-also

DVD Applications

Error and Success Codes

IDvdInfo2 Interface

Working with DVD Text Strings