Méthode IWMDMProgress3 ::Begin3 (mswmdm.h)

Article
03/04/2024

La méthode Begin3 est appelée par Windows Media Gestionnaire de périphériques pour indiquer qu’une opération est sur le point de commencer. Une estimation de la durée de l’opération est fournie lorsque cela est possible. Cette méthode étend IWMDMProgress ::Begin en fournissant des paramètres d’entrée supplémentaires pour l’identification (ID) de l’événement et pour un pointeur vers le contexte facultatif des commandes. L’opération est identifiée par un ID d’événement. La méthode permet à l’appelant de passer une structure de données opaque à l’application.

Syntaxe

HRESULT Begin3(
  [in]      GUID          EventId,
  [in]      DWORD         dwEstimatedTicks,
  [in, out] OPAQUECOMMAND *pContext
);

Paramètres

[in] EventId

GUID identifiant l’opération qui va commencer. Les valeurs possibles sont présentées dans le tableau suivant.

Événement	Description
SCP_EVENTID_ACQSECURECLOCK	Windows Media Gestionnaire de périphériques acquiert une horloge sécurisée à partir du serveur.
SCP_EVENTID_NEEDTOINDIV	L’appareil est en cours d’individualisation. Il n’est pas utilisé actuellement.
SCP_EVENTID_DRMINFO	Cet ID d’événement est utilisé pour notifier l’application avec l’en-tête DRM de version trouvé dans le contenu de chaque fichier. La structure OPAQUECOMMAND retournée a le membre guidCommand défini sur SCP_PARAMID_DRMVERSION. En outre, OPAQUECOMMAND spécifie l’un des indicateurs suivants : WMDM_SCP_DRMINFO_NOT_DRMPROTECTED WMDM_SCP_DRMINFO_V1HEADER WMDM_SCP_DRMINFO_V2HEADER
EVENT_WMDM_CONTENT_TRANSFER	Le contenu est transféré vers ou depuis l’appareil.

[in] dwEstimatedTicks

DWORD spécifiant le nombre estimé de graduations nécessaires à la fin de l’opération. Le nombre de graduations passées dans dwEstimatedTicks est une estimation du nombre de ticks nécessaires pour que l’opération se termine. Au cours de l’opération, la méthode Progress3 est appelée pour indiquer le nombre de graduations qui se sont produites. Les applications peuvent utiliser l’estimation pour configurer des mécanismes d’affichage qui indiquent la progression.

[in, out] pContext

Pointeur vers une structure OPAQUECOMMAND contenant une commande envoyée à l’appareil sans être gérée par Windows Media Gestionnaire de périphériques. Ce paramètre est facultatif et peut être NULL.

Valeur retournée

L’application doit retourner l’une des valeurs HRESULT suivantes.

Code de retour	Description
S_OK	L’opération doit continuer.
WMDM_E_USER_CANCELLED	Windows Media Gestionnaire de périphériques doit annuler l’opération en cours sans attendre qu’elle se termine. Si l’application utilise le mode bloc, Windows Media Gestionnaire de périphériques retourne cette erreur à l’application.

Remarques

L’application retourne S_OK pour indiquer qu’une opération doit être poursuivie et WMDM_E_USER_CANCELLED pour indiquer que l’opération doit être annulée. Si l’application utilise le mode bloc et retourne WMDM_E_USER_CANCELLED, Windows Media Gestionnaire de périphériques retourne cette même erreur à l’application.

Exemples

Le code C++ suivant montre un exemple d’implémentation de Begin3.


HRESULT Begin3(GUID  EventId, DWORD  dwEstimatedTicks, OPAQUECOMMAND*  pContext)
{
    WCHAR strGuid[64];
    StringFromGUID2(reinterpret_cast<GUID&>(EventId),(LPOLESTR)strGuid, 64);
    // TODO: Display the message "IWMDMProgress3::Begin3 called." 
    // followed by the strGuid value.
    return S_OK;
}