getNumberFormatW 函数 (winnls.h)

  • 项目

将数字字符串的格式设置为为标识符指定的区域设置自定义的数字字符串。

注意 出于互操作性原因，应用程序应优先使用 GetNumberFormatEx 函数而不是 GetNumberFormat ，因为 Microsoft 正在迁移到使用区域设置名称而不是新区域设置的区域设置标识符。 仅在 Windows Vista 及更高版本上运行的任何应用程序都应使用 GetNumberFormatEx。
 

语法

int GetNumberFormatW(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in]            LPCWSTR          lpValue,
  [in, optional]  const NUMBERFMTW *lpFormat,
  [out, optional] LPWSTR           lpNumberStr,
  [in]            int              cchNumber
);

参数

[in] Locale

指定区域设置的区域设置标识符。 可以使用 MAKELCID 宏创建区域设置标识符或使用以下预定义值之一。

[in] dwFlags

控制函数操作的标志。 如果 lpFormat 未设置为 NULL，则应用程序必须将此参数设置为 0。 在这种情况下， 函数使用用户替代将字符串的格式设置为区域设置的默认数字格式。 如果 lpFormat 设置为 NULL，则应用程序可以指定 LOCALE_NOUSEROVERRIDE ，以使用指定区域设置的系统默认数字格式设置字符串的格式。

谨慎 强烈建议不要使用 LOCALE_NOUSEROVERRIDE，因为它会禁用用户首选项。
 

[in] lpValue

指向以 null 结尾的字符串的指针，该字符串包含要设置格式的数字字符串。 此字符串只能包含以下字符。 所有其他字符都无效。 如果 lpValue 指示的字符串偏离这些规则，则函数将返回错误。

  • 字符“0”到“9”。
  • 如果数字是浮点值，则一个小数点 (点) 。
  • 如果数字为负值，则为第一个字符位置的减号。

[in, optional] lpFormat

指向 NUMBERFMT 结构的指针，该结构包含数字格式设置信息，所有成员都设置为适当的值。 如果此参数未设置为 NULL，则该函数仅使用区域设置来设置结构中未指定的格式信息，例如，负号的区域设置特定字符串值。

[out, optional] lpNumberStr

指向缓冲区的指针，此函数在其中检索带格式的数字字符串。

[in] cchNumber

大小，以 TCHAR 值表示，表示 由 lpNumberStr 指示的数字字符串缓冲区。 或者，应用程序可以将此参数设置为 0。 在这种情况下，函数返回数字字符串缓冲区所需的大小，并且不使用 lpNumberStr 参数。

返回值

如果成功，则返回 在 lpNumberStr 指示的缓冲区中检索的 TCHAR 值的数目。 如果 cchNumber 参数设置为 0，则该函数将返回保存格式化数字字符串所需的字符数，包括终止 null 字符。

如果函数不成功，则返回 0。 若要获取扩展的错误信息，应用程序可以调用 GetLastError，这会返回以下错误代码之一：

  • ERROR_INSUFFICIENT_BUFFER。 提供的缓冲区大小不够大，或者错误地设置为 NULL。
  • ERROR_INVALID_FLAGS。 为标志提供的值无效。
  • ERROR_INVALID_PARAMETER。 任何参数值都无效。
  • ERROR_OUTOFMEMORY。 没有足够的存储空间来完成此操作。

注解

此函数可以从 自定义区域设置检索数据。 不保证数据在计算机之间或应用程序运行之间的数据相同。 如果应用程序必须保留或传输数据，请参阅 使用持久区域设置数据。

当此函数的 ANSI 版本与仅限 Unicode 的区域设置标识符一起使用时，该函数可以成功，因为操作系统使用系统代码页。 但是，系统代码页中未定义的字符在字符串中显示为问号 (？) 。

注意

winnls.h 标头将 GetNumberFormat 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 winnls.h (包括 Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

GetNumberFormatEx

NUMBERFMT

国家/地区语言支持

国家/地区语言支持函数