StrTrimW

関数

文字列の前後から指定文字を取り除く。

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

シグネチャ

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

BOOL StrTrimW(
    LPWSTR psz,
    LPCWSTR pszTrimChars
);

パラメーター

名前	型	方向	説明
psz	LPWSTR	inout	トリミング対象となる、null 終端文字列へのポインターです。この関数が正常に終了すると、psz にはトリミング後の文字列が格納されます。
pszTrimChars	LPCWSTR	in	psz からトリミングする文字を含む、null 終端文字列へのポインターです。

戻り値の型: BOOL

公式ドキュメント

文字列から、指定された先頭および末尾の文字を削除します。(Unicode)

戻り値

型: BOOL

文字が 1 つでも削除された場合は TRUE、それ以外の場合は FALSE を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL StrTrimW(
    LPWSTR psz,
    LPCWSTR pszTrimChars
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool StrTrimW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder psz,   // LPWSTR in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pszTrimChars   // LPCWSTR
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrTrimW(
    <MarshalAs(UnmanagedType.LPWStr)> psz As System.Text.StringBuilder,   ' LPWSTR in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszTrimChars As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' psz : LPWSTR in/out
' pszTrimChars : LPCWSTR
Declare PtrSafe Function StrTrimW Lib "shlwapi" ( _
    ByVal psz As LongPtr, _
    ByVal pszTrimChars 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

StrTrimW = ctypes.windll.shlwapi.StrTrimW
StrTrimW.restype = wintypes.BOOL
StrTrimW.argtypes = [
    wintypes.LPWSTR,  # psz : LPWSTR in/out
    wintypes.LPCWSTR,  # pszTrimChars : LPCWSTR
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool StrTrimW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder psz, [MarshalAs(UnmanagedType.LPWStr)] string pszTrimChars);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrTrimW' -Namespace Win32 -PassThru
# $api::StrTrimW(psz, pszTrimChars)

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

出力引数:

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