EcGetObjectArrayProperty-Funktion (evcoll.h)

Die EcGetObjectArrayProperty-Funktion ruft Eigenschaftswerte aus einem Handle in ein Array von Ereignisquelleigenschaften ab. Das Array enthält Eigenschaftswerte für die Ereignisquellen eines Abonnements.

Syntax

BOOL EcGetObjectArrayProperty(
  [in]  EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID     PropertyId,
  [in]  DWORD                           ArrayIndex,
  [in]  DWORD                           Flags,
  [in]  DWORD                           PropertyValueBufferSize,
  [in]  PEC_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                          PropertyValueBufferUsed
);

Parameter

[in] ObjectArray

Ein Handle für ein Array von Eigenschaften für die Ereignisquellen für ein Abonnement. Ein Arrayhandle, das von der EcGetSubscriptionProperty-Methode zurückgegeben wird, wenn der EcSubscriptionEventSources-Wert an den PropertyId-Parameter übergeben wird.

[in] PropertyId

Der Eigenschaftenbezeichner für Eigenschaften im Array. Geben Sie einen Wert aus der EC_SUBSCRIPTION_PROPERTY_ID-Enumeration an. Rufen Sie die Eigenschaften Address, Enabled, UserName und Password im Array ab, indem Sie die Werte EcSubscriptionEventSourceAddress, EcSubscriptionEventSourceEnabled, EcSubscriptionEventSourceUserName oder EcSubscriptionEventSourcePassword angeben.

[in] ArrayIndex

Der Index des Arrays, das angibt, aus welcher Ereignisquelle die Eigenschaft abgerufen werden soll.

[in] Flags

Reserviert. Muss den Wert 0 (null) haben.

[in] PropertyValueBufferSize

Die Größe des Puffers, der den Wert der -Eigenschaft enthält. Die Größe muss mindestens die Größe eines EC_VARIANT Werts sein.

[in] PropertyValueBuffer

Der vom Benutzer bereitgestellte Puffer, in dem der Eigenschaftswert gespeichert werden soll.

[out] PropertyValueBufferUsed

Die Größe des vom Benutzer bereitgestellten Puffers, der von der Funktion bei erfolgreicher Rückgabe verwendet wird, oder die Größe, die zum Speichern des Eigenschaftswerts erforderlich ist, wenn die Funktion mit ERROR_INSUFFICIENT_BUFFER fehlschlägt.

Rückgabewert

Diese Funktion gibt BOOL zurück.

Hinweise

Arrays sind nullbasiert, sodass der Index für das erste Element im Array 0 ist.

Die Password-Eigenschaft für eine Ereignisquelle oder das Abonnement kann nicht abgerufen werden. Aus Sicherheitsgründen wird eine leere Zeichenfolge für den Eigenschaftswert zurückgegeben, und der letzte Fehler wird auf ERROR_ACCESS_DENIED festgelegt.

Ein Abonnement kann über mehrere Ereignisquellen verfügen, und jede Quelle kann über eine Address-, Enabled-, UserName- und Password-Eigenschaft verfügen.

Beispiele

Beispielcode mit der EcGetObjectArrayProperty-Funktion finden Sie unter Anzeigen der Eigenschaften eines Ereignissammlerabonnements.

Anforderungen

Weitere Informationen

Windows-Ereignissammlerfunktionen