Win32 API 日本語リファレンス
ホームUI.Shell › PathParseIconLocationA

PathParseIconLocationA

関数
アイコン位置文字列からパスとアイコンインデックスを分離する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT PathParseIconLocationA(
    LPSTR pszIconFile
);

パラメーター

名前方向説明
pszIconFileLPSTRinoutファイルの場所文字列を含む、長さ MAX_PATH の null 終端文字列へのポインターです。形式は "path,iconindex" である必要があります。関数が返ると、pszIconFile はファイルのパスを指します。

戻り値の型: INT

公式ドキュメント

ファイルの場所とアイコンインデックスを含む場所文字列を解析し、それぞれの値を分離して返します。(ANSI)

戻り値

Type: int

有効なアイコンインデックス値を返します。

解説(Remarks)

この関数は、SHGetValue によってレジストリから取得した DefaultIcon の値を受け取り、アイコンインデックスをパスから分離するのに便利です。

Examples

#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

void main(void)
{
// Path to parse for file and icon index.
char buffer_1[ ] = "C:\\TEST\\sample.txt,3"; 
char *lpStr1;
lpStr1 = buffer_1;

// Return value from "PathParseIconLocation".
int retval;

// Search a path to parse for file and icon index.
retval = PathParseIconLocation(lpStr1);
cout << "The path to parse for file and icon index is   : " << lpStr1 << endl;
cout << "PathParseIconLocation returns the icon index of: " << retval << endl;
}

OUTPUT:
==========
The path to parse for file and icon index is   : C:\TEST\sample.txt
PathParseIconLocation returns the icon index of: 3
メモ

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

INT PathParseIconLocationA(
    LPSTR pszIconFile
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int PathParseIconLocationA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszIconFile   // LPSTR in/out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathParseIconLocationA(
    <MarshalAs(UnmanagedType.LPStr)> pszIconFile As System.Text.StringBuilder   ' LPSTR in/out
) As Integer
End Function
' pszIconFile : LPSTR in/out
Declare PtrSafe Function PathParseIconLocationA Lib "shlwapi" ( _
    ByVal pszIconFile As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathParseIconLocationA = ctypes.windll.shlwapi.PathParseIconLocationA
PathParseIconLocationA.restype = ctypes.c_int
PathParseIconLocationA.argtypes = [
    wintypes.LPSTR,  # pszIconFile : LPSTR in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathParseIconLocationA = Fiddle::Function.new(
  lib['PathParseIconLocationA'],
  [
    Fiddle::TYPE_VOIDP,  # pszIconFile : LPSTR in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn PathParseIconLocationA(
        pszIconFile: *mut u8  // LPSTR in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int PathParseIconLocationA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszIconFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathParseIconLocationA' -Namespace Win32 -PassThru
# $api::PathParseIconLocationA(pszIconFile)
#uselib "SHLWAPI.dll"
#func global PathParseIconLocationA "PathParseIconLocationA" sptr
; PathParseIconLocationA varptr(pszIconFile)   ; 戻り値は stat
; pszIconFile : LPSTR in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathParseIconLocationA "PathParseIconLocationA" var
; res = PathParseIconLocationA(pszIconFile)
; pszIconFile : LPSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT PathParseIconLocationA(LPSTR pszIconFile)
#uselib "SHLWAPI.dll"
#cfunc global PathParseIconLocationA "PathParseIconLocationA" var
; res = PathParseIconLocationA(pszIconFile)
; pszIconFile : LPSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathParseIconLocationA = shlwapi.NewProc("PathParseIconLocationA")
)

// pszIconFile (LPSTR in/out)
r1, _, err := procPathParseIconLocationA.Call(
	uintptr(pszIconFile),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function PathParseIconLocationA(
  pszIconFile: PAnsiChar   // LPSTR in/out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'PathParseIconLocationA';
result := DllCall("SHLWAPI\PathParseIconLocationA"
    , "Ptr", pszIconFile   ; LPSTR in/out
    , "Int")   ; return: INT
●PathParseIconLocationA(pszIconFile) = DLL("SHLWAPI.dll", "int PathParseIconLocationA(char*)")
# 呼び出し: PathParseIconLocationA(pszIconFile)
# pszIconFile : LPSTR in/out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PathParseIconLocationANative = Int32 Function(Pointer<Utf8>);
typedef PathParseIconLocationADart = int Function(Pointer<Utf8>);
final PathParseIconLocationA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathParseIconLocationANative, PathParseIconLocationADart>('PathParseIconLocationA');
// pszIconFile : LPSTR in/out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathParseIconLocationA(
  pszIconFile: PAnsiChar   // LPSTR in/out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'PathParseIconLocationA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathParseIconLocationA"
  c_PathParseIconLocationA :: CString -> IO Int32
-- pszIconFile : LPSTR in/out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathparseiconlocationa =
  foreign "PathParseIconLocationA"
    (string @-> returning int32_t)
(* pszIconFile : LPSTR in/out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathParseIconLocationA" path-parse-icon-location-a :convention :stdcall) :int32
  (psz-icon-file :pointer))   ; LPSTR in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathParseIconLocationA = Win32::API::More->new('SHLWAPI',
    'int PathParseIconLocationA(LPSTR pszIconFile)');
# my $ret = $PathParseIconLocationA->Call($pszIconFile);
# pszIconFile : LPSTR in/out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い