Share via

EcGetSubscriptionProperty-Funktion (evcoll.h)

  • Artikel

Die EcGetSubscriptionProperty-Funktion ruft einen bestimmten Eigenschaftswert aus einem Abonnementobjekt ab. Das Abonnementobjekt wird durch das Handle angegeben, das an den Subscription-Parameter übergeben wird.

Syntax

BOOL EcGetSubscriptionProperty(
  [in]  EC_HANDLE                   Subscription,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
  [in]  DWORD                       Flags,
  [in]  DWORD                       PropertyValueBufferSize,
  [in]  PEC_VARIANT                 PropertyValueBuffer,
  [out] PDWORD                      PropertyValueBufferUsed
);

Parameter

[in] Subscription

Das Handle für das Abonnementobjekt.

[in] PropertyId

Ein Bezeichner, der angibt, welche Eigenschaft des Abonnements abgerufen werden soll. Geben Sie einen Wert aus der EC_SUBSCRIPTION_PROPERTY_ID-Enumeration an. Wenn Sie den EcSubscriptionEventSources-Wert angeben, wird ein Handle für ein Array (EC_OBJECT_ARRAY_PROPERTY_HANDLE) zurückgegeben. Anschließend können Sie die Funktionen EcGetObjectArrayProperty und EcSetObjectArrayProperty verwenden, um die Eigenschaften Address, Enabled, UserName und Password im Array abzurufen und festzulegen.

[in] Flags

Reserviert. Muss NULL sein.

[in] PropertyValueBufferSize

Die Größe des vom Benutzer bereitgestellten Puffers, in dem der Eigenschaftswert gespeichert werden soll.

[in] PropertyValueBuffer

Der vom Benutzer bereitgestellte Puffer zum Speichern des Eigenschaftswerts.

[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 erforderlich ist, um den Eigenschaftswert zu speichern, wenn die Funktion mit ERROR_INSUFFICIENT_BUFFER fehlschlägt.

Rückgabewert

Diese Funktion gibt BOOL zurück.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista
Unterstützte Mindestversion (Server) Windows Server 2008
Zielplattform Windows
Kopfzeile evcoll.h
Bibliothek Wecapi.lib
DLL Wecapi.dll

Weitere Informationen

Windows-Ereignissammlerfunktionen