mmioRenameA

関数

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

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

シグネチャ

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD mmioRenameA(
    LPCSTR pszFileName,
    LPCSTR pszNewFileName,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fdwRename
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

mmioRename 関数は、指定したファイルの名前を変更します。(mmioRenameA)

戻り値

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

解説(Remarks)

メモ

mmiscapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして mmioRename を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD mmioRenameA(
    LPCSTR pszFileName,
    LPCSTR pszNewFileName,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fdwRename
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint mmioRenameA(
    [MarshalAs(UnmanagedType.LPStr)] string pszFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszNewFileName,   // LPCSTR
    IntPtr pmmioinfo,   // MMIOINFO* optional
    uint fdwRename   // DWORD
);

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

' pszFileName : LPCSTR
' pszNewFileName : LPCSTR
' pmmioinfo : MMIOINFO* optional
' fdwRename : DWORD
Declare PtrSafe Function mmioRenameA Lib "winmm" ( _
    ByVal pszFileName As String, _
    ByVal pszNewFileName As String, _
    ByVal pmmioinfo As LongPtr, _
    ByVal fdwRename As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioRenameA = Fiddle::Function.new(
  lib['mmioRenameA'],
  [
    Fiddle::TYPE_VOIDP,  # pszFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszNewFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pmmioinfo : MMIOINFO* optional
    -Fiddle::TYPE_INT,  # fdwRename : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn mmioRenameA(
        pszFileName: *const u8,  // LPCSTR
        pszNewFileName: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint mmioRenameA([MarshalAs(UnmanagedType.LPStr)] string pszFileName, [MarshalAs(UnmanagedType.LPStr)] string pszNewFileName, IntPtr pmmioinfo, uint fdwRename);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioRenameA' -Namespace Win32 -PassThru
# $api::mmioRenameA(pszFileName, pszNewFileName, pmmioinfo, fdwRename)

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

出力引数:

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