GetCalendarInfoEx 函式 (winnls.h)

  • 發行項

擷取名稱所指定地區設定之行事曆的相關資訊。

注意 如果設計為只在 Windows Vista 和更新版本上執行，應用程式應該優先呼叫此函式給 GetCalendarInfo 。

 
注意 此函式可以擷取版本之間變更的資料，例如，因為自訂地區設定。 如果您的應用程式必須保存或傳輸資料，請參閱 使用持續性地區設定資料。
 

語法

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

要擷取的資訊類型。 如需詳細資訊，請參閱 行事曆類型資訊。

注意 如果此參數指定CAL_IYEAROFFSETRANGE或CAL_SERASTRING，GetCalendarInfoEx只會傳回一個字串。 在這兩種情況下，都會傳回目前的紀元。
 
針對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 會設定為 0，而且未指定CAL_RETURN_NUMBER，則傳回值是保存地區設定資訊所需的緩衝區大小。 如果函式成功， cchData 會設定為 0，而且已指定CAL_RETURN_NUMBER，則傳回值是寫入 lpValue 參數的值大小。 此大小一律為 2。

如果函式未成功，則傳回 0。 若要取得延伸的錯誤資訊，應用程式可以呼叫 GetLastError，這可以傳回下列其中一個錯誤碼：

  • ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大，或設定為 Null不正確。
  • ERROR_INVALID_FLAGS。 為旗標提供的值無效。
  • ERROR_INVALID_PARAMETER。 任何參數值都無效。

備註

注意 此 API 即將更新，以支援 2019 年 5 月日紀元變更。 如果您的應用程式支援日曆，您應該驗證它是否能夠正確處理新紀元。 如需詳細資訊 ，請參閱準備您的應用程式以進行日文紀元變更 。
 
從 Windows 8 開始： 如果您的 app 會從 Windows.Globalization 命名空間將語言標記傳遞至此函式，則必須先呼叫 ResolveLocaleName來轉換標記。

規格需求

   
最低支援的用戶端 Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows 2000 Server [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 winnls.h (包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

行事曆類型資訊

GetCalendarInfo

國家語言支援

國家語言支援函式

SetCalendarInfo