ホーム › UI.Shell › GetAcceptLanguagesA

GetAcceptLanguagesA

関数

ユーザーの優先言語一覧をAccept-Language形式で取得する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT GetAcceptLanguagesA(
    LPSTR pszLanguages,
    DWORD* pcchLanguages
);

パラメーター

名前	型	方向	説明
pszLanguages	LPSTR	out	文字列へのポインター。この関数が正常に終了すると、言語設定情報を受け取ります。完全な文字列を返すのに十分な領域を確保するため、このバッファーは 2048 文字のサイズにすることをお勧めします。また、返される文字列のサイズを取得するために、このパラメーターを NULL に設定してこの関数を呼び出すこともできます。
pcchLanguages	DWORD*	inout	pszLanguages の文字列のサイズ(文字数)へのポインター。入力時、この値は終端の null 文字を含む pszLanguages のサイズです。出力時、これは終端の null 文字を含まない pszLanguages の実際のサイズです。

名前

型

方向

説明

pszLanguages

LPSTR

out

文字列へのポインター。この関数が正常に終了すると、言語設定情報を受け取ります。完全な文字列を返すのに十分な領域を確保するため、このバッファーは 2048 文字のサイズにすることをお勧めします。また、返される文字列のサイズを取得するために、このパラメーターを NULL に設定してこの関数を呼び出すこともできます。

pcchLanguages

DWORD*

inout

pszLanguages の文字列のサイズ(文字数)へのポインター。

入力時、この値は終端の null 文字を含む pszLanguages のサイズです。

出力時、これは終端の null 文字を含まない pszLanguages の実際のサイズです。

戻り値の型: HRESULT

公式ドキュメント

言語設定を指定する際に Web サイトで使用される文字列を取得します。(ANSI)

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

Shlwapi.h に GetAcceptLanguages が含まれていないバージョンの Windows では、この関数の ANSI 版または Unicode 版を Shlwapi.dll から直接呼び出す必要があります。GetAcceptLanguagesA は序数 14、GetAcceptLanguagesW は序数 15 です。

一部の Web サイトは複数の言語でコンテンツを提供しています。言語設定はコントロールパネルの [インターネットオプション] 項目で指定できます。GetAcceptLanguages はそれらの設定を表す文字列を取得します。この文字列は、HTTP 接続のネゴシエーション時に追加の言語ヘッダーとして送信されます。

注意アプリまたはサービスがこの関数の言語タグを National Language Support 関数や Microsoft .NET に渡す場合は、まず ResolveLocaleName 関数を通じてタグを変換する必要があります。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetAcceptLanguages を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立ではないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT GetAcceptLanguagesA(
    LPSTR pszLanguages,
    DWORD* pcchLanguages
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int GetAcceptLanguagesA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszLanguages,   // LPSTR out
    ref uint pcchLanguages   // DWORD* in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetAcceptLanguagesA(
    <MarshalAs(UnmanagedType.LPStr)> pszLanguages As System.Text.StringBuilder,   ' LPSTR out
    ByRef pcchLanguages As UInteger   ' DWORD* in/out
) As Integer
End Function

' pszLanguages : LPSTR out
' pcchLanguages : DWORD* in/out
Declare PtrSafe Function GetAcceptLanguagesA Lib "shlwapi" ( _
    ByVal pszLanguages As String, _
    ByRef pcchLanguages As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAcceptLanguagesA = ctypes.windll.shlwapi.GetAcceptLanguagesA
GetAcceptLanguagesA.restype = ctypes.c_int
GetAcceptLanguagesA.argtypes = [
    wintypes.LPSTR,  # pszLanguages : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchLanguages : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
GetAcceptLanguagesA = Fiddle::Function.new(
  lib['GetAcceptLanguagesA'],
  [
    Fiddle::TYPE_VOIDP,  # pszLanguages : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchLanguages : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn GetAcceptLanguagesA(
        pszLanguages: *mut u8,  // LPSTR out
        pcchLanguages: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int GetAcceptLanguagesA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszLanguages, ref uint pcchLanguages);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_GetAcceptLanguagesA' -Namespace Win32 -PassThru
# $api::GetAcceptLanguagesA(pszLanguages, pcchLanguages)

#uselib "SHLWAPI.dll"
#func global GetAcceptLanguagesA "GetAcceptLanguagesA" sptr, sptr
; GetAcceptLanguagesA varptr(pszLanguages), varptr(pcchLanguages)   ; 戻り値は stat
; pszLanguages : LPSTR out -> "sptr"
; pcchLanguages : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global GetAcceptLanguagesA "GetAcceptLanguagesA" var, var
; res = GetAcceptLanguagesA(pszLanguages, pcchLanguages)
; pszLanguages : LPSTR out -> "var"
; pcchLanguages : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global GetAcceptLanguagesA "GetAcceptLanguagesA" sptr, sptr
; res = GetAcceptLanguagesA(varptr(pszLanguages), varptr(pcchLanguages))
; pszLanguages : LPSTR out -> "sptr"
; pcchLanguages : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。