getCalendarInfoA 函式 (winnls.h)
擷取標識碼所指定地區設定之行事曆的相關信息。
語法
int GetCalendarInfoA(
[in] LCID Locale,
[in] CALID Calendar,
[in] CALTYPE CalType,
[out, optional] LPSTR lpCalData,
[in] int cchData,
[out, optional] LPDWORD lpValue
);
參數
[in] Locale
地區設定標識碼 ，指定要擷取行事曆信息的地區設定。 您可以使用 MAKELCID 宏來建立地區設定標識碼，或使用下列其中一個預先定義的值。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] Calendar
[in] CalType
要擷取的信息類型。 如需詳細資訊，請參閱 行事曆類型資訊。
對於CAL_NOUSEROVERRIDE，函式會忽略 SetCalendarInfo 所設定的任何值，並使用目前系統預設地區設定的資料庫設定。 此類型僅與組合CAL_NOUSEROVERRIDE相關 |CAL_ITWODIGITYEARMAX。 CAL_ITWODIGITYEARMAX是唯一可由 SetCalendarInfo 設定的值。
[out, optional] lpCalData
緩衝區的指標，此函式會將要求的數據擷取為字串。 如果在 CalType 中指定CAL_RETURN_NUMBER，此參數必須擷取 NULL。
[in] cchData
lpCalData 緩衝區的大小，以字元為單位。 應用程式可以將此參數設定為 0，以傳回行事曆數據緩衝區所需的大小。 在此情況下，不會使用 lpCalData 參數。 如果為 CalType 指定 CAL_RETURN_NUMBER，cchData 的值必須是 0。
[out, optional] lpValue
以數位的形式接收所要求數據的變數指標。 如果在 CalType 中指定CAL_RETURN_NUMBER， 則 lpValue 不得為 NULL。 如果未在 CalType 中指定CAL_RETURN_NUMBER， 則 lpValue 必須是 NULL。
傳回值
傳回 在 lpCalData 緩衝區中擷取的字元數，如果成功， cchData 會設定為非零值。 如果函式成功， cchData 會設定為 0，而且未指定CAL_RETURN_NUMBER，則傳回值是保存行事曆資訊所需的緩衝區大小。 如果函式成功， cchData 會設定為 0，而且已指定CAL_RETURN_NUMBER，則傳回值會是 lpValue 中擷取的值大小，也就是 2 代表函式的 Unicode 版本，或 ANSI 版本的 4。
如果函式不成功，此函式會傳回 0。 若要取得擴充的錯誤資訊，應用程式可以呼叫 GetLastError，這可以傳回下列其中一個錯誤碼：
- ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大，或設定為 NULL 不正確。
- ERROR_INVALID_FLAGS。 為旗標的值無效。
- ERROR_INVALID_PARAMETER。 任何參數值都無效。
備註
注意
winnls.h 標頭會將 GetCalendarInfo 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
| 目標平台 | Windows |
| 標頭 | winnls.h (包含 Windows.h) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |