IPropertyDescription::FormatForDisplay-Methode (propsys.h)

  • Artikel

Ruft eine formatierte Unicode-Zeichenfolgendarstellung eines Eigenschaftswerts ab.

Syntax

HRESULT FormatForDisplay(
  [in]  REFPROPVARIANT        propvar,
  [in]  PROPDESC_FORMAT_FLAGS pdfFlags,
  [out] LPWSTR                *ppszDisplay
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Ein Verweis auf eine PROPVARIANT-Struktur , die den Typ und den Wert der Eigenschaft enthält.

[in] pdfFlags

Typ: PROPDESC_FORMAT_FLAGS

Eines oder mehrere der PROPDESC_FORMAT_FLAGS Flags, die entweder bitweise oder mehrere Werte sind, die das Format der Eigenschaftenzeichenfolge angeben.

[out] ppszDisplay

Typ: LPWSTR*

Die Adresse eines Zeigers auf eine unicode-Zeichenfolge, die null beendet ist und den Anzeigetext enthält.

Rückgabewert

Typ: HRESULT

Gibt einen der folgenden Werte zurück.

Rückgabecode BESCHREIBUNG
S_OK
 Die Zeichenfolge wurde kopiert und null ohne Abschneiden beendet. Diese Zeichenfolge kann aufgrund einer leeren Eingabezeichenfolge oder von einem nicht leeren Wert, der als leere Zeichenfolge formatiert wurde, leer zurückgegeben werden.
S_FALSE
 Die leere Zeichenfolge resultierte aus einer VT_EMPTY.
E_INVALIDARG
 Der pszText-Parameter ist NULL.
ERROR_INSUFFICIENT_BUFFER
 Fehler beim Kopiervorgang aufgrund unzureichenden Speicherplatzes. Der Zielpuffer wird so geändert, dass er eine abgeschnittene Version des idealen Ergebnisses enthält und null-beendet ist.

Hinweise

Sie müssen das Component Object Model (COM) mit CoInitialize oder OleInitialize initialisieren, bevor Sie IPropertyDescription::FormatForDisplay aufrufen.

Bei Erfolg ruft diese Methode eine formatierte Unicode-Zeichenfolgendarstellung eines Eigenschaftswerts für einen angegebenen PROPERTYKEY und eine oder mehrere PROPDESC_FORMAT_FLAGS ab.

Der Zweck dieser Methode besteht darin, Daten in eine Zeichenfolge zu konvertieren, die für die Anzeige für den Benutzer geeignet ist. Der Wert wird entsprechend dem aktuellen Gebietsschema, der Sprache des Benutzers, dem PROPDESC_FORMAT_FLAGS und der durch den Eigenschaftenschlüssel angegebenen Eigenschaftenbeschreibung formatiert. Informationen dazu, wie das Eigenschaftenbeschreibungsschema die Formatierung des Werts beeinflusst, finden Sie unter displayInfo, stringFormat, booleanFormat, numberFormat, NMDATETIMEFORMAT und enumeratedList. In der Regel werden die PROPDESC_FORMAT_FLAGS verwendet, um das in der Eigenschaftenbeschreibung vorgeschriebene Format zu ändern.

Die Ausgabezeichenfolge kann Unicode-Richtungszeichen enthalten. Diese Nicht-Zeichen beeinflussen den bidirektionalen Unicode-Algorithmus, sodass die Werte korrekt angezeigt werden, wenn eine Sprache von links nach rechts (LTR) in ein Rechts-nach-Links-Fenster (RTL) gezeichnet wird und umgekehrt. Diese Zeichen enthalten Folgendes: "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".

Die folgenden Eigenschaften verwenden spezielle Formate und sind von der PROPDESC_FORMAT_FLAGS nicht betroffen (beispiele für Zeichenfolgen mit einem aktuellen Gebietsschema, das auf Englisch festgelegt ist; in der Regel wird die Ausgabe lokalisiert, es sei denn, es wird angegeben).

Eigenschaft Format
System.FileAttributes Die folgenden Dateiattribute werden in Buchstaben konvertiert und angefügt, um eine Zeichenfolge zu erstellen (z. B. der Wert 0x1801 (FILE_ATTRIBUTE_READONLY | FILE_ATTRIBUTE_COMPRESSED | FILE_ATTRIBUTE_OFFLINE) wird in "RCO" konvertiert):
  • FILE_ATTRIBUTE_READONLY (0x00000001) – "R"
  • FILE_ATTRIBUTE_SYSTEM (0x00000004) – "S"
  • FILE_ATTRIBUTE_ARCHIVE (0x00000020) -'A'
  • FILE_ATTRIBUTE_COMPRESSED (0x00000800) – "C"
  • FILE_ATTRIBUTE_ENCRYPTED (0x00004000) – "E"
  • FILE_ATTRIBUTE_OFFLINE (0x00001000) – "O"
  • FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (0x00002000) – "I"
System.Photo.ISOSpeed Beispiel: "ISO-400".
System.Photo.ShutterSpeed Der APEX-Wert wird mit dieser Formel in eine Belichtungszeit konvertiert:

Exposure_time = 2^(-APEX_value)

Beispiel: "2 Sekunden". oder "1/125 Sek.".
System.Photo.ExposureTime Beispiel: "2 Sekunden". oder "1/125 Sekunde".
System.Photo.Aperture Der APEX-Wert wird mithilfe dieser Formel in eine F-Zahl konvertiert:

F_Number = 2^(APEX_Value / 2)

Beispiel: "f/5.6".
System.Photo.FNumber Beispiel: "f/5.6".
System.Photo.SubjectDistance Beispiel: "15 m" oder "250 mm".
System.Photo.FocalLength Beispiel: "50 mm".
System.Photo.FlashEnergy Beispiel: "500 bpcs".
System.Photo.ExposureBias Beispiel: "-2 Schritt", "0 Schritt" oder "+3 Schritt".
System.Computer.DecoratedFreeSpace Beispiel: "105 MB frei von 13,2 GB".
System.ItemType Beispiel: "Anwendung" oder "JPEG-Bild".
System.ComputerName Beispiel: "LITWARE05 (dieser Computer)" oder "testbox07".

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propsys.h

Weitere Informationen

IPropertyDescription

Eigenschaftenbeschreibungsschema