Win32 API 日本語リファレンス
ホームNetworkManagement.Rras › MprConfigGetFriendlyName

MprConfigGetFriendlyName

関数
GUID名からインターフェイスのフレンドリ名を取得する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MprConfigGetFriendlyName(
    HANDLE hMprConfig,
    LPWSTR pszGuidName,
    LPWSTR pszBuffer,
    DWORD dwBufferSize
);

パラメーター

名前方向説明
hMprConfigHANDLEinMprConfigServerConnectで取得した構成ハンドル。
pszGuidNameLPWSTRin変換元のGUID形式インターフェイス名を指すUnicode文字列。
pszBufferLPWSTRout対応するフレンドリ名を受け取るバッファ。
dwBufferSizeDWORDinpszBufferのサイズ(バイト単位)。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MprConfigGetFriendlyName(
    HANDLE hMprConfig,
    LPWSTR pszGuidName,
    LPWSTR pszBuffer,
    DWORD dwBufferSize
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprConfigGetFriendlyName(
    IntPtr hMprConfig,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszGuidName,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuffer,   // LPWSTR out
    uint dwBufferSize   // DWORD
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprConfigGetFriendlyName(
    hMprConfig As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszGuidName As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszBuffer As System.Text.StringBuilder,   ' LPWSTR out
    dwBufferSize As UInteger   ' DWORD
) As UInteger
End Function
' hMprConfig : HANDLE
' pszGuidName : LPWSTR
' pszBuffer : LPWSTR out
' dwBufferSize : DWORD
Declare PtrSafe Function MprConfigGetFriendlyName Lib "mprapi" ( _
    ByVal hMprConfig As LongPtr, _
    ByVal pszGuidName As LongPtr, _
    ByVal pszBuffer As LongPtr, _
    ByVal dwBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MprConfigGetFriendlyName = ctypes.windll.mprapi.MprConfigGetFriendlyName
MprConfigGetFriendlyName.restype = wintypes.DWORD
MprConfigGetFriendlyName.argtypes = [
    wintypes.HANDLE,  # hMprConfig : HANDLE
    wintypes.LPCWSTR,  # pszGuidName : LPWSTR
    wintypes.LPWSTR,  # pszBuffer : LPWSTR out
    wintypes.DWORD,  # dwBufferSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprConfigGetFriendlyName = Fiddle::Function.new(
  lib['MprConfigGetFriendlyName'],
  [
    Fiddle::TYPE_VOIDP,  # hMprConfig : HANDLE
    Fiddle::TYPE_VOIDP,  # pszGuidName : LPWSTR
    Fiddle::TYPE_VOIDP,  # pszBuffer : LPWSTR out
    -Fiddle::TYPE_INT,  # dwBufferSize : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprConfigGetFriendlyName(
        hMprConfig: *mut core::ffi::c_void,  // HANDLE
        pszGuidName: *mut u16,  // LPWSTR
        pszBuffer: *mut u16,  // LPWSTR out
        dwBufferSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPRAPI.dll")]
public static extern uint MprConfigGetFriendlyName(IntPtr hMprConfig, [MarshalAs(UnmanagedType.LPWStr)] string pszGuidName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuffer, uint dwBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprConfigGetFriendlyName' -Namespace Win32 -PassThru
# $api::MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
#uselib "MPRAPI.dll"
#func global MprConfigGetFriendlyName "MprConfigGetFriendlyName" sptr, sptr, sptr, sptr
; MprConfigGetFriendlyName hMprConfig, pszGuidName, varptr(pszBuffer), dwBufferSize   ; 戻り値は stat
; hMprConfig : HANDLE -> "sptr"
; pszGuidName : LPWSTR -> "sptr"
; pszBuffer : LPWSTR out -> "sptr"
; dwBufferSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPRAPI.dll"
#cfunc global MprConfigGetFriendlyName "MprConfigGetFriendlyName" sptr, wstr, var, int
; res = MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
; hMprConfig : HANDLE -> "sptr"
; pszGuidName : LPWSTR -> "wstr"
; pszBuffer : LPWSTR out -> "var"
; dwBufferSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MprConfigGetFriendlyName(HANDLE hMprConfig, LPWSTR pszGuidName, LPWSTR pszBuffer, DWORD dwBufferSize)
#uselib "MPRAPI.dll"
#cfunc global MprConfigGetFriendlyName "MprConfigGetFriendlyName" intptr, wstr, var, int
; res = MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
; hMprConfig : HANDLE -> "intptr"
; pszGuidName : LPWSTR -> "wstr"
; pszBuffer : LPWSTR out -> "var"
; dwBufferSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprConfigGetFriendlyName = mprapi.NewProc("MprConfigGetFriendlyName")
)

// hMprConfig (HANDLE), pszGuidName (LPWSTR), pszBuffer (LPWSTR out), dwBufferSize (DWORD)
r1, _, err := procMprConfigGetFriendlyName.Call(
	uintptr(hMprConfig),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszGuidName))),
	uintptr(pszBuffer),
	uintptr(dwBufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MprConfigGetFriendlyName(
  hMprConfig: THandle;   // HANDLE
  pszGuidName: PWideChar;   // LPWSTR
  pszBuffer: PWideChar;   // LPWSTR out
  dwBufferSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprConfigGetFriendlyName';
result := DllCall("MPRAPI\MprConfigGetFriendlyName"
    , "Ptr", hMprConfig   ; HANDLE
    , "WStr", pszGuidName   ; LPWSTR
    , "Ptr", pszBuffer   ; LPWSTR out
    , "UInt", dwBufferSize   ; DWORD
    , "UInt")   ; return: DWORD
●MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize) = DLL("MPRAPI.dll", "dword MprConfigGetFriendlyName(void*, char*, char*, dword)")
# 呼び出し: MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
# hMprConfig : HANDLE -> "void*"
# pszGuidName : LPWSTR -> "char*"
# pszBuffer : LPWSTR out -> "char*"
# dwBufferSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "mprapi" fn MprConfigGetFriendlyName(
    hMprConfig: ?*anyopaque, // HANDLE
    pszGuidName: [*c]const u16, // LPWSTR
    pszBuffer: [*c]u16, // LPWSTR out
    dwBufferSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc MprConfigGetFriendlyName(
    hMprConfig: pointer,  # HANDLE
    pszGuidName: WideCString,  # LPWSTR
    pszBuffer: ptr uint16,  # LPWSTR out
    dwBufferSize: uint32  # DWORD
): uint32 {.importc: "MprConfigGetFriendlyName", stdcall, dynlib: "MPRAPI.dll".}
pragma(lib, "mprapi");
extern(Windows)
uint MprConfigGetFriendlyName(
    void* hMprConfig,   // HANDLE
    const(wchar)* pszGuidName,   // LPWSTR
    wchar* pszBuffer,   // LPWSTR out
    uint dwBufferSize   // DWORD
);
ccall((:MprConfigGetFriendlyName, "MPRAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, Ptr{UInt16}, UInt32),
      hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
# hMprConfig : HANDLE -> Ptr{Cvoid}
# pszGuidName : LPWSTR -> Cwstring
# pszBuffer : LPWSTR out -> Ptr{UInt16}
# dwBufferSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MprConfigGetFriendlyName(
    void* hMprConfig,
    const uint16_t* pszGuidName,
    uint16_t* pszBuffer,
    uint32_t dwBufferSize);
]]
local mprapi = ffi.load("mprapi")
-- mprapi.MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
-- hMprConfig : HANDLE
-- pszGuidName : LPWSTR
-- pszBuffer : LPWSTR out
-- dwBufferSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MPRAPI.dll');
const MprConfigGetFriendlyName = lib.func('__stdcall', 'MprConfigGetFriendlyName', 'uint32_t', ['void *', 'str16', 'uint16_t *', 'uint32_t']);
// MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
// hMprConfig : HANDLE -> 'void *'
// pszGuidName : LPWSTR -> 'str16'
// pszBuffer : LPWSTR out -> 'uint16_t *'
// dwBufferSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPRAPI.dll", {
  MprConfigGetFriendlyName: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize)
// hMprConfig : HANDLE -> "pointer"
// pszGuidName : LPWSTR -> "buffer"
// pszBuffer : LPWSTR out -> "buffer"
// dwBufferSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MprConfigGetFriendlyName(
    void* hMprConfig,
    const uint16_t* pszGuidName,
    uint16_t* pszBuffer,
    uint32_t dwBufferSize);
C, "MPRAPI.dll");
// $ffi->MprConfigGetFriendlyName(hMprConfig, pszGuidName, pszBuffer, dwBufferSize);
// hMprConfig : HANDLE
// pszGuidName : LPWSTR
// pszBuffer : LPWSTR out
// dwBufferSize : DWORD
// 構造体/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 Mprapi extends StdCallLibrary {
    Mprapi INSTANCE = Native.load("mprapi", Mprapi.class);
    int MprConfigGetFriendlyName(
        Pointer hMprConfig,   // HANDLE
        WString pszGuidName,   // LPWSTR
        char[] pszBuffer,   // LPWSTR out
        int dwBufferSize   // DWORD
    );
}
@[Link("mprapi")]
lib LibMPRAPI
  fun MprConfigGetFriendlyName = MprConfigGetFriendlyName(
    hMprConfig : Void*,   # HANDLE
    pszGuidName : UInt16*,   # LPWSTR
    pszBuffer : UInt16*,   # LPWSTR out
    dwBufferSize : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MprConfigGetFriendlyNameNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef MprConfigGetFriendlyNameDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final MprConfigGetFriendlyName = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprConfigGetFriendlyNameNative, MprConfigGetFriendlyNameDart>('MprConfigGetFriendlyName');
// hMprConfig : HANDLE -> Pointer<Void>
// pszGuidName : LPWSTR -> Pointer<Utf16>
// pszBuffer : LPWSTR out -> Pointer<Utf16>
// dwBufferSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprConfigGetFriendlyName(
  hMprConfig: THandle;   // HANDLE
  pszGuidName: PWideChar;   // LPWSTR
  pszBuffer: PWideChar;   // LPWSTR out
  dwBufferSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprConfigGetFriendlyName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprConfigGetFriendlyName"
  c_MprConfigGetFriendlyName :: Ptr () -> CWString -> CWString -> Word32 -> IO Word32
-- hMprConfig : HANDLE -> Ptr ()
-- pszGuidName : LPWSTR -> CWString
-- pszBuffer : LPWSTR out -> CWString
-- dwBufferSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mprconfiggetfriendlyname =
  foreign "MprConfigGetFriendlyName"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hMprConfig : HANDLE -> (ptr void) *)
(* pszGuidName : LPWSTR -> (ptr uint16_t) *)
(* pszBuffer : LPWSTR out -> (ptr uint16_t) *)
(* dwBufferSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprConfigGetFriendlyName" mpr-config-get-friendly-name :convention :stdcall) :uint32
  (h-mpr-config :pointer)   ; HANDLE
  (psz-guid-name (:string :encoding :utf-16le))   ; LPWSTR
  (psz-buffer :pointer)   ; LPWSTR out
  (dw-buffer-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprConfigGetFriendlyName = Win32::API::More->new('MPRAPI',
    'DWORD MprConfigGetFriendlyName(HANDLE hMprConfig, LPCWSTR pszGuidName, LPWSTR pszBuffer, DWORD dwBufferSize)');
# my $ret = $MprConfigGetFriendlyName->Call($hMprConfig, $pszGuidName, $pszBuffer, $dwBufferSize);
# hMprConfig : HANDLE -> HANDLE
# pszGuidName : LPWSTR -> LPCWSTR
# pszBuffer : LPWSTR out -> LPWSTR
# dwBufferSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。