GetCalendarInfoEx 函式 (winnls.h)
擷取名稱所指定地區設定之行事曆的相關資訊。
語法
int GetCalendarInfoEx(
[in, optional] LPCWSTR lpLocaleName,
[in] CALID Calendar,
[in, optional] LPCWSTR lpReserved,
[in] CALTYPE CalType,
[out, optional] LPWSTR lpCalData,
[in] int cchData,
[out, optional] LPDWORD lpValue
);
參數
[in, optional] lpLocaleName
地區設定名稱的指標，或下列其中一個預先定義的值。
[in] Calendar
[in, optional] lpReserved
保留;必須是 Null。
[in] CalType
要擷取的資訊類型。 如需詳細資訊，請參閱 行事曆類型資訊。
[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 會設定為 0，而且未指定CAL_RETURN_NUMBER，則傳回值是保存地區設定資訊所需的緩衝區大小。 如果函式成功， cchData 會設定為 0，而且已指定CAL_RETURN_NUMBER，則傳回值是寫入 lpValue 參數的值大小。 此大小一律為 2。
如果函式未成功，則傳回 0。 若要取得延伸的錯誤資訊，應用程式可以呼叫 GetLastError，這可以傳回下列其中一個錯誤碼：
- ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大，或設定為 Null不正確。
- ERROR_INVALID_FLAGS。 為旗標提供的值無效。
- ERROR_INVALID_PARAMETER。 任何參數值都無效。
備註
規格需求
| 最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [傳統型應用程式 |UWP 應用程式] |
| 目標平台 | Windows |
| 標頭 | winnls.h (包含 Windows.h) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |