IDvdInfo2::GetDVDTextLanguageInfo method

The GetDVDTextLanguageInfo method retrieves information about the text strings for a specified language. The method retrieves the number of strings for that language, the locale identifier, and the character set.

Syntax


HRESULT GetDVDTextLanguageInfo(
  [in]  ULONG           ulLangIndex,
  [out] ULONG           *pulNumOfStrings,
  [out] LCID            pLangCode,
  [out] DVD_TextCharSet *pbCharacterSet
);

Parameters

ulLangIndex [in]

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

pulNumOfStrings [out]

Receives the number of text strings for the specified language.

pLangCode [out]

Receives a locale identifier (LCID) that specifies the language in which the text is written. For example, the LCID for "en-us" is 0x0409.

pbCharacterSet [out]

Receives a member of the DVD_TextCharSet enumeration. The value specifies the character set of the text string.

Return value

Returns one of the following HRESULT values.

Return codeDescription
S_OK

Success.

E_INVALIDARG

This DVD does not have any text strings, or the ulLangIndex parameter is out of bounds.

E_POINTER

NULL pointer argument.

E_UNEXPECTED

An unexpected internal error occurred.

 

Remarks

To get a particular text string, call IDvdInfo2::GetDVDTextStringAsUnicode or IDvdInfo2::GetDVDTextStringAsNative.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

DVD Applications
Error and Success Codes
IDvdInfo2 Interface
Working with DVD Text Strings

 

 

Show: