Win32 API 日本語リファレンス
ホームStorage.Packaging.Appx › GetPackagesByPackageFamily

GetPackagesByPackageFamily

関数
ファミリ名に属するパッケージフルネーム一覧を取得する。
DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

WIN32_ERROR GetPackagesByPackageFamily(
    LPCWSTR packageFamilyName,
    DWORD* count,
    LPWSTR* packageFullNames,   // optional
    DWORD* bufferLength,
    LPWSTR buffer   // optional
);

パラメーター

名前方向説明
packageFamilyNameLPCWSTRin列挙対象のパッケージファミリ名文字列。
countDWORD*inout入力でpackageFullNames配列の容量、出力で実際の件数を受け取る入出力ポインタ。
packageFullNamesLPWSTR*outoptional各パッケージフルネームへのポインタ配列を受け取る出力バッファ。
bufferLengthDWORD*inout入力でbufferの文字数、出力で必要文字数を受け取る入出力ポインタ。
bufferLPWSTRoutoptionalフルネーム文字列本体を格納する出力文字バッファ。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR GetPackagesByPackageFamily(
    LPCWSTR packageFamilyName,
    DWORD* count,
    LPWSTR* packageFullNames,   // optional
    DWORD* bufferLength,
    LPWSTR buffer   // optional
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint GetPackagesByPackageFamily(
    [MarshalAs(UnmanagedType.LPWStr)] string packageFamilyName,   // LPCWSTR
    ref uint count,   // DWORD* in/out
    IntPtr packageFullNames,   // LPWSTR* optional, out
    ref uint bufferLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder buffer   // LPWSTR optional, out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetPackagesByPackageFamily(
    <MarshalAs(UnmanagedType.LPWStr)> packageFamilyName As String,   ' LPCWSTR
    ByRef count As UInteger,   ' DWORD* in/out
    packageFullNames As IntPtr,   ' LPWSTR* optional, out
    ByRef bufferLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> buffer As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function
' packageFamilyName : LPCWSTR
' count : DWORD* in/out
' packageFullNames : LPWSTR* optional, out
' bufferLength : DWORD* in/out
' buffer : LPWSTR optional, out
Declare PtrSafe Function GetPackagesByPackageFamily Lib "kernel32" ( _
    ByVal packageFamilyName As LongPtr, _
    ByRef count As Long, _
    ByVal packageFullNames As LongPtr, _
    ByRef bufferLength As Long, _
    ByVal buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetPackagesByPackageFamily = ctypes.windll.kernel32.GetPackagesByPackageFamily
GetPackagesByPackageFamily.restype = wintypes.DWORD
GetPackagesByPackageFamily.argtypes = [
    wintypes.LPCWSTR,  # packageFamilyName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # count : DWORD* in/out
    ctypes.c_void_p,  # packageFullNames : LPWSTR* optional, out
    ctypes.POINTER(wintypes.DWORD),  # bufferLength : DWORD* in/out
    wintypes.LPWSTR,  # buffer : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetPackagesByPackageFamily = kernel32.NewProc("GetPackagesByPackageFamily")
)

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

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

typedef GetPackagesByPackageFamilyNative = Uint32 Function(Pointer<Utf16>, Pointer<Uint32>, Pointer<Pointer<Utf16>>, Pointer<Uint32>, Pointer<Utf16>);
typedef GetPackagesByPackageFamilyDart = int Function(Pointer<Utf16>, Pointer<Uint32>, Pointer<Pointer<Utf16>>, Pointer<Uint32>, Pointer<Utf16>);
final GetPackagesByPackageFamily = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetPackagesByPackageFamilyNative, GetPackagesByPackageFamilyDart>('GetPackagesByPackageFamily');
// packageFamilyName : LPCWSTR -> Pointer<Utf16>
// count : DWORD* in/out -> Pointer<Uint32>
// packageFullNames : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// bufferLength : DWORD* in/out -> Pointer<Uint32>
// buffer : LPWSTR optional, out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetPackagesByPackageFamily(
  packageFamilyName: PWideChar;   // LPCWSTR
  count: Pointer;   // DWORD* in/out
  packageFullNames: PPWideChar;   // LPWSTR* optional, out
  bufferLength: Pointer;   // DWORD* in/out
  buffer: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetPackagesByPackageFamily';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetPackagesByPackageFamily"
  c_GetPackagesByPackageFamily :: CWString -> Ptr Word32 -> Ptr CWString -> Ptr Word32 -> CWString -> IO Word32
-- packageFamilyName : LPCWSTR -> CWString
-- count : DWORD* in/out -> Ptr Word32
-- packageFullNames : LPWSTR* optional, out -> Ptr CWString
-- bufferLength : DWORD* in/out -> Ptr Word32
-- buffer : LPWSTR optional, out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getpackagesbypackagefamily =
  foreign "GetPackagesByPackageFamily"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> (ptr (ptr uint16_t)) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* packageFamilyName : LPCWSTR -> (ptr uint16_t) *)
(* count : DWORD* in/out -> (ptr uint32_t) *)
(* packageFullNames : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* bufferLength : DWORD* in/out -> (ptr uint32_t) *)
(* buffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetPackagesByPackageFamily" get-packages-by-package-family :convention :stdcall) :uint32
  (package-family-name (:string :encoding :utf-16le))   ; LPCWSTR
  (count :pointer)   ; DWORD* in/out
  (package-full-names :pointer)   ; LPWSTR* optional, out
  (buffer-length :pointer)   ; DWORD* in/out
  (buffer :pointer))   ; LPWSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPackagesByPackageFamily = Win32::API::More->new('KERNEL32',
    'DWORD GetPackagesByPackageFamily(LPCWSTR packageFamilyName, LPVOID count, LPVOID packageFullNames, LPVOID bufferLength, LPWSTR buffer)');
# my $ret = $GetPackagesByPackageFamily->Call($packageFamilyName, $count, $packageFullNames, $bufferLength, $buffer);
# packageFamilyName : LPCWSTR -> LPCWSTR
# count : DWORD* in/out -> LPVOID
# packageFullNames : LPWSTR* optional, out -> LPVOID
# bufferLength : DWORD* in/out -> LPVOID
# buffer : LPWSTR optional, out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型