GetPrivateProfileString
von ActiveVB-Team
Deklaration
Declare Function GetPrivateProfileString Lib "kernel32" _ Alias "GetPrivateProfileStringA" ( _ ByVal lpApplicationName As String, _ ByVal lpKeyName As Any, _ ByVal lpDefault As String, _ ByVal lpReturnedString As String, _ ByVal nSize As Long, _ ByVal lpFileName As String) As LongWeitere Informationen zur Verwendung dieser Funktion finden sie u.U. auch im Artikel GetPrivateProfileString des API-Wikis.
GetPrivateProfileString
Parameter | |
---|---|
lpApplicationName | Ein Zeiger auf einen nullterminierten String, der den Abschnittsnamen enthält. Wenn dieser Parameter gleich Null ist, werden alle Abschnittsnamen der INI-Datei statt dessen in den Puffer kopiert. |
lpKeyName | Ein Zeiger auf einen nullterminierten String, der den Schlüsselnamen enthält. Wenn dieser Parameter gleich Null ist, werden alle Abschnittsnamen der INI-Datei statt dessen in den Puffer kopiert. |
lpDefault | Ein Zeiger auf einen nullterminierten String, der den Standardwert enthält, der zurückgegeben wird, wenn der Schlüssel im angegebenen Abschnitt nicht gefunden wurde. |
lpReturnedString | Zeiger auf den Puffer, der vom System gefüllt wird, bei der Rückgabe eines Wertes für einen Schlüssel enthält dieser Puffer normalerweise einen einzigen nullterminierten String. Wenn Abschnitts- oder Schlüsselnamen einer INI-Datei ermittelt werden (durch Angabe von Null für lpApplicationName bzw. lpKeyName), wird der Puffer mit einer Liste nullterminierter Strings gefüllt, wobei der letzte String mit zwei Terminierungszeichen abgeschlossen wird. |
nSize | Größe des Puffers lpReturnedString, der die Daten entgegennimmt. |
lpFileName | Ein Zeiger auf einen nullterminierten String, der den Namen der INI-Datei enthält. Wenn dieser Parameter keinen vollständigen Pfadnamen enthält, such Windows im Windows-Verzeichnis nach ihr. |
Tabelle 1
Rückgabewerte | |
---|---|
Long | Die Anzahl der Zeichen die in den Puffer kopiert wurden, wobei das Terminierungszeichen nicht berücksichtigt wird. Wenn nicht genügend Speicherplatz zur Verfügung gestellt wurde, ist der Rückgabewert -1 |
Tabelle 2
Unterstützte Betriebssysteme
Win32s, Windows 95, Windows 98, Windows NT
Verwandte API-Funktionen
GetProfileString, WritePrivateProfileString
Zugehörige Tipps
Zugehörige Microsoft Knowledge Base Artikel