PathAddExtensionW-Funktion (shlwapi.h)

Artikel
08/26/2023

Fügt einer Pfadzeichenfolge eine Dateinamenerweiterung hinzu.

Hinweis Ein Missbrauch dieser Funktion kann zu einem Pufferüberlauf führen. Wir empfehlen die Verwendung der sichereren PathCchAddExtension-Funktion an ihrer Stelle.

Syntax

BOOL PathAddExtensionW(
  [in, out]      LPWSTR  pszPath,
  [in, optional] LPCWSTR pszExt
);

Parameter

[in, out] pszPath

Typ: LPTSTR

Ein Zeiger auf einen Puffer mit der NULL-Zeichenfolge, an die die Dateinamenerweiterung angefügt wird. Sie müssen die Größe dieses Puffers auf MAX_PATH festlegen, um sicherzustellen, dass er groß genug ist, um die zurückgegebene Zeichenfolge zu enthalten.

[in, optional] pszExt

Typ: LPCTSTR

Ein Zeiger auf eine NULL-Zeichenfolge, die die Dateinamenerweiterung enthält. Dieser Wert kann NULL sein.

Rückgabewert

Typ: BOOL

Gibt TRUE zurück, wenn eine Erweiterung hinzugefügt wurde, oder andernfalls FALSE .

Hinweise

Wenn bereits eine Dateinamenerweiterung vorhanden ist, wird keine Erweiterung hinzugefügt. Wenn der pszPath auf eine NULL-Zeichenfolge verweist, ist das Ergebnis nur die Dateinamenerweiterung. Wenn pszExtension auf eine NULL-Zeichenfolge verweist, wird eine Erweiterung ".exe" hinzugefügt.

Beispiele

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

void main( void )
{
     // String for path name without file name extension.
     char buffer_1[MAX_PATH] = "file";
     char *lpStr1;
     lpStr1 = buffer_1;

     // String for path name with file name extension.
     char buffer_2[ ] = "file.doc";
     char *lpStr2;
     lpStr2 = buffer_2;

     // String for extension name.
     char F_Ext[MAX_PATH] = ".txt";
     char *lpStr3;
     lpStr3 = F_Ext;

     // Null string as path. 
     char N_String[MAX_PATH] = "\0";
     char *lpStr4;
     lpStr4 = N_String;

     // Path 1 without the file name extension.
     cout << "The original path string 1 is  " << lpStr1 << endl;

     int ret_1 = PathAddExtension(lpStr1,lpStr3);
     cout << "The modified path string 1 is  " << lpStr1 << endl;

    // Path 2 with the file name extension already there.
    cout << "The original path string 2 is  " << lpStr2 << endl;
    int ret_2 = PathAddExtension(lpStr2,lpStr3);
    cout << "The modified path string 2 is  " << lpStr2<< endl;

    // Path 3 null string as a path.
    int ret_3 = PathAddExtension(lpStr4,lpStr3);
    cout << "The return value is " << ret_3<< endl;
    cout << "The modified path on a null string is " << lpStr4<< endl;

}

OUTPUT:
-----------------------
The original path string 1 is  file
The modified path string 1 is  file.txt
The original path string 2 is  file.doc
The modified path string 2 is  file.doc
The return value is 1
The modified path on a null string is .txt
The return value is 1

Hinweis

Der shlwapi.h-Header definiert PathAddExtension als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shlwapi.h
Bibliothek	Shlwapi.lib
DLL	Shlwapi.dll (Version 4.71 oder höher)

Freigeben über