mmioRenameW

関数

マルチメディアファイルの名前を変更する(Unicode版)。

DLLWINMM.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD mmioRenameW(
    LPCWSTR pszFileName,
    LPCWSTR pszNewFileName,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fdwRename
);

パラメーター

名前	型	方向	説明
pszFileName	LPCWSTR	in	名前を変更するファイルのファイル名を含む文字列へのポインター。
pszNewFileName	LPCWSTR	in	新しいファイル名を含む文字列へのポインター。
pmmioinfo	MMIOINFO*	inoptional	mmioRename で使用される追加パラメーターを含む MMIOINFO 構造体へのポインター。このパラメーターが NULL でない場合、参照される MMIOINFO 構造体の未使用のメンバーは、予約済みのメンバーを含めてすべて 0 に設定する必要があります。
fdwRename	DWORD	in	名前変更操作のフラグ。このパラメーターは 0 に設定してください。

戻り値の型: DWORD

公式ドキュメント

mmioRenameW (Unicode) 関数は、指定したファイルの名前を変更します。ファイル名を含む文字列を変更するパラメーターを持ちます。(mmioRenameW)

戻り値

ファイルの名前が変更された場合は 0 を返します。それ以外の場合は、mmioRename または I/O プロシージャから返されたエラーコードを返します。

解説(Remarks)

メモ

mmiscapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして mmioRename を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不整合が発生する可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD mmioRenameW(
    LPCWSTR pszFileName,
    LPCWSTR pszNewFileName,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fdwRename
);

[DllImport("WINMM.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint mmioRenameW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszNewFileName,   // LPCWSTR
    IntPtr pmmioinfo,   // MMIOINFO* optional
    uint fdwRename   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function mmioRenameW(
    <MarshalAs(UnmanagedType.LPWStr)> pszFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszNewFileName As String,   ' LPCWSTR
    pmmioinfo As IntPtr,   ' MMIOINFO* optional
    fdwRename As UInteger   ' DWORD
) As UInteger
End Function

' pszFileName : LPCWSTR
' pszNewFileName : LPCWSTR
' pmmioinfo : MMIOINFO* optional
' fdwRename : DWORD
Declare PtrSafe Function mmioRenameW Lib "winmm" ( _
    ByVal pszFileName As LongPtr, _
    ByVal pszNewFileName As LongPtr, _
    ByVal pmmioinfo As LongPtr, _
    ByVal fdwRename As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

mmioRenameW = ctypes.windll.winmm.mmioRenameW
mmioRenameW.restype = wintypes.DWORD
mmioRenameW.argtypes = [
    wintypes.LPCWSTR,  # pszFileName : LPCWSTR
    wintypes.LPCWSTR,  # pszNewFileName : LPCWSTR
    ctypes.c_void_p,  # pmmioinfo : MMIOINFO* optional
    wintypes.DWORD,  # fdwRename : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioRenameW = Fiddle::Function.new(
  lib['mmioRenameW'],
  [
    Fiddle::TYPE_VOIDP,  # pszFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszNewFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pmmioinfo : MMIOINFO* optional
    -Fiddle::TYPE_INT,  # fdwRename : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winmm")]
extern "system" {
    fn mmioRenameW(
        pszFileName: *const u16,  // LPCWSTR
        pszNewFileName: *const u16,  // LPCWSTR
        pmmioinfo: *mut MMIOINFO,  // MMIOINFO* optional
        fdwRename: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Unicode)]
public static extern uint mmioRenameW([MarshalAs(UnmanagedType.LPWStr)] string pszFileName, [MarshalAs(UnmanagedType.LPWStr)] string pszNewFileName, IntPtr pmmioinfo, uint fdwRename);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioRenameW' -Namespace Win32 -PassThru
# $api::mmioRenameW(pszFileName, pszNewFileName, pmmioinfo, fdwRename)

#uselib "WINMM.dll"
#func global mmioRenameW "mmioRenameW" wptr, wptr, wptr, wptr
; mmioRenameW pszFileName, pszNewFileName, varptr(pmmioinfo), fdwRename   ; 戻り値は stat
; pszFileName : LPCWSTR -> "wptr"
; pszNewFileName : LPCWSTR -> "wptr"
; pmmioinfo : MMIOINFO* optional -> "wptr"
; fdwRename : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global mmioRenameW "mmioRenameW" wstr, wstr, var, int
; res = mmioRenameW(pszFileName, pszNewFileName, pmmioinfo, fdwRename)
; pszFileName : LPCWSTR -> "wstr"
; pszNewFileName : LPCWSTR -> "wstr"
; pmmioinfo : MMIOINFO* optional -> "var"
; fdwRename : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global mmioRenameW "mmioRenameW" wstr, wstr, sptr, int
; res = mmioRenameW(pszFileName, pszNewFileName, varptr(pmmioinfo), fdwRename)
; pszFileName : LPCWSTR -> "wstr"
; pszNewFileName : LPCWSTR -> "wstr"
; pmmioinfo : MMIOINFO* optional -> "sptr"
; fdwRename : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。