ホーム › UI.Shell › StgMakeUniqueName

StgMakeUniqueName

関数

ストレージ内で一意な名前のサブオブジェクトを生成する。

DLLSHELL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT StgMakeUniqueName(
    IStorage* pstgParent,
    LPCWSTR pszFileSpec,
    DWORD grfMode,
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
pstgParent	IStorage*	in	IStorage オブジェクトへのポインターです。
pszFileSpec	LPCWSTR	in	ストリームまたはストレージオブジェクトの名前の書式またはテンプレートです。
grfMode	DWORD	in	ストリームまたはストレージオブジェクトを開くときに使用するアクセスモードです。指定可能な値の詳細と説明については、STGM Constants を参照してください。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照です。通常は IID_IStorage または IID_IStream です。
ppv	void**	out	このメソッドが返ると、riid で要求されたインターフェイスポインターが格納されます。通常は IStorage または IStream です。

戻り値の型: HRESULT

公式ドキュメント

テンプレートから、ストリームまたはストレージオブジェクトの一意な名前を作成します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

riid パラメーターと ppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロを使用することをお勧めします。このマクロは、ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、コーディングエラーの可能性を排除できます。

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

各言語での呼び出し定義

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

HRESULT StgMakeUniqueName(
    IStorage* pstgParent,
    LPCWSTR pszFileSpec,
    DWORD grfMode,
    const GUID* riid,
    void** ppv
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int StgMakeUniqueName(
    IntPtr pstgParent,   // IStorage*
    [MarshalAs(UnmanagedType.LPWStr)] string pszFileSpec,   // LPCWSTR
    uint grfMode,   // DWORD
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function StgMakeUniqueName(
    pstgParent As IntPtr,   ' IStorage*
    <MarshalAs(UnmanagedType.LPWStr)> pszFileSpec As String,   ' LPCWSTR
    grfMode As UInteger,   ' DWORD
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' pstgParent : IStorage*
' pszFileSpec : LPCWSTR
' grfMode : DWORD
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function StgMakeUniqueName Lib "shell32" ( _
    ByVal pstgParent As LongPtr, _
    ByVal pszFileSpec As LongPtr, _
    ByVal grfMode As Long, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StgMakeUniqueName = ctypes.windll.shell32.StgMakeUniqueName
StgMakeUniqueName.restype = ctypes.c_int
StgMakeUniqueName.argtypes = [
    ctypes.c_void_p,  # pstgParent : IStorage*
    wintypes.LPCWSTR,  # pszFileSpec : LPCWSTR
    wintypes.DWORD,  # grfMode : DWORD
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
StgMakeUniqueName = Fiddle::Function.new(
  lib['StgMakeUniqueName'],
  [
    Fiddle::TYPE_VOIDP,  # pstgParent : IStorage*
    Fiddle::TYPE_VOIDP,  # pszFileSpec : LPCWSTR
    -Fiddle::TYPE_INT,  # grfMode : DWORD
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn StgMakeUniqueName(
        pstgParent: *mut core::ffi::c_void,  // IStorage*
        pszFileSpec: *const u16,  // LPCWSTR
        grfMode: u32,  // DWORD
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int StgMakeUniqueName(IntPtr pstgParent, [MarshalAs(UnmanagedType.LPWStr)] string pszFileSpec, uint grfMode, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_StgMakeUniqueName' -Namespace Win32 -PassThru
# $api::StgMakeUniqueName(pstgParent, pszFileSpec, grfMode, riid, ppv)

#uselib "SHELL32.dll"
#func global StgMakeUniqueName "StgMakeUniqueName" sptr, sptr, sptr, sptr, sptr
; StgMakeUniqueName pstgParent, pszFileSpec, grfMode, varptr(riid), ppv   ; 戻り値は stat
; pstgParent : IStorage* -> "sptr"
; pszFileSpec : LPCWSTR -> "sptr"
; grfMode : DWORD -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global StgMakeUniqueName "StgMakeUniqueName" sptr, wstr, int, var, sptr
; res = StgMakeUniqueName(pstgParent, pszFileSpec, grfMode, riid, ppv)
; pstgParent : IStorage* -> "sptr"
; pszFileSpec : LPCWSTR -> "wstr"
; grfMode : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global StgMakeUniqueName "StgMakeUniqueName" sptr, wstr, int, sptr, sptr
; res = StgMakeUniqueName(pstgParent, pszFileSpec, grfMode, varptr(riid), ppv)
; pstgParent : IStorage* -> "sptr"
; pszFileSpec : LPCWSTR -> "wstr"
; grfMode : DWORD -> "int"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。