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

PackageFamilyNameFromId

関数
パッケージIDからパッケージファミリ名を生成する。
DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

WIN32_ERROR PackageFamilyNameFromId(
    const PACKAGE_ID* packageId,
    DWORD* packageFamilyNameLength,
    LPWSTR packageFamilyName   // optional
);

パラメーター

名前方向説明
packageIdPACKAGE_ID*inファミリ名生成元となるPACKAGE_ID構造体へのポインタ。
packageFamilyNameLengthDWORD*inout入力で文字数、出力で必要文字数を受け取る入出力ポインタ(終端含む)。
packageFamilyNameLPWSTRoutoptional生成されたパッケージファミリ名を受け取る出力バッファ。NULLでサイズ照会可。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

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

PackageFamilyNameFromId = ctypes.windll.kernel32.PackageFamilyNameFromId
PackageFamilyNameFromId.restype = wintypes.DWORD
PackageFamilyNameFromId.argtypes = [
    ctypes.c_void_p,  # packageId : PACKAGE_ID*
    ctypes.POINTER(wintypes.DWORD),  # packageFamilyNameLength : DWORD* in/out
    wintypes.LPWSTR,  # packageFamilyName : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPackageFamilyNameFromId = kernel32.NewProc("PackageFamilyNameFromId")
)

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

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

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

let packagefamilynamefromid =
  foreign "PackageFamilyNameFromId"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* packageId : PACKAGE_ID* -> (ptr void) *)
(* packageFamilyNameLength : DWORD* in/out -> (ptr uint32_t) *)
(* packageFamilyName : 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 ("PackageFamilyNameFromId" package-family-name-from-id :convention :stdcall) :uint32
  (package-id :pointer)   ; PACKAGE_ID*
  (package-family-name-length :pointer)   ; DWORD* in/out
  (package-family-name :pointer))   ; LPWSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PackageFamilyNameFromId = Win32::API::More->new('KERNEL32',
    'DWORD PackageFamilyNameFromId(LPVOID packageId, LPVOID packageFamilyNameLength, LPWSTR packageFamilyName)');
# my $ret = $PackageFamilyNameFromId->Call($packageId, $packageFamilyNameLength, $packageFamilyName);
# packageId : PACKAGE_ID* -> LPVOID
# packageFamilyNameLength : DWORD* in/out -> LPVOID
# packageFamilyName : LPWSTR optional, out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型