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
ulCountDWORDin

戻り値の型: 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)。