ホーム › Devices.Bluetooth › BluetoothSdpGetString

BluetoothSdpGetString

関数

SDPレコードから指定オフセットの文字列を取得する。

DLLBluetoothApis.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// BluetoothApis.dll
#include <windows.h>

DWORD BluetoothSdpGetString(
    BYTE* pRecordStream,
    DWORD cbRecordLength,
    const SDP_STRING_TYPE_DATA* pStringData,   // optional
    WORD usStringOffset,
    LPWSTR pszString,
    DWORD* pcchStringLength
);

パラメーター

名前	型	方向	説明
pRecordStream	BYTE*	in	単一の SDP レコードとして書式設定された、有効なレコードストリームへのポインター。
cbRecordLength	DWORD	in	pRecordStream の長さ (バイト単位)。
pStringData	SDP_STRING_TYPE_DATA*	inoptional	NULL を指定した場合は、呼び出し元スレッドのロケールを使用して SDP レコード内で一致する文字列を検索します。 NULL 以外を指定した場合は、 SDP_STRING_TYPE_DATA 構造体の mibeNum メンバーと attributeId メンバーを使用して、変換する文字列を検索します。
usStringOffset	WORD	in	変換する SDP 文字列型のオフセット。 usStringOffset は、文字列の基本属性識別子に加算されます。 SDP 仕様で定義されているオフセットは、STRING_NAME_OFFSET、STRING_DESCRIPTION_OFFSET、STRING_PROVIDER_NAME_OFFSET です。これらのオフセットは bthdef.h ヘッダーファイルに定義されています。
pszString	LPWSTR	out	NULL 以外を指定した場合、出力時に変換された文字列が格納されます。NULL を指定した場合は、変換された文字列を取得するために必要な文字数 (バイト数ではありません) が pcchStringLength パラメーターに格納されます。
pcchStringLength	DWORD*	inout	入力時、pszString が NULL 以外の場合は pszString の長さを文字数単位で指定します。出力時には、エラーが返された場合は NULL を含めて必要な文字数が、それ以外の場合は NULL を含めて pszString に書き込まれた文字数が格納されます。

戻り値の型: DWORD

公式ドキュメント

SDP レコードに埋め込まれている生の文字列を Unicode 文字列に変換します。

戻り値

正常に完了した場合は ERROR_SUCCESS を返します。このとき pszString パラメーターには変換された文字列が格納されます。失敗した場合はエラーコードを返します。代表的なエラーを次の表に示します。

戻り値	説明
ERROR_MORE_DATA	pszString パラメーターが NULL であるか、変換された文字列を格納するには小さすぎます。pcchStringLength パラメーターに必要な長さが文字数単位で格納されます。
ERROR_INVALID_DATA	変換を実行できません。
ERROR_NO_SYSTEM_RESOURCES	変換を実行するためのメモリをシステムが内部的に割り当てられません。
ERROR_INVALID_PARAMETER	必須のポインターのいずれかが NULL であるか、pRecordStream パラメーターが有効な SDP ストリームではないか、pRecordStream が正しく書式設定されたレコードではないか、要求された属性とオフセットの組み合わせが文字列ではありません。

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

各言語での呼び出し定義

// BluetoothApis.dll
#include <windows.h>

DWORD BluetoothSdpGetString(
    BYTE* pRecordStream,
    DWORD cbRecordLength,
    const SDP_STRING_TYPE_DATA* pStringData,   // optional
    WORD usStringOffset,
    LPWSTR pszString,
    DWORD* pcchStringLength
);

[DllImport("BluetoothApis.dll", ExactSpelling = true)]
static extern uint BluetoothSdpGetString(
    IntPtr pRecordStream,   // BYTE*
    uint cbRecordLength,   // DWORD
    IntPtr pStringData,   // SDP_STRING_TYPE_DATA* optional
    ushort usStringOffset,   // WORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszString,   // LPWSTR out
    ref uint pcchStringLength   // DWORD* in/out
);

