Win32 API 日本語リファレンス
ホームSystem.DataExchange › DdeCreateStringHandleA

DdeCreateStringHandleA

関数
文字列からDDE文字列ハンドルを作成する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HSZ DdeCreateStringHandleA(
    DWORD idInst,
    LPCSTR psz,
    INT iCodePage
);

パラメーター

名前方向説明
idInstDWORDin以前の DdeInitialize 関数の呼び出しによって取得したアプリケーション インスタンス識別子です。
pszLPCSTRinハンドルを作成する対象の null 終端文字列です。この文字列は最大 255 文字まで指定できます。この制限は、DDEML の文字列管理関数がアトムを使用して実装されているためです。
iCodePageINTin文字列のレンダリングに使用するコード ページです。この値は、クライアント アプリケーションが DdeInitialize の ANSI 版と Unicode 版のどちらを呼び出したかに応じて、CP_WINANSI (既定のコード ページ) または CP_WINUNICODE のいずれかを指定します。

戻り値の型: HSZ

公式ドキュメント

指定された文字列を識別するハンドルを作成します。ダイナミック データ エクスチェンジ (DDE) のクライアント アプリケーションまたはサーバー アプリケーションは、この文字列ハンドルを他の Dynamic Data Exchange Management Library (DDEML) 関数のパラメーターとして渡すことができます。(ANSI)

戻り値

型: HSZ

関数が成功した場合、戻り値は文字列ハンドルです。

関数が失敗した場合、戻り値は 0L です。

DdeGetLastError 関数を使用してエラー コードを取得できます。エラー コードは次のいずれかの値になります。

解説(Remarks)

文字列ハンドルの値は、それが識別する文字列の大文字小文字とは関係ありません。

アプリケーションが文字列ハンドルを作成するか、コールバック関数でハンドルを受け取り、DdeKeepStringHandle 関数を使用してそれを保持する場合、アプリケーションは不要になった時点でその文字列ハンドルを解放する必要があります。

インスタンス固有の文字列ハンドルは、文字列ハンドルから文字列へ、そして再び文字列ハンドルへとマッピングすることはできません。次の例はこのことを示しています。ここでは DdeQueryString 関数が文字列ハンドルから文字列を作成し、DdeCreateStringHandle がその文字列から文字列ハンドルを作成していますが、2 つのハンドルは同一ではありません。

DWORD idInst; 
DWORD cb; 
HSZ hszInst, hszNew; 
PSZ pszInst; 
 
DdeQueryString(idInst, hszInst, pszInst, cb, CP_WINANSI); 
hszNew = DdeCreateStringHandle(idInst, pszInst, CP_WINANSI); 
// hszNew != hszInst ! 
メモ

ddeml.h ヘッダーは、DdeCreateStringHandle を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコードに依存しないこのエイリアスの使用と、エンコードに依存しないわけではないコードを混在させると、不一致が生じ、コンパイル エラーまたは実行時エラーを引き起こす可能性があります。詳細については、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>

