getCalendarInfoW 函式 (winnls.h)

  • 發行項

擷取識別碼所指定地區設定之行事曆的相關資訊。

注意 基於互通性考慮，應用程式應該偏好 GetCalendarInfoEx 函式至 GetCalendarInfo ，因為 Microsoft 正移轉至使用地區設定名稱，而不是新地區設定的地區設定識別碼。 任何只在 Windows Vista 和更新版本上執行的應用程式都應該使用 GetCalendarInfoEx。
 

語法

int GetCalendarInfoW(
  [in]            LCID    Locale,
  [in]            CALID   Calendar,
  [in]            CALTYPE CalType,
  [out, optional] LPWSTR  lpCalData,
  [in]            int     cchData,
  [out, optional] LPDWORD lpValue
);

參數

[in] Locale

地區設定識別碼 ，指定要擷取行事曆資訊的地區設定。 您可以使用 MAKELCID 宏來建立地區設定識別碼，或使用下列其中一個預先定義的值。

[in] Calendar

行事曆識別碼。

[in] CalType

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

注意如果此參數指定CAL_IYEAROFFSETRANGE或CAL_SERASTRING，GetCalendarInfo只會傳回一個字串。 在這兩種情況下，都會傳回目前的紀元。
 
CAL_USE_CP_ACP僅適用于此函式的 ANSI 版本。

對於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。 任何參數值都無效。

備註

注意 此 API 正在更新，以支援 2019 年 5 月日本紀元變更。 如果您的應用程式支援日曆，您應該驗證它是否正確地處理新紀元。 如需詳細資訊 ，請參閱為日文紀元變更準備您的應用程式 。
 
當此函式的 ANSI 版本與僅限 Unicode 的地區設定識別碼搭配使用時，函式可能會成功，因為作業系統使用系統字碼頁。 不過，系統字碼頁中未定義的字元會顯示在字串中，做為問號 (？) 。

注意

winnls.h 標頭會將 GetCalendarInfo 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

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

另請參閱

行事曆類型資訊

GetCalendarInfoEx

國家語言支援

國家語言支援函式

SetCalendarInfo