<DllImport("BluetoothApis.dll", ExactSpelling:=True)>
Public Shared Function BluetoothSdpGetString(
    pRecordStream As IntPtr,   ' BYTE*
    cbRecordLength As UInteger,   ' DWORD
    pStringData As IntPtr,   ' SDP_STRING_TYPE_DATA* optional
    usStringOffset As UShort,   ' WORD
    <MarshalAs(UnmanagedType.LPWStr)> pszString As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchStringLength As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pRecordStream : BYTE*
' cbRecordLength : DWORD
' pStringData : SDP_STRING_TYPE_DATA* optional
' usStringOffset : WORD
' pszString : LPWSTR out
' pcchStringLength : DWORD* in/out
Declare PtrSafe Function BluetoothSdpGetString Lib "bluetoothapis" ( _
    ByVal pRecordStream As LongPtr, _
    ByVal cbRecordLength As Long, _
    ByVal pStringData As LongPtr, _
    ByVal usStringOffset As Integer, _
    ByVal pszString As LongPtr, _
    ByRef pcchStringLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BluetoothSdpGetString = ctypes.windll.bluetoothapis.BluetoothSdpGetString
BluetoothSdpGetString.restype = wintypes.DWORD
BluetoothSdpGetString.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # pRecordStream : BYTE*
    wintypes.DWORD,  # cbRecordLength : DWORD
    ctypes.c_void_p,  # pStringData : SDP_STRING_TYPE_DATA* optional
    ctypes.c_ushort,  # usStringOffset : WORD
    wintypes.LPWSTR,  # pszString : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchStringLength : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('BluetoothApis.dll')
BluetoothSdpGetString = Fiddle::Function.new(
  lib['BluetoothSdpGetString'],
  [
    Fiddle::TYPE_VOIDP,  # pRecordStream : BYTE*
    -Fiddle::TYPE_INT,  # cbRecordLength : DWORD
    Fiddle::TYPE_VOIDP,  # pStringData : SDP_STRING_TYPE_DATA* optional
    -Fiddle::TYPE_SHORT,  # usStringOffset : WORD
    Fiddle::TYPE_VOIDP,  # pszString : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchStringLength : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "bluetoothapis")]
extern "system" {
    fn BluetoothSdpGetString(
        pRecordStream: *mut u8,  // BYTE*
        cbRecordLength: u32,  // DWORD
        pStringData: *const SDP_STRING_TYPE_DATA,  // SDP_STRING_TYPE_DATA* optional
        usStringOffset: u16,  // WORD
        pszString: *mut u16,  // LPWSTR out
        pcchStringLength: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("BluetoothApis.dll")]
public static extern uint BluetoothSdpGetString(IntPtr pRecordStream, uint cbRecordLength, IntPtr pStringData, ushort usStringOffset, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszString, ref uint pcchStringLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'BluetoothApis_BluetoothSdpGetString' -Namespace Win32 -PassThru
# $api::BluetoothSdpGetString(pRecordStream, cbRecordLength, pStringData, usStringOffset, pszString, pcchStringLength)

#uselib "BluetoothApis.dll"
#func global BluetoothSdpGetString "BluetoothSdpGetString" sptr, sptr, sptr, sptr, sptr, sptr
; BluetoothSdpGetString varptr(pRecordStream), cbRecordLength, varptr(pStringData), usStringOffset, varptr(pszString), varptr(pcchStringLength)   ; 戻り値は stat
; pRecordStream : BYTE* -> "sptr"
; cbRecordLength : DWORD -> "sptr"
; pStringData : SDP_STRING_TYPE_DATA* optional -> "sptr"
; usStringOffset : WORD -> "sptr"
; pszString : LPWSTR out -> "sptr"
; pcchStringLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "BluetoothApis.dll"
#cfunc global BluetoothSdpGetString "BluetoothSdpGetString" var, int, var, int, var, var
; res = BluetoothSdpGetString(pRecordStream, cbRecordLength, pStringData, usStringOffset, pszString, pcchStringLength)
; pRecordStream : BYTE* -> "var"
; cbRecordLength : DWORD -> "int"
; pStringData : SDP_STRING_TYPE_DATA* optional -> "var"
; usStringOffset : WORD -> "int"
; pszString : LPWSTR out -> "var"
; pcchStringLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "BluetoothApis.dll"
#cfunc global BluetoothSdpGetString "BluetoothSdpGetString" sptr, int, sptr, int, sptr, sptr
; res = BluetoothSdpGetString(varptr(pRecordStream), cbRecordLength, varptr(pStringData), usStringOffset, varptr(pszString), varptr(pcchStringLength))
; pRecordStream : BYTE* -> "sptr"
; cbRecordLength : DWORD -> "int"
; pStringData : SDP_STRING_TYPE_DATA* optional -> "sptr"
; usStringOffset : WORD -> "int"
; pszString : LPWSTR out -> "sptr"
; pcchStringLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。