IBandSite::QueryBand-Methode (shobjidl_core.h)

Ruft Informationen zu einer Band in einer Bandwebsite ab.

Syntax

HRESULT QueryBand(
  [in]            DWORD     dwBandID,
  [out, optional] IDeskBand **ppstb,
  [out, optional] DWORD     *pdwState,
  [out]           LPWSTR    pszName,
  [in]            int       cchName
);

Parameter

[in] dwBandID

Art: DWORD

Die ID des abzufragenden Bandobjekts.

[out, optional] ppstb

Typ: IDeskBand**

Adresse eines IDeskBand-Schnittstellenzeigers , der bei erfolgreicher Rückgabe dieser Methode auf das IDeskBand-Objekt verweist, das das Band darstellt. Dieser Wert kann NULL sein.

[out, optional] pdwState

Typ: DWORD*

Zeiger auf einen DWORD-Wert , der bei erfolgreicher Rückgabe dieser Methode den Zustand des Bandobjekts empfängt. Dieser Zustand ist eine Kombination aus BSSF_VISIBLE, BSSF_NOTITLE und BSSF_UNDELETEABLE. Weitere Informationen zu diesen Flags finden Sie unter BANDSITEINFO . Dieser Wert kann NULL sein, wenn die Zustandsinformationen nicht benötigt werden.

[out] pszName

Typ: LPWSTR

Zeiger auf einen Puffer von cchName-Unicode-Zeichen , der bei erfolgreicher Rückgabe dieser Methode den Namen des Bandobjekts empfängt.

[in] cchName

Typ: int

Die Größe des puffers pszName in Zeichen.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Anforderungen