StrTrimA
関数文字列の前後から指定文字を取り除く。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL StrTrimA(
LPSTR psz,
LPCSTR pszTrimChars
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psz | LPSTR | inout | トリミング対象となる、null 終端された文字列へのポインターです。この関数が正常に終了すると、psz にトリミングされた文字列が格納されます。 |
| pszTrimChars | LPCSTR | in | psz からトリミングする文字を含む、null 終端された文字列へのポインターです。 |
戻り値の型: BOOL
公式ドキュメント
文字列から指定した先頭および末尾の文字を削除します。(ANSI)
戻り値
型: BOOL
文字が削除された場合は TRUE、それ以外の場合は FALSE を返します。
解説(Remarks)
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrTrim を定義します。エンコーディング非依存のエイリアスと、エンコーディング非依存ではないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、関数プロトタイプの規約を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL StrTrimA(
LPSTR psz,
LPCSTR pszTrimChars
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool StrTrimA(
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder psz, // LPSTR in/out
[MarshalAs(UnmanagedType.LPStr)] string pszTrimChars // LPCSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrTrimA(
<MarshalAs(UnmanagedType.LPStr)> psz As System.Text.StringBuilder, ' LPSTR in/out
<MarshalAs(UnmanagedType.LPStr)> pszTrimChars As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' psz : LPSTR in/out
' pszTrimChars : LPCSTR
Declare PtrSafe Function StrTrimA Lib "shlwapi" ( _
ByVal psz As String, _
ByVal pszTrimChars As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
StrTrimA = ctypes.windll.shlwapi.StrTrimA
StrTrimA.restype = wintypes.BOOL
StrTrimA.argtypes = [
wintypes.LPSTR, # psz : LPSTR in/out
wintypes.LPCSTR, # pszTrimChars : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrTrimA = Fiddle::Function.new(
lib['StrTrimA'],
[
Fiddle::TYPE_VOIDP, # psz : LPSTR in/out
Fiddle::TYPE_VOIDP, # pszTrimChars : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn StrTrimA(
psz: *mut u8, // LPSTR in/out
pszTrimChars: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool StrTrimA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder psz, [MarshalAs(UnmanagedType.LPStr)] string pszTrimChars);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrTrimA' -Namespace Win32 -PassThru
# $api::StrTrimA(psz, pszTrimChars)#uselib "SHLWAPI.dll"
#func global StrTrimA "StrTrimA" sptr, sptr
; StrTrimA varptr(psz), pszTrimChars ; 戻り値は stat
; psz : LPSTR in/out -> "sptr"
; pszTrimChars : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global StrTrimA "StrTrimA" var, str ; res = StrTrimA(psz, pszTrimChars) ; psz : LPSTR in/out -> "var" ; pszTrimChars : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global StrTrimA "StrTrimA" sptr, str ; res = StrTrimA(varptr(psz), pszTrimChars) ; psz : LPSTR in/out -> "sptr" ; pszTrimChars : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL StrTrimA(LPSTR psz, LPCSTR pszTrimChars) #uselib "SHLWAPI.dll" #cfunc global StrTrimA "StrTrimA" var, str ; res = StrTrimA(psz, pszTrimChars) ; psz : LPSTR in/out -> "var" ; pszTrimChars : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL StrTrimA(LPSTR psz, LPCSTR pszTrimChars) #uselib "SHLWAPI.dll" #cfunc global StrTrimA "StrTrimA" intptr, str ; res = StrTrimA(varptr(psz), pszTrimChars) ; psz : LPSTR in/out -> "intptr" ; pszTrimChars : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrTrimA = shlwapi.NewProc("StrTrimA")
)
// psz (LPSTR in/out), pszTrimChars (LPCSTR)
r1, _, err := procStrTrimA.Call(
uintptr(psz),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszTrimChars))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction StrTrimA(
psz: PAnsiChar; // LPSTR in/out
pszTrimChars: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'StrTrimA';result := DllCall("SHLWAPI\StrTrimA"
, "Ptr", psz ; LPSTR in/out
, "AStr", pszTrimChars ; LPCSTR
, "Int") ; return: BOOL●StrTrimA(psz, pszTrimChars) = DLL("SHLWAPI.dll", "bool StrTrimA(char*, char*)")
# 呼び出し: StrTrimA(psz, pszTrimChars)
# psz : LPSTR in/out -> "char*"
# pszTrimChars : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn StrTrimA(
psz: [*c]u8, // LPSTR in/out
pszTrimChars: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc StrTrimA(
psz: ptr char, # LPSTR in/out
pszTrimChars: cstring # LPCSTR
): int32 {.importc: "StrTrimA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int StrTrimA(
char* psz, // LPSTR in/out
const(char)* pszTrimChars // LPCSTR
);ccall((:StrTrimA, "SHLWAPI.dll"), stdcall, Int32,
(Ptr{UInt8}, Cstring),
psz, pszTrimChars)
# psz : LPSTR in/out -> Ptr{UInt8}
# pszTrimChars : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t StrTrimA(
char* psz,
const char* pszTrimChars);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrTrimA(psz, pszTrimChars)
-- psz : LPSTR in/out
-- pszTrimChars : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrTrimA = lib.func('__stdcall', 'StrTrimA', 'int32_t', ['char *', 'str']);
// StrTrimA(psz, pszTrimChars)
// psz : LPSTR in/out -> 'char *'
// pszTrimChars : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrTrimA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.StrTrimA(psz, pszTrimChars)
// psz : LPSTR in/out -> "buffer"
// pszTrimChars : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t StrTrimA(
char* psz,
const char* pszTrimChars);
C, "SHLWAPI.dll");
// $ffi->StrTrimA(psz, pszTrimChars);
// psz : LPSTR in/out
// pszTrimChars : 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 Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
boolean StrTrimA(
byte[] psz, // LPSTR in/out
String pszTrimChars // LPCSTR
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun StrTrimA = StrTrimA(
psz : UInt8*, # LPSTR in/out
pszTrimChars : 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 StrTrimANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef StrTrimADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final StrTrimA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrTrimANative, StrTrimADart>('StrTrimA');
// psz : LPSTR in/out -> Pointer<Utf8>
// pszTrimChars : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrTrimA(
psz: PAnsiChar; // LPSTR in/out
pszTrimChars: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'StrTrimA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrTrimA"
c_StrTrimA :: CString -> CString -> IO CInt
-- psz : LPSTR in/out -> CString
-- pszTrimChars : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strtrima =
foreign "StrTrimA"
(string @-> string @-> returning int32_t)
(* psz : LPSTR in/out -> string *)
(* pszTrimChars : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("StrTrimA" str-trim-a :convention :stdcall) :int32
(psz :pointer) ; LPSTR in/out
(psz-trim-chars :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $StrTrimA = Win32::API::More->new('SHLWAPI',
'BOOL StrTrimA(LPSTR psz, LPCSTR pszTrimChars)');
# my $ret = $StrTrimA->Call($psz, $pszTrimChars);
# psz : LPSTR in/out -> LPSTR
# pszTrimChars : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f StrTrimW (Unicode版) — 文字列の前後から指定文字を取り除く。