Win32 API 日本語リファレンス
ホームDevices.AllJoyn › alljoyn_interfacedescription_setargdescription

alljoyn_interfacedescription_setargdescription

関数
メンバー引数に説明文を設定する。
DLLMSAJApi.dll呼出規約winapi

シグネチャ

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

QStatus alljoyn_interfacedescription_setargdescription(
    alljoyn_interfacedescription iface,
    LPCSTR member,
    LPCSTR argName,
    LPCSTR description
);

パラメーター

名前方向説明
ifacealljoyn_interfacedescriptionin対象のインターフェース記述ハンドル。
memberLPCSTRin引数が属するメンバーの名前を指すNULL終端文字列。
argNameLPCSTRin説明を設定する対象引数の名前を指すNULL終端文字列。
descriptionLPCSTRin引数に設定する説明文を指すNULL終端文字列。

戻り値の型: QStatus

各言語での呼び出し定義

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

QStatus alljoyn_interfacedescription_setargdescription(
    alljoyn_interfacedescription iface,
    LPCSTR member,
    LPCSTR argName,
    LPCSTR description
);
[DllImport("MSAJApi.dll", ExactSpelling = true)]
static extern int alljoyn_interfacedescription_setargdescription(
    IntPtr iface,   // alljoyn_interfacedescription
    [MarshalAs(UnmanagedType.LPStr)] string member,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string argName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string description   // LPCSTR
);
<DllImport("MSAJApi.dll", ExactSpelling:=True)>
Public Shared Function alljoyn_interfacedescription_setargdescription(
    iface As IntPtr,   ' alljoyn_interfacedescription
    <MarshalAs(UnmanagedType.LPStr)> member As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> argName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> description As String   ' LPCSTR
) As Integer
End Function
' iface : alljoyn_interfacedescription
' member : LPCSTR
' argName : LPCSTR
' description : LPCSTR
Declare PtrSafe Function alljoyn_interfacedescription_setargdescription Lib "msajapi" ( _
    ByVal iface As LongPtr, _
    ByVal member As String, _
    ByVal argName As String, _
    ByVal description As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

alljoyn_interfacedescription_setargdescription = ctypes.windll.msajapi.alljoyn_interfacedescription_setargdescription
alljoyn_interfacedescription_setargdescription.restype = ctypes.c_int
alljoyn_interfacedescription_setargdescription.argtypes = [
    ctypes.c_ssize_t,  # iface : alljoyn_interfacedescription
    wintypes.LPCSTR,  # member : LPCSTR
    wintypes.LPCSTR,  # argName : LPCSTR
    wintypes.LPCSTR,  # description : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSAJApi.dll')
alljoyn_interfacedescription_setargdescription = Fiddle::Function.new(
  lib['alljoyn_interfacedescription_setargdescription'],
  [
    Fiddle::TYPE_INTPTR_T,  # iface : alljoyn_interfacedescription
    Fiddle::TYPE_VOIDP,  # member : LPCSTR
    Fiddle::TYPE_VOIDP,  # argName : LPCSTR
    Fiddle::TYPE_VOIDP,  # description : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "msajapi")]
extern "system" {
    fn alljoyn_interfacedescription_setargdescription(
        iface: isize,  // alljoyn_interfacedescription
        member: *const u8,  // LPCSTR
        argName: *const u8,  // LPCSTR
        description: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MSAJApi.dll")]
public static extern int alljoyn_interfacedescription_setargdescription(IntPtr iface, [MarshalAs(UnmanagedType.LPStr)] string member, [MarshalAs(UnmanagedType.LPStr)] string argName, [MarshalAs(UnmanagedType.LPStr)] string description);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSAJApi_alljoyn_interfacedescription_setargdescription' -Namespace Win32 -PassThru
# $api::alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
#uselib "MSAJApi.dll"
#func global alljoyn_interfacedescription_setargdescription "alljoyn_interfacedescription_setargdescription" sptr, sptr, sptr, sptr
; alljoyn_interfacedescription_setargdescription iface, member, argName, description   ; 戻り値は stat
; iface : alljoyn_interfacedescription -> "sptr"
; member : LPCSTR -> "sptr"
; argName : LPCSTR -> "sptr"
; description : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MSAJApi.dll"
#cfunc global alljoyn_interfacedescription_setargdescription "alljoyn_interfacedescription_setargdescription" sptr, str, str, str
; res = alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
; iface : alljoyn_interfacedescription -> "sptr"
; member : LPCSTR -> "str"
; argName : LPCSTR -> "str"
; description : LPCSTR -> "str"
; QStatus alljoyn_interfacedescription_setargdescription(alljoyn_interfacedescription iface, LPCSTR member, LPCSTR argName, LPCSTR description)
#uselib "MSAJApi.dll"
#cfunc global alljoyn_interfacedescription_setargdescription "alljoyn_interfacedescription_setargdescription" intptr, str, str, str
; res = alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
; iface : alljoyn_interfacedescription -> "intptr"
; member : LPCSTR -> "str"
; argName : LPCSTR -> "str"
; description : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msajapi = windows.NewLazySystemDLL("MSAJApi.dll")
	procalljoyn_interfacedescription_setargdescription = msajapi.NewProc("alljoyn_interfacedescription_setargdescription")
)

// iface (alljoyn_interfacedescription), member (LPCSTR), argName (LPCSTR), description (LPCSTR)
r1, _, err := procalljoyn_interfacedescription_setargdescription.Call(
	uintptr(iface),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(member))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(argName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(description))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // QStatus
function alljoyn_interfacedescription_setargdescription(
  iface: NativeInt;   // alljoyn_interfacedescription
  member: PAnsiChar;   // LPCSTR
  argName: PAnsiChar;   // LPCSTR
  description: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'MSAJApi.dll' name 'alljoyn_interfacedescription_setargdescription';
result := DllCall("MSAJApi\alljoyn_interfacedescription_setargdescription"
    , "Ptr", iface   ; alljoyn_interfacedescription
    , "AStr", member   ; LPCSTR
    , "AStr", argName   ; LPCSTR
    , "AStr", description   ; LPCSTR
    , "Int")   ; return: QStatus
●alljoyn_interfacedescription_setargdescription(iface, member, argName, description) = DLL("MSAJApi.dll", "int alljoyn_interfacedescription_setargdescription(int, char*, char*, char*)")
# 呼び出し: alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
# iface : alljoyn_interfacedescription -> "int"
# member : LPCSTR -> "char*"
# argName : LPCSTR -> "char*"
# description : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msajapi" fn alljoyn_interfacedescription_setargdescription(
    iface: isize, // alljoyn_interfacedescription
    member: [*c]const u8, // LPCSTR
    argName: [*c]const u8, // LPCSTR
    description: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc alljoyn_interfacedescription_setargdescription(
    iface: int,  # alljoyn_interfacedescription
    member: cstring,  # LPCSTR
    argName: cstring,  # LPCSTR
    description: cstring  # LPCSTR
): int32 {.importc: "alljoyn_interfacedescription_setargdescription", stdcall, dynlib: "MSAJApi.dll".}
pragma(lib, "msajapi");
extern(Windows)
int alljoyn_interfacedescription_setargdescription(
    ptrdiff_t iface,   // alljoyn_interfacedescription
    const(char)* member,   // LPCSTR
    const(char)* argName,   // LPCSTR
    const(char)* description   // LPCSTR
);
ccall((:alljoyn_interfacedescription_setargdescription, "MSAJApi.dll"), stdcall, Int32,
      (Int, Cstring, Cstring, Cstring),
      iface, member, argName, description)
# iface : alljoyn_interfacedescription -> Int
# member : LPCSTR -> Cstring
# argName : LPCSTR -> Cstring
# description : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t alljoyn_interfacedescription_setargdescription(
    intptr_t iface,
    const char* member,
    const char* argName,
    const char* description);
]]
local msajapi = ffi.load("msajapi")
-- msajapi.alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
-- iface : alljoyn_interfacedescription
-- member : LPCSTR
-- argName : LPCSTR
-- description : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MSAJApi.dll');
const alljoyn_interfacedescription_setargdescription = lib.func('__stdcall', 'alljoyn_interfacedescription_setargdescription', 'int32_t', ['intptr_t', 'str', 'str', 'str']);
// alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
// iface : alljoyn_interfacedescription -> 'intptr_t'
// member : LPCSTR -> 'str'
// argName : LPCSTR -> 'str'
// description : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MSAJApi.dll", {
  alljoyn_interfacedescription_setargdescription: { parameters: ["isize", "buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.alljoyn_interfacedescription_setargdescription(iface, member, argName, description)
// iface : alljoyn_interfacedescription -> "isize"
// member : LPCSTR -> "buffer"
// argName : LPCSTR -> "buffer"
// description : LPCSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t alljoyn_interfacedescription_setargdescription(
    intptr_t iface,
    const char* member,
    const char* argName,
    const char* description);
C, "MSAJApi.dll");
// $ffi->alljoyn_interfacedescription_setargdescription(iface, member, argName, description);
// iface : alljoyn_interfacedescription
// member : LPCSTR
// argName : LPCSTR
// description : LPCSTR
// 構造体/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 Msajapi extends StdCallLibrary {
    Msajapi INSTANCE = Native.load("msajapi", Msajapi.class);
    int alljoyn_interfacedescription_setargdescription(
        long iface,   // alljoyn_interfacedescription
        String member,   // LPCSTR
        String argName,   // LPCSTR
        String description   // LPCSTR
    );
}
@[Link("msajapi")]
lib LibMSAJApi
  fun alljoyn_interfacedescription_setargdescription = alljoyn_interfacedescription_setargdescription(
    iface : LibC::SSizeT,   # alljoyn_interfacedescription
    member : UInt8*,   # LPCSTR
    argName : UInt8*,   # LPCSTR
    description : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef alljoyn_interfacedescription_setargdescriptionNative = Int32 Function(IntPtr, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef alljoyn_interfacedescription_setargdescriptionDart = int Function(int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final alljoyn_interfacedescription_setargdescription = DynamicLibrary.open('MSAJApi.dll')
    .lookupFunction<alljoyn_interfacedescription_setargdescriptionNative, alljoyn_interfacedescription_setargdescriptionDart>('alljoyn_interfacedescription_setargdescription');
// iface : alljoyn_interfacedescription -> IntPtr
// member : LPCSTR -> Pointer<Utf8>
// argName : LPCSTR -> Pointer<Utf8>
// description : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function alljoyn_interfacedescription_setargdescription(
  iface: NativeInt;   // alljoyn_interfacedescription
  member: PAnsiChar;   // LPCSTR
  argName: PAnsiChar;   // LPCSTR
  description: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'MSAJApi.dll' name 'alljoyn_interfacedescription_setargdescription';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "alljoyn_interfacedescription_setargdescription"
  c_alljoyn_interfacedescription_setargdescription :: CIntPtr -> CString -> CString -> CString -> IO Int32
-- iface : alljoyn_interfacedescription -> CIntPtr
-- member : LPCSTR -> CString
-- argName : LPCSTR -> CString
-- description : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let alljoyn_interfacedescription_setargdescription =
  foreign "alljoyn_interfacedescription_setargdescription"
    (intptr_t @-> string @-> string @-> string @-> returning int32_t)
(* iface : alljoyn_interfacedescription -> intptr_t *)
(* member : LPCSTR -> string *)
(* argName : LPCSTR -> string *)
(* description : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msajapi (t "MSAJApi.dll"))
(cffi:use-foreign-library msajapi)

(cffi:defcfun ("alljoyn_interfacedescription_setargdescription" alljoyn-interfacedescription-setargdescription :convention :stdcall) :int32
  (iface :int64)   ; alljoyn_interfacedescription
  (member :string)   ; LPCSTR
  (arg-name :string)   ; LPCSTR
  (description :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $alljoyn_interfacedescription_setargdescription = Win32::API::More->new('MSAJApi',
    'int alljoyn_interfacedescription_setargdescription(LPARAM iface, LPCSTR member, LPCSTR argName, LPCSTR description)');
# my $ret = $alljoyn_interfacedescription_setargdescription->Call($iface, $member, $argName, $description);
# iface : alljoyn_interfacedescription -> LPARAM
# member : LPCSTR -> LPCSTR
# argName : LPCSTR -> LPCSTR
# description : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型