Win32 API 日本語リファレンス
ホームUI.Shell › ILSaveToStream

ILSaveToStream

関数
PIDL(アイテムIDリスト)をストリームに保存する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT ILSaveToStream(
    IStream* pstm,
    ITEMIDLIST* pidl
);

パラメーター

名前方向説明
pstmIStream*inITEMIDLIST の保存先となる IStream インターフェイスへのポインターです。
pidlITEMIDLIST*in保存する ITEMIDLIST 構造体へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

ITEMIDLIST 構造体をストリームに保存します。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は COM エラー値を返します。

解説(Remarks)

ストリームは書き込み用に開かれている必要があります。開かれていない場合、ILSaveToStream はエラーを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT ILSaveToStream(
    IStream* pstm,
    ITEMIDLIST* pidl
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int ILSaveToStream(
    IntPtr pstm,   // IStream*
    IntPtr pidl   // ITEMIDLIST*
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function ILSaveToStream(
    pstm As IntPtr,   ' IStream*
    pidl As IntPtr   ' ITEMIDLIST*
) As Integer
End Function
' pstm : IStream*
' pidl : ITEMIDLIST*
Declare PtrSafe Function ILSaveToStream Lib "shell32" ( _
    ByVal pstm As LongPtr, _
    ByVal pidl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ILSaveToStream = ctypes.windll.shell32.ILSaveToStream
ILSaveToStream.restype = ctypes.c_int
ILSaveToStream.argtypes = [
    ctypes.c_void_p,  # pstm : IStream*
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procILSaveToStream = shell32.NewProc("ILSaveToStream")
)

// pstm (IStream*), pidl (ITEMIDLIST*)
r1, _, err := procILSaveToStream.Call(
	uintptr(pstm),
	uintptr(pidl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ILSaveToStream(
  pstm: Pointer;   // IStream*
  pidl: Pointer   // ITEMIDLIST*
): Integer; stdcall;
  external 'SHELL32.dll' name 'ILSaveToStream';
result := DllCall("SHELL32\ILSaveToStream"
    , "Ptr", pstm   ; IStream*
    , "Ptr", pidl   ; ITEMIDLIST*
    , "Int")   ; return: HRESULT
●ILSaveToStream(pstm, pidl) = DLL("SHELL32.dll", "int ILSaveToStream(void*, void*)")
# 呼び出し: ILSaveToStream(pstm, pidl)
# pstm : IStream* -> "void*"
# pidl : ITEMIDLIST* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ILSaveToStreamNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ILSaveToStreamDart = int Function(Pointer<Void>, Pointer<Void>);
final ILSaveToStream = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<ILSaveToStreamNative, ILSaveToStreamDart>('ILSaveToStream');
// pstm : IStream* -> Pointer<Void>
// pidl : ITEMIDLIST* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ILSaveToStream(
  pstm: Pointer;   // IStream*
  pidl: Pointer   // ITEMIDLIST*
): Integer; stdcall;
  external 'SHELL32.dll' name 'ILSaveToStream';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ILSaveToStream"
  c_ILSaveToStream :: Ptr () -> Ptr () -> IO Int32
-- pstm : IStream* -> Ptr ()
-- pidl : ITEMIDLIST* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ilsavetostream =
  foreign "ILSaveToStream"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pstm : IStream* -> (ptr void) *)
(* pidl : ITEMIDLIST* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("ILSaveToStream" ilsave-to-stream :convention :stdcall) :int32
  (pstm :pointer)   ; IStream*
  (pidl :pointer))   ; ITEMIDLIST*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ILSaveToStream = Win32::API::More->new('SHELL32',
    'int ILSaveToStream(LPVOID pstm, LPVOID pidl)');
# my $ret = $ILSaveToStream->Call($pstm, $pidl);
# pstm : IStream* -> LPVOID
# pidl : ITEMIDLIST* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型