SHStrDupW

関数

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

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

シグネチャ

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

HRESULT SHStrDupW(
    LPCWSTR psz,
    LPWSTR* ppwsz
);

パラメーター

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

名前

型

方向

説明

psz

LPCWSTR

コピーする null 終端文字列へのポインター。

ppwsz

LPWSTR*

out

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

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

解説(Remarks)

この関数は入力として Unicode 文字列または ANSI 文字列のいずれかを受け取りますが、コピーされる文字列は常に Unicode です。

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

メモ

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

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

各言語での呼び出し定義

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

HRESULT SHStrDupW(
    LPCWSTR psz,
    LPWSTR* ppwsz
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHStrDupW(
    [MarshalAs(UnmanagedType.LPWStr)] string psz,   // LPCWSTR
    IntPtr ppwsz   // LPWSTR* out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHStrDupW(
    <MarshalAs(UnmanagedType.LPWStr)> psz As String,   ' LPCWSTR
    ppwsz As IntPtr   ' LPWSTR* out
) As Integer
End Function

' psz : LPCWSTR
' ppwsz : LPWSTR* out
Declare PtrSafe Function SHStrDupW Lib "shlwapi" ( _
    ByVal psz As LongPtr, _
    ByVal ppwsz As LongPtr) 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHStrDupW = Fiddle::Function.new(
  lib['SHStrDupW'],
  [
    Fiddle::TYPE_VOIDP,  # psz : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ppwsz : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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