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

NPFormatNetworkName

関数
リモート名を表示用のネットワーク名へ整形する。
DLLdavclnt.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NPFormatNetworkName(
    LPWSTR lpRemoteName,
    LPWSTR lpFormattedName,
    DWORD* lpnLength,
    NETWORK_NAME_FORMAT_FLAGS dwFlags,
    DWORD dwAveCharPerLine
);

パラメーター

名前方向説明
lpRemoteNameLPWSTRin整形対象のリモートネットワーク名のワイド文字列。
lpFormattedNameLPWSTRout表示用に整形されたネットワーク名を受け取るワイドバッファ。
lpnLengthDWORD*inoutlpFormattedNameの文字数を入出力で渡し、必要量を受け取る。
dwFlagsNETWORK_NAME_FORMAT_FLAGSin名前整形動作を制御するフラグ(省略形/抽象化など)。
dwAveCharPerLineDWORDin1行あたりの平均文字数。整形時の改行判断に用いる。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD NPFormatNetworkName(
    LPWSTR lpRemoteName,
    LPWSTR lpFormattedName,
    DWORD* lpnLength,
    NETWORK_NAME_FORMAT_FLAGS dwFlags,
    DWORD dwAveCharPerLine
);
[DllImport("davclnt.dll", ExactSpelling = true)]
static extern uint NPFormatNetworkName(
    [MarshalAs(UnmanagedType.LPWStr)] string lpRemoteName,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFormattedName,   // LPWSTR out
    ref uint lpnLength,   // DWORD* in/out
    uint dwFlags,   // NETWORK_NAME_FORMAT_FLAGS
    uint dwAveCharPerLine   // DWORD
);
<DllImport("davclnt.dll", ExactSpelling:=True)>
Public Shared Function NPFormatNetworkName(
    <MarshalAs(UnmanagedType.LPWStr)> lpRemoteName As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpFormattedName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpnLength As UInteger,   ' DWORD* in/out
    dwFlags As UInteger,   ' NETWORK_NAME_FORMAT_FLAGS
    dwAveCharPerLine As UInteger   ' DWORD
) As UInteger
End Function
' lpRemoteName : LPWSTR
' lpFormattedName : LPWSTR out
' lpnLength : DWORD* in/out
' dwFlags : NETWORK_NAME_FORMAT_FLAGS
' dwAveCharPerLine : DWORD
Declare PtrSafe Function NPFormatNetworkName Lib "davclnt" ( _
    ByVal lpRemoteName As LongPtr, _
    ByVal lpFormattedName As LongPtr, _
    ByRef lpnLength As Long, _
    ByVal dwFlags As Long, _
    ByVal dwAveCharPerLine As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NPFormatNetworkName = ctypes.windll.davclnt.NPFormatNetworkName
NPFormatNetworkName.restype = wintypes.DWORD
NPFormatNetworkName.argtypes = [
    wintypes.LPCWSTR,  # lpRemoteName : LPWSTR
    wintypes.LPWSTR,  # lpFormattedName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpnLength : DWORD* in/out
    wintypes.DWORD,  # dwFlags : NETWORK_NAME_FORMAT_FLAGS
    wintypes.DWORD,  # dwAveCharPerLine : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	davclnt = windows.NewLazySystemDLL("davclnt.dll")
	procNPFormatNetworkName = davclnt.NewProc("NPFormatNetworkName")
)

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

extern "davclnt" fn NPFormatNetworkName(
    lpRemoteName: [*c]const u16, // LPWSTR
    lpFormattedName: [*c]u16, // LPWSTR out
    lpnLength: [*c]u32, // DWORD* in/out
    dwFlags: u32, // NETWORK_NAME_FORMAT_FLAGS
    dwAveCharPerLine: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc NPFormatNetworkName(
    lpRemoteName: WideCString,  # LPWSTR
    lpFormattedName: ptr uint16,  # LPWSTR out
    lpnLength: ptr uint32,  # DWORD* in/out
    dwFlags: uint32,  # NETWORK_NAME_FORMAT_FLAGS
    dwAveCharPerLine: uint32  # DWORD
): uint32 {.importc: "NPFormatNetworkName", stdcall, dynlib: "davclnt.dll".}
pragma(lib, "davclnt");
extern(Windows)
uint NPFormatNetworkName(
    const(wchar)* lpRemoteName,   // LPWSTR
    wchar* lpFormattedName,   // LPWSTR out
    uint* lpnLength,   // DWORD* in/out
    uint dwFlags,   // NETWORK_NAME_FORMAT_FLAGS
    uint dwAveCharPerLine   // DWORD
);
ccall((:NPFormatNetworkName, "davclnt.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt16}, Ptr{UInt32}, UInt32, UInt32),
      lpRemoteName, lpFormattedName, lpnLength, dwFlags, dwAveCharPerLine)
# lpRemoteName : LPWSTR -> Cwstring
# lpFormattedName : LPWSTR out -> Ptr{UInt16}
# lpnLength : DWORD* in/out -> Ptr{UInt32}
# dwFlags : NETWORK_NAME_FORMAT_FLAGS -> UInt32
# dwAveCharPerLine : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NPFormatNetworkName(
    const uint16_t* lpRemoteName,
    uint16_t* lpFormattedName,
    uint32_t* lpnLength,
    uint32_t dwFlags,
    uint32_t dwAveCharPerLine);
]]
local davclnt = ffi.load("davclnt")
-- davclnt.NPFormatNetworkName(lpRemoteName, lpFormattedName, lpnLength, dwFlags, dwAveCharPerLine)
-- lpRemoteName : LPWSTR
-- lpFormattedName : LPWSTR out
-- lpnLength : DWORD* in/out
-- dwFlags : NETWORK_NAME_FORMAT_FLAGS
-- dwAveCharPerLine : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('davclnt.dll');
const NPFormatNetworkName = lib.func('__stdcall', 'NPFormatNetworkName', 'uint32_t', ['str16', 'uint16_t *', 'uint32_t *', 'uint32_t', 'uint32_t']);
// NPFormatNetworkName(lpRemoteName, lpFormattedName, lpnLength, dwFlags, dwAveCharPerLine)
// lpRemoteName : LPWSTR -> 'str16'
// lpFormattedName : LPWSTR out -> 'uint16_t *'
// lpnLength : DWORD* in/out -> 'uint32_t *'
// dwFlags : NETWORK_NAME_FORMAT_FLAGS -> 'uint32_t'
// dwAveCharPerLine : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("davclnt.dll", {
  NPFormatNetworkName: { parameters: ["buffer", "buffer", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.NPFormatNetworkName(lpRemoteName, lpFormattedName, lpnLength, dwFlags, dwAveCharPerLine)
// lpRemoteName : LPWSTR -> "buffer"
// lpFormattedName : LPWSTR out -> "buffer"
// lpnLength : DWORD* in/out -> "pointer"
// dwFlags : NETWORK_NAME_FORMAT_FLAGS -> "u32"
// dwAveCharPerLine : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NPFormatNetworkName(
    const uint16_t* lpRemoteName,
    uint16_t* lpFormattedName,
    uint32_t* lpnLength,
    uint32_t dwFlags,
    uint32_t dwAveCharPerLine);
C, "davclnt.dll");
// $ffi->NPFormatNetworkName(lpRemoteName, lpFormattedName, lpnLength, dwFlags, dwAveCharPerLine);
// lpRemoteName : LPWSTR
// lpFormattedName : LPWSTR out
// lpnLength : DWORD* in/out
// dwFlags : NETWORK_NAME_FORMAT_FLAGS
// dwAveCharPerLine : 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 Davclnt extends StdCallLibrary {
    Davclnt INSTANCE = Native.load("davclnt", Davclnt.class);
    int NPFormatNetworkName(
        WString lpRemoteName,   // LPWSTR
        char[] lpFormattedName,   // LPWSTR out
        IntByReference lpnLength,   // DWORD* in/out
        int dwFlags,   // NETWORK_NAME_FORMAT_FLAGS
        int dwAveCharPerLine   // DWORD
    );
}
@[Link("davclnt")]
lib Libdavclnt
  fun NPFormatNetworkName = NPFormatNetworkName(
    lpRemoteName : UInt16*,   # LPWSTR
    lpFormattedName : UInt16*,   # LPWSTR out
    lpnLength : UInt32*,   # DWORD* in/out
    dwFlags : UInt32,   # NETWORK_NAME_FORMAT_FLAGS
    dwAveCharPerLine : 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 NPFormatNetworkNameNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Uint32, Uint32);
