Win32 API 日本語リファレンス
ホームMedia.Multimedia › EditStreamSetNameA

EditStreamSetNameA

関数
編集可能ストリームの名前を設定する(ANSI版)。
DLLAVIFIL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT EditStreamSetNameA(
    IAVIStream* pavi,
    LPCSTR lpszName
);

パラメーター

名前方向説明
paviIAVIStream*in開いているストリームへのハンドル。
lpszNameLPCSTRinストリームの説明を格納した、null 終端文字列。

戻り値の型: HRESULT

公式ドキュメント

EditStreamSetName 関数は、ストリームに説明用の文字列を割り当てます。(ANSI)

戻り値

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

解説(Remarks)

この関数は、AVISTREAMINFO 構造体の szName メンバーを更新します。

メモ

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

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

各言語での呼び出し定義

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

HRESULT EditStreamSetNameA(
    IAVIStream* pavi,
    LPCSTR lpszName
);
[DllImport("AVIFIL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int EditStreamSetNameA(
    IntPtr pavi,   // IAVIStream*
    [MarshalAs(UnmanagedType.LPStr)] string lpszName   // LPCSTR
);
<DllImport("AVIFIL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function EditStreamSetNameA(
    pavi As IntPtr,   ' IAVIStream*
    <MarshalAs(UnmanagedType.LPStr)> lpszName As String   ' LPCSTR
) As Integer
End Function
' pavi : IAVIStream*
' lpszName : LPCSTR
Declare PtrSafe Function EditStreamSetNameA Lib "avifil32" ( _
    ByVal pavi As LongPtr, _
    ByVal lpszName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EditStreamSetNameA = ctypes.windll.avifil32.EditStreamSetNameA
EditStreamSetNameA.restype = ctypes.c_int
EditStreamSetNameA.argtypes = [
    ctypes.c_void_p,  # pavi : IAVIStream*
    wintypes.LPCSTR,  # lpszName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
EditStreamSetNameA = Fiddle::Function.new(
  lib['EditStreamSetNameA'],
  [
    Fiddle::TYPE_VOIDP,  # pavi : IAVIStream*
    Fiddle::TYPE_VOIDP,  # lpszName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "avifil32")]
extern "system" {
    fn EditStreamSetNameA(
        pavi: *mut core::ffi::c_void,  // IAVIStream*
        lpszName: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("AVIFIL32.dll", CharSet = CharSet.Ansi)]
public static extern int EditStreamSetNameA(IntPtr pavi, [MarshalAs(UnmanagedType.LPStr)] string lpszName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_EditStreamSetNameA' -Namespace Win32 -PassThru
# $api::EditStreamSetNameA(pavi, lpszName)
#uselib "AVIFIL32.dll"
#func global EditStreamSetNameA "EditStreamSetNameA" sptr, sptr
; EditStreamSetNameA pavi, lpszName   ; 戻り値は stat
; pavi : IAVIStream* -> "sptr"
; lpszName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "AVIFIL32.dll"
#cfunc global EditStreamSetNameA "EditStreamSetNameA" sptr, str
; res = EditStreamSetNameA(pavi, lpszName)
; pavi : IAVIStream* -> "sptr"
; lpszName : LPCSTR -> "str"
; HRESULT EditStreamSetNameA(IAVIStream* pavi, LPCSTR lpszName)
#uselib "AVIFIL32.dll"
#cfunc global EditStreamSetNameA "EditStreamSetNameA" intptr, str
; res = EditStreamSetNameA(pavi, lpszName)
; pavi : IAVIStream* -> "intptr"
; lpszName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	avifil32 = windows.NewLazySystemDLL("AVIFIL32.dll")
	procEditStreamSetNameA = avifil32.NewProc("EditStreamSetNameA")
)

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

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

typedef EditStreamSetNameANative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef EditStreamSetNameADart = int Function(Pointer<Void>, Pointer<Utf8>);
final EditStreamSetNameA = DynamicLibrary.open('AVIFIL32.dll')
    .lookupFunction<EditStreamSetNameANative, EditStreamSetNameADart>('EditStreamSetNameA');
// pavi : IAVIStream* -> Pointer<Void>
// lpszName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EditStreamSetNameA(
  pavi: Pointer;   // IAVIStream*
  lpszName: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'AVIFIL32.dll' name 'EditStreamSetNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EditStreamSetNameA"
  c_EditStreamSetNameA :: Ptr () -> CString -> IO Int32
-- pavi : IAVIStream* -> Ptr ()
-- lpszName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let editstreamsetnamea =
  foreign "EditStreamSetNameA"
    ((ptr void) @-> string @-> returning int32_t)
(* pavi : IAVIStream* -> (ptr void) *)
(* lpszName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library avifil32 (t "AVIFIL32.dll"))
(cffi:use-foreign-library avifil32)

(cffi:defcfun ("EditStreamSetNameA" edit-stream-set-name-a :convention :stdcall) :int32
  (pavi :pointer)   ; IAVIStream*
  (lpsz-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EditStreamSetNameA = Win32::API::More->new('AVIFIL32',
    'int EditStreamSetNameA(LPVOID pavi, LPCSTR lpszName)');
# my $ret = $EditStreamSetNameA->Call($pavi, $lpszName);
# pavi : IAVIStream* -> LPVOID
# lpszName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型