IDataFunctions_4_0::GetLocaleList Method [C++]

Article
11/12/2009

Use this method to retrieve a SimpleList object that contains the locales available on the computer.

Definition

[C++]

HRESULT IDataFunctions_4_0::GetLocaleList(VARIANT*pvarList);

[Visual Basic]

Function GetLocaleList() As Variant

Parameters

pvarList[C++]
[out, retval] A pointer to a VARIANT used to return a SimpleList object that specifies the locales available on the computer.

[Visual Basic] None.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns an object Variant that references a SimpleList object that specifies the locales available on the computer.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The pvtRet parameter contains valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.