typedef NPFormatNetworkNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, int, int);
final NPFormatNetworkName = DynamicLibrary.open('davclnt.dll')
    .lookupFunction<NPFormatNetworkNameNative, NPFormatNetworkNameDart>('NPFormatNetworkName');
// lpRemoteName : LPWSTR -> Pointer<Utf16>
// lpFormattedName : LPWSTR out -> Pointer<Utf16>
// lpnLength : DWORD* in/out -> Pointer<Uint32>
// dwFlags : NETWORK_NAME_FORMAT_FLAGS -> Uint32
// dwAveCharPerLine : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NPFormatNetworkName(
  lpRemoteName: PWideChar;   // LPWSTR
  lpFormattedName: PWideChar;   // LPWSTR out
  lpnLength: Pointer;   // DWORD* in/out
  dwFlags: DWORD;   // NETWORK_NAME_FORMAT_FLAGS
  dwAveCharPerLine: DWORD   // DWORD
): DWORD; stdcall;
  external 'davclnt.dll' name 'NPFormatNetworkName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NPFormatNetworkName"
  c_NPFormatNetworkName :: CWString -> CWString -> Ptr Word32 -> Word32 -> Word32 -> IO Word32
-- lpRemoteName : LPWSTR -> CWString
-- lpFormattedName : LPWSTR out -> CWString
-- lpnLength : DWORD* in/out -> Ptr Word32
-- dwFlags : NETWORK_NAME_FORMAT_FLAGS -> Word32
-- dwAveCharPerLine : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let npformatnetworkname =
  foreign "NPFormatNetworkName"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* lpRemoteName : LPWSTR -> (ptr uint16_t) *)
