SHStrDupA

関数

文字列を複製してUnicode文字列として返す。

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

シグネチャ

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

HRESULT SHStrDupA(
    LPCSTR psz,
    LPWSTR* ppwsz
);

パラメーター

名前	型	方向	説明
psz	LPCSTR	in	コピー対象となる null 終端文字列へのポインターです。
ppwsz	LPWSTR*	out	結果を格納する、割り当て済みの Unicode 文字列へのポインターです。SHStrDup はこの文字列のメモリを CoTaskMemAlloc で割り当てます。この文字列が不要になったら CoTaskMemFree で解放してください。失敗した場合、この値は NULL になります。

名前

型

方向

説明

psz

LPCSTR

コピー対象となる null 終端文字列へのポインターです。

ppwsz

LPWSTR*

out

結果を格納する、割り当て済みの Unicode 文字列へのポインターです。SHStrDup はこの文字列のメモリを CoTaskMemAlloc で割り当てます。この文字列が不要になったら CoTaskMemFree で解放してください。

失敗した場合、この値は NULL になります。

戻り値の型: HRESULT

公式ドキュメント

新しく割り当てたメモリ上に文字列のコピーを作成します。(SHStrDupA)

戻り値

型: HRESULT

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

解説(Remarks)

この関数は入力として Unicode 文字列と ANSI 文字列のどちらも受け付けますが、コピーされる文字列は常に Unicode です。

この関数はコピーした文字列のメモリ割り当てに CoTaskMemAlloc を使用します。このメモリが不要になったら CoTaskMemFree で解放する必要があります。

メモ

shlwapi.h ヘッダーは SHStrDup をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択します。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

HRESULT SHStrDupA(
    LPCSTR psz,
    LPWSTR* ppwsz
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHStrDupA(
    [MarshalAs(UnmanagedType.LPStr)] string psz,   // LPCSTR
    IntPtr ppwsz   // LPWSTR* out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHStrDupA(
    <MarshalAs(UnmanagedType.LPStr)> psz As String,   ' LPCSTR
    ppwsz As IntPtr   ' LPWSTR* out
) As Integer
End Function

' psz : LPCSTR
' ppwsz : LPWSTR* out
Declare PtrSafe Function SHStrDupA Lib "shlwapi" ( _
    ByVal psz As String, _
    ByVal ppwsz As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHStrDupA = ctypes.windll.shlwapi.SHStrDupA
SHStrDupA.restype = ctypes.c_int
SHStrDupA.argtypes = [
    wintypes.LPCSTR,  # psz : LPCSTR
    ctypes.c_void_p,  # ppwsz : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHStrDupA = Fiddle::Function.new(
  lib['SHStrDupA'],
  [
    Fiddle::TYPE_VOIDP,  # psz : LPCSTR
    Fiddle::TYPE_VOIDP,  # ppwsz : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHStrDupA(
        psz: *const u8,  // LPCSTR
        ppwsz: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int SHStrDupA([MarshalAs(UnmanagedType.LPStr)] string psz, IntPtr ppwsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHStrDupA' -Namespace Win32 -PassThru
# $api::SHStrDupA(psz, ppwsz)

#uselib "SHLWAPI.dll"
#func global SHStrDupA "SHStrDupA" sptr, sptr
; SHStrDupA psz, varptr(ppwsz)   ; 戻り値は stat
; psz : LPCSTR -> "sptr"
; ppwsz : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHStrDupA "SHStrDupA" str, var
; res = SHStrDupA(psz, ppwsz)
; psz : LPCSTR -> "str"
; ppwsz : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHStrDupA "SHStrDupA" str, sptr
; res = SHStrDupA(psz, varptr(ppwsz))
; psz : LPCSTR -> "str"
; ppwsz : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。