HSZ DdeCreateStringHandleA(
    DWORD idInst,
    LPCSTR psz,
    INT iCodePage
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr DdeCreateStringHandleA(
    uint idInst,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string psz,   // LPCSTR
    int iCodePage   // INT
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DdeCreateStringHandleA(
    idInst As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> psz As String,   ' LPCSTR
    iCodePage As Integer   ' INT
) As IntPtr
End Function
' idInst : DWORD
' psz : LPCSTR
' iCodePage : INT
Declare PtrSafe Function DdeCreateStringHandleA Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal psz As String, _
    ByVal iCodePage As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DdeCreateStringHandleA = ctypes.windll.user32.DdeCreateStringHandleA
DdeCreateStringHandleA.restype = ctypes.c_void_p
DdeCreateStringHandleA.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    wintypes.LPCSTR,  # psz : LPCSTR
    ctypes.c_int,  # iCodePage : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeCreateStringHandleA = Fiddle::Function.new(
  lib['DdeCreateStringHandleA'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # psz : LPCSTR
    Fiddle::TYPE_INT,  # iCodePage : INT
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn DdeCreateStringHandleA(
        idInst: u32,  // DWORD
        psz: *const u8,  // LPCSTR
        iCodePage: i32  // INT
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr DdeCreateStringHandleA(uint idInst, [MarshalAs(UnmanagedType.LPStr)] string psz, int iCodePage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeCreateStringHandleA' -Namespace Win32 -PassThru
# $api::DdeCreateStringHandleA(idInst, psz, iCodePage)
#uselib "USER32.dll"
#func global DdeCreateStringHandleA "DdeCreateStringHandleA" sptr, sptr, sptr
; DdeCreateStringHandleA idInst, psz, iCodePage   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; psz : LPCSTR -> "sptr"
; iCodePage : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global DdeCreateStringHandleA "DdeCreateStringHandleA" int, str, int
; res = DdeCreateStringHandleA(idInst, psz, iCodePage)
; idInst : DWORD -> "int"
; psz : LPCSTR -> "str"
; iCodePage : INT -> "int"
; HSZ DdeCreateStringHandleA(DWORD idInst, LPCSTR psz, INT iCodePage)
#uselib "USER32.dll"
#cfunc global DdeCreateStringHandleA "DdeCreateStringHandleA" int, str, int
; res = DdeCreateStringHandleA(idInst, psz, iCodePage)
; idInst : DWORD -> "int"
; psz : LPCSTR -> "str"
; iCodePage : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeCreateStringHandleA = user32.NewProc("DdeCreateStringHandleA")
)

// idInst (DWORD), psz (LPCSTR), iCodePage (INT)
r1, _, err := procDdeCreateStringHandleA.Call(
	uintptr(idInst),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(psz))),
	uintptr(iCodePage),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HSZ
function DdeCreateStringHandleA(
  idInst: DWORD;   // DWORD
  psz: PAnsiChar;   // LPCSTR
  iCodePage: Integer   // INT
): THandle; stdcall;
  external 'USER32.dll' name 'DdeCreateStringHandleA';
result := DllCall("USER32\DdeCreateStringHandleA"
    , "UInt", idInst   ; DWORD
    , "AStr", psz   ; LPCSTR
    , "Int", iCodePage   ; INT
    , "Ptr")   ; return: HSZ
●DdeCreateStringHandleA(idInst, psz, iCodePage) = DLL("USER32.dll", "void* DdeCreateStringHandleA(dword, char*, int)")
# 呼び出し: DdeCreateStringHandleA(idInst, psz, iCodePage)
# idInst : DWORD -> "dword"
# psz : LPCSTR -> "char*"
# iCodePage : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn DdeCreateStringHandleA(
    idInst: u32, // DWORD
    psz: [*c]const u8, // LPCSTR
    iCodePage: i32 // INT
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc DdeCreateStringHandleA(
    idInst: uint32,  # DWORD
    psz: cstring,  # LPCSTR
    iCodePage: int32  # INT
): pointer {.importc: "DdeCreateStringHandleA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* DdeCreateStringHandleA(
    uint idInst,   // DWORD
    const(char)* psz,   // LPCSTR
    int iCodePage   // INT
);
ccall((:DdeCreateStringHandleA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (UInt32, Cstring, Int32),
      idInst, psz, iCodePage)
# idInst : DWORD -> UInt32
# psz : LPCSTR -> Cstring
# iCodePage : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* DdeCreateStringHandleA(
    uint32_t idInst,
    const char* psz,
    int32_t iCodePage);
]]
local user32 = ffi.load("user32")
-- user32.DdeCreateStringHandleA(idInst, psz, iCodePage)
-- idInst : DWORD
-- psz : LPCSTR
-- iCodePage : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DdeCreateStringHandleA = lib.func('__stdcall', 'DdeCreateStringHandleA', 'void *', ['uint32_t', 'str', 'int32_t']);
// DdeCreateStringHandleA(idInst, psz, iCodePage)
// idInst : DWORD -> 'uint32_t'
// psz : LPCSTR -> 'str'
// iCodePage : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  DdeCreateStringHandleA: { parameters: ["u32", "buffer", "i32"], result: "pointer" },
});
// lib.symbols.DdeCreateStringHandleA(idInst, psz, iCodePage)
// idInst : DWORD -> "u32"
// psz : LPCSTR -> "buffer"
// iCodePage : INT -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* DdeCreateStringHandleA(
    uint32_t idInst,
    const char* psz,
    int32_t iCodePage);
C, "USER32.dll");
// $ffi->DdeCreateStringHandleA(idInst, psz, iCodePage);
// idInst : DWORD
// psz : LPCSTR
// iCodePage : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.ASCII_OPTIONS);
    Pointer DdeCreateStringHandleA(
        int idInst,   // DWORD
        String psz,   // LPCSTR
        int iCodePage   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun DdeCreateStringHandleA = DdeCreateStringHandleA(
    idInst : UInt32,   # DWORD
    psz : UInt8*,   # LPCSTR
    iCodePage : Int32   # INT
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DdeCreateStringHandleANative = Pointer<Void> Function(Uint32, Pointer<Utf8>, Int32);
typedef DdeCreateStringHandleADart = Pointer<Void> Function(int, Pointer<Utf8>, int);
final DdeCreateStringHandleA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DdeCreateStringHandleANative, DdeCreateStringHandleADart>('DdeCreateStringHandleA');
// idInst : DWORD -> Uint32
// psz : LPCSTR -> Pointer<Utf8>
// iCodePage : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DdeCreateStringHandleA(
  idInst: DWORD;   // DWORD
  psz: PAnsiChar;   // LPCSTR
  iCodePage: Integer   // INT
): THandle; stdcall;
  external 'USER32.dll' name 'DdeCreateStringHandleA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DdeCreateStringHandleA"
  c_DdeCreateStringHandleA :: Word32 -> CString -> Int32 -> IO (Ptr ())
-- idInst : DWORD -> Word32
-- psz : LPCSTR -> CString
-- iCodePage : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ddecreatestringhandlea =
  foreign "DdeCreateStringHandleA"
    (uint32_t @-> string @-> int32_t @-> returning (ptr void))
(* idInst : DWORD -> uint32_t *)
(* psz : LPCSTR -> string *)
(* iCodePage : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("DdeCreateStringHandleA" dde-create-string-handle-a :convention :stdcall) :pointer
  (id-inst :uint32)   ; DWORD
  (psz :string)   ; LPCSTR
  (i-code-page :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DdeCreateStringHandleA = Win32::API::More->new('USER32',
    'HANDLE DdeCreateStringHandleA(DWORD idInst, LPCSTR psz, int iCodePage)');
# my $ret = $DdeCreateStringHandleA->Call($idInst, $psz, $iCodePage);
# idInst : DWORD -> DWORD
# psz : LPCSTR -> LPCSTR
# iCodePage : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目