ホーム › System.DataExchange › DdeQueryStringA

DdeQueryStringA

関数

DDE文字列ハンドルから文字列の内容を取得する(ANSI版)。

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

シグネチャ

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

DWORD DdeQueryStringA(
    DWORD idInst,
    HSZ hsz,
    LPSTR psz,   // optional
    DWORD cchMax,
    INT iCodePage
);

パラメーター

名前	型	方向	説明
idInst	DWORD	in	直前の DdeInitialize 関数の呼び出しによって取得したアプリケーションインスタンス識別子です。
hsz	HSZ	in	コピーする文字列へのハンドルです。このハンドルは、直前の DdeCreateStringHandle 関数の呼び出しによって作成されたものである必要があります。
psz	LPSTR	outoptional	文字列を受け取るバッファへのポインターです。文字列の長さを取得するには、このパラメーターを NULL に設定します。
cchMax	DWORD	in	psz パラメーターが指すバッファの長さ(文字数)です。この関数の ANSI 版ではバイト数、Unicode 版では文字数になります。文字列が (cchMax– 1) より長い場合は切り詰められます。psz パラメーターが NULL に設定されている場合、このパラメーターは無視されます。
iCodePage	INT	in	文字列のレンダリングに使用するコードページです。この値は CP_WINANSI または CP_WINUNICODE のいずれかである必要があります。

戻り値の型: DWORD

公式ドキュメント

文字列ハンドルに関連付けられたテキストをバッファにコピーします。(ANSI)

戻り値

型: DWORD

psz パラメーターに有効なポインターが指定された場合、戻り値は返されたテキストの長さ(文字数。終端の null 文字は含みません)です。psz パラメーターに NULL ポインターが指定された場合、戻り値は hsz パラメーターに関連付けられたテキストの長さ(終端の null 文字は含みません)です。エラーが発生した場合、戻り値は 0L です。

解説(Remarks)

バッファに返される文字列は常に null で終端されます。文字列が (cchMax– 1) より長い場合は、文字列の先頭 (cchMax– 1) 文字のみがコピーされます。

psz パラメーターが NULL の場合、DdeQueryString 関数は文字列ハンドルに関連付けられた文字列の長さ(バイト数)を取得します。この長さには終端の null 文字は含まれません。

メモ

ddeml.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DdeQueryString を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

DWORD DdeQueryStringA(
    DWORD idInst,
    HSZ hsz,
    LPSTR psz,   // optional
    DWORD cchMax,
    INT iCodePage
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DdeQueryStringA(
    uint idInst,   // DWORD
    IntPtr hsz,   // HSZ
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder psz,   // LPSTR optional, out
    uint cchMax,   // DWORD
    int iCodePage   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DdeQueryStringA(
    idInst As UInteger,   ' DWORD
    hsz As IntPtr,   ' HSZ
    <MarshalAs(UnmanagedType.LPStr)> psz As System.Text.StringBuilder,   ' LPSTR optional, out
    cchMax As UInteger,   ' DWORD
    iCodePage As Integer   ' INT
) As UInteger
End Function

' idInst : DWORD
' hsz : HSZ
' psz : LPSTR optional, out
' cchMax : DWORD
' iCodePage : INT
Declare PtrSafe Function DdeQueryStringA Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal hsz As LongPtr, _
    ByVal psz As String, _
    ByVal cchMax As Long, _
    ByVal iCodePage As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DdeQueryStringA = ctypes.windll.user32.DdeQueryStringA
DdeQueryStringA.restype = wintypes.DWORD
DdeQueryStringA.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    wintypes.HANDLE,  # hsz : HSZ
    wintypes.LPSTR,  # psz : LPSTR optional, out
    wintypes.DWORD,  # cchMax : DWORD
    ctypes.c_int,  # iCodePage : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeQueryStringA = Fiddle::Function.new(
  lib['DdeQueryStringA'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # hsz : HSZ
    Fiddle::TYPE_VOIDP,  # psz : LPSTR optional, out
    -Fiddle::TYPE_INT,  # cchMax : DWORD
    Fiddle::TYPE_INT,  # iCodePage : INT
  ],
  -Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DdeQueryStringA(
        idInst: u32,  // DWORD
        hsz: *mut core::ffi::c_void,  // HSZ
        psz: *mut u8,  // LPSTR optional, out
        cchMax: u32,  // DWORD
        iCodePage: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern uint DdeQueryStringA(uint idInst, IntPtr hsz, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder psz, uint cchMax, int iCodePage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeQueryStringA' -Namespace Win32 -PassThru
# $api::DdeQueryStringA(idInst, hsz, psz, cchMax, iCodePage)

#uselib "USER32.dll"
#func global DdeQueryStringA "DdeQueryStringA" sptr, sptr, sptr, sptr, sptr
; DdeQueryStringA idInst, hsz, varptr(psz), cchMax, iCodePage   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; hsz : HSZ -> "sptr"
; psz : LPSTR optional, out -> "sptr"
; cchMax : DWORD -> "sptr"
; iCodePage : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DdeQueryStringA "DdeQueryStringA" int, sptr, var, int, int
; res = DdeQueryStringA(idInst, hsz, psz, cchMax, iCodePage)
; idInst : DWORD -> "int"
; hsz : HSZ -> "sptr"
; psz : LPSTR optional, out -> "var"
; cchMax : DWORD -> "int"
; iCodePage : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DdeQueryStringA "DdeQueryStringA" int, sptr, sptr, int, int
; res = DdeQueryStringA(idInst, hsz, varptr(psz), cchMax, iCodePage)
; idInst : DWORD -> "int"
; hsz : HSZ -> "sptr"
; psz : LPSTR optional, out -> "sptr"
; cchMax : DWORD -> "int"
; iCodePage : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。