WdfPdoInitSetDefaultLocale function (wdfpdo.h)

[Applies to KMDF only]

The WdfPdoInitSetDefaultLocale method sets a device's default locale.

Syntax

void WdfPdoInitSetDefaultLocale(
  [in] PWDFDEVICE_INIT DeviceInit,
  [in] LCID            LocaleId
);

Parameters

[in] DeviceInit

A pointer to a WDFDEVICE_INIT structure.

[in] LocaleId

A locale identifier (LCID) that represents the default locale. For more information, see Locale Identifiers.

Return value

None

Remarks

When the system requests device description text from a driver, it specifies a locale. If text for the specified locale is not available, the framework returns device text for the driver's default locale.

The driver must call WdfPdoInitSetDefaultLocale before calling WdfDeviceCreate. For more information about calling WdfDeviceCreate, see Creating a Framework Device Object.

Examples

The following code example sets a device's default locale to United States English (0x409).

WdfPdoInitSetDefaultLocale(
                           pDeviceInit,
                           0x409
                           );

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Header wdfpdo.h (include Wdf.h)
Library Wdf01000.sys (see Framework Library Versioning.)
IRQL PASSIVE_LEVEL
DDI compliance rules ChildDeviceInitAPI(kmdf), DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), PdoDeviceInitAPI(kmdf)

See also

WdfPdoInitAddDeviceText