(* lpFormattedName : LPWSTR out -> (ptr uint16_t) *)
(* lpnLength : DWORD* in/out -> (ptr uint32_t) *)
(* dwFlags : NETWORK_NAME_FORMAT_FLAGS -> uint32_t *)
(* dwAveCharPerLine : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library davclnt (t "davclnt.dll"))
(cffi:use-foreign-library davclnt)

(cffi:defcfun ("NPFormatNetworkName" npformat-network-name :convention :stdcall) :uint32
  (lp-remote-name (:string :encoding :utf-16le))   ; LPWSTR
  (lp-formatted-name :pointer)   ; LPWSTR out
  (lpn-length :pointer)   ; DWORD* in/out
  (dw-flags :uint32)   ; NETWORK_NAME_FORMAT_FLAGS
  (dw-ave-char-per-line :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NPFormatNetworkName = Win32::API::More->new('davclnt',
    'DWORD NPFormatNetworkName(LPCWSTR lpRemoteName, LPWSTR lpFormattedName, LPVOID lpnLength, DWORD dwFlags, DWORD dwAveCharPerLine)');
# my $ret = $NPFormatNetworkName->Call($lpRemoteName, $lpFormattedName, $lpnLength, $dwFlags, $dwAveCharPerLine);
# lpRemoteName : LPWSTR -> LPCWSTR
# lpFormattedName : LPWSTR out -> LPWSTR
# lpnLength : DWORD* in/out -> LPVOID
# dwFlags : NETWORK_NAME_FORMAT_FLAGS -> DWORD
# dwAveCharPerLine : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型