PFN_WdsCliCallback Rückruffunktion (wdsclientapi.h)

Definiert eine Rückruffunktion, die WDS für Statusbenachrichtigungen und Fehlermeldungen während einer Datei- oder Bildübertragung aufrufen kann.

Syntax

PFN_WdsCliCallback PfnWdsclicallback;

void PfnWdsclicallback(
  [in]           DWORD dwMessageId,
  [in, optional] WPARAM wParam,
  [in, optional] LPARAM lParam,
  [in, optional] PVOID pvUserData
)
{...}

Parameter

[in] dwMessageId

Der Nachrichtentyp und die Bedeutung des lParam-Parameters .

Dieser Parameter kann nur einen der folgenden Werte aufweisen.

Wert	Bedeutung
WDS_CLI_MSG_START 0	Die Übertragungsstartmeldung. Der lParam-Parameter ist ein Zeiger auf einen LARGE_INTEGER Wert, der die Dateigröße der Übertragung enthält.
WDS_CLI_MSG_COMPLETE 1	Die Nachricht zum Abschluss der Übertragung. Der lParam-Parameter ist ein HRESULT-Wert .
WDS_CLI_MSG_PROGRESS 2	Die Übertragungsstatusmeldung. Der lParam-Parameter ist ein ULONG-Wert , der dem Prozentsatz der abgeschlossenen Übertragung entspricht.
WDS_CLI_MSG_TEXT 3	Die Informationsmeldung. Der lParam-Parameter ist ein Zeiger auf eine Debugzeichenfolge, die für Diagnosezwecke verwendet werden kann.

[in, optional] wParam

Dieser Nachrichtenparameter sollte immer auf den Wert des Übertragungshandles festgelegt werden, der von der WdsCliTransferImage - oder WdsCliTransferFile-Funktion zurückgegeben wird.

[in, optional] lParam

Die Bedeutung des in diesem Parameter enthaltenen Werts hängt vom dwMessageId-Parameter ab.

[in, optional] pvUserData

Ein Zeiger auf optionale Benutzerinformationen, die mit der WdsCliTransferImage - oder WdsCliTransferFile-Funktion an diese Sitzung angefügt werden.

Rückgabewert

Keine

Bemerkungen

Eine Rückruffunktion kann die WdsCliCancelTransfer-Funktion aufrufen, um eine Übertragung abzubrechen. Obwohl eine Rückruffunktion auch die WdsCliWaitForTransfer-Funktion aufrufen kann, wird dies nicht empfohlen, da keine zusätzlichen Rückrufe empfangen werden, bis der aktuelle Rückruf aufgehoben ist.

Anforderungen

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