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

WdsCliFreeStringArray

関数
WDSクライアントが返した文字列配列のメモリを解放する。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WdsCliFreeStringArray(
    LPWSTR* ppwszArray,   // optional
    DWORD ulCount
);

パラメーター

名前方向説明
ppwszArrayLPWSTR*inoutoptional解放対象となる文字列ポインタ配列。
ulCountDWORDinppwszArrayに含まれる文字列の個数。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliFreeStringArray(
    LPWSTR* ppwszArray,   // optional
    DWORD ulCount
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliFreeStringArray(
    IntPtr ppwszArray,   // LPWSTR* optional, in/out
    uint ulCount   // DWORD
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliFreeStringArray(
    ppwszArray As IntPtr,   ' LPWSTR* optional, in/out
    ulCount As UInteger   ' DWORD
) As Integer
End Function
' ppwszArray : LPWSTR* optional, in/out
' ulCount : DWORD
Declare PtrSafe Function WdsCliFreeStringArray Lib "wdsclientapi" ( _
    ByVal ppwszArray As LongPtr, _
    ByVal ulCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliFreeStringArray = ctypes.windll.wdsclientapi.WdsCliFreeStringArray
WdsCliFreeStringArray.restype = ctypes.c_int
WdsCliFreeStringArray.argtypes = [
    ctypes.c_void_p,  # ppwszArray : LPWSTR* optional, in/out
    wintypes.DWORD,  # ulCount : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliFreeStringArray = wdsclientapi.NewProc("WdsCliFreeStringArray")
)

// ppwszArray (LPWSTR* optional, in/out), ulCount (DWORD)
r1, _, err := procWdsCliFreeStringArray.Call(
	uintptr(ppwszArray),
	uintptr(ulCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliFreeStringArray(
  ppwszArray: PPWideChar;   // LPWSTR* optional, in/out
  ulCount: DWORD   // DWORD
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliFreeStringArray';
result := DllCall("WDSCLIENTAPI\WdsCliFreeStringArray"
    , "Ptr", ppwszArray   ; LPWSTR* optional, in/out
    , "UInt", ulCount   ; DWORD
    , "Int")   ; return: HRESULT
●WdsCliFreeStringArray(ppwszArray, ulCount) = DLL("WDSCLIENTAPI.dll", "int WdsCliFreeStringArray(void*, dword)")
# 呼び出し: WdsCliFreeStringArray(ppwszArray, ulCount)
# ppwszArray : LPWSTR* optional, in/out -> "void*"
# ulCount : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WdsCliFreeStringArrayNative = Int32 Function(Pointer<Pointer<Utf16>>, Uint32);
typedef WdsCliFreeStringArrayDart = int Function(Pointer<Pointer<Utf16>>, int);
final WdsCliFreeStringArray = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliFreeStringArrayNative, WdsCliFreeStringArrayDart>('WdsCliFreeStringArray');
// ppwszArray : LPWSTR* optional, in/out -> Pointer<Pointer<Utf16>>
// ulCount : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliFreeStringArray(
  ppwszArray: PPWideChar;   // LPWSTR* optional, in/out
  ulCount: DWORD   // DWORD
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliFreeStringArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliFreeStringArray"
  c_WdsCliFreeStringArray :: Ptr CWString -> Word32 -> IO Int32
-- ppwszArray : LPWSTR* optional, in/out -> Ptr CWString
-- ulCount : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdsclifreestringarray =
  foreign "WdsCliFreeStringArray"
    ((ptr (ptr uint16_t)) @-> uint32_t @-> returning int32_t)
(* ppwszArray : LPWSTR* optional, in/out -> (ptr (ptr uint16_t)) *)
(* ulCount : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliFreeStringArray" wds-cli-free-string-array :convention :stdcall) :int32
  (ppwsz-array :pointer)   ; LPWSTR* optional, in/out
  (ul-count :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliFreeStringArray = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliFreeStringArray(LPVOID ppwszArray, DWORD ulCount)');
# my $ret = $WdsCliFreeStringArray->Call($ppwszArray, $ulCount);
# ppwszArray : LPWSTR* optional, in/out -> LPVOID
# ulCount : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。