Partager via


COleDateTimeSpan::Format

Génère une représentation sous forme de chaîne mise en forme d'un objet d' COleDateTimeSpan .

CString Format( 
   LPCTSTR pFormat  
) const; 
CString Format( 
   UINT nID  
) const;

Paramètres

  • pFormat
    Une chaîne de mise en forme semblable à printf forme la chaîne. Les codes de mise en forme, précédés par un pourcentage (%archivent), sont substitués par le composant correspondant d' COleDateTimeSpan . D'autres caractères dans la chaîne de format sont copiés inchangés à la chaîne retournée. La valeur et la signification des codes de mise en forme pour Format sont répertoriées ci-dessous :

    • Heures de**%H** dans le jour actuel

    • Minutes de**%M** dans l'heure actuelle

    • Secondes de**%S** dans la minute actuelle

    • Signe de pourcentage de %%

    Les quatre codes de format répertoriés ci-dessus sont les seuls codes que le format recevra.

  • nID
    L'ID de ressource pour la chaîne de format.

Valeur de retour

CString qui contient la valeur de la plage date/heure mise en forme.

Notes

Appelez ces fonctions pour créer une représentation mise en forme de la valeur timespan. Si l'état de cet objet d' COleDateTimeSpan est null, la valeur de retour est une chaîne vide. Si le mode est incorrect, la chaîne de retour est spécifiée par la ressource de type chaîne IDS_INVALID_DATETIMESPAN.

Une brève description des formes pour cette fonction suivante :

  • Format( pFormat )
    Ce formulaire met en forme la valeur à l'aide de la chaîne de format qui contient les codes de mise en forme spéciaux qui sont précédés par un signe de pourcentage (%), comme dans printf. La chaîne de mise en forme est passée comme paramètre à la fonction.

  • Format( nID )
    Ce formulaire met en forme la valeur à l'aide de la chaîne de format qui contient les codes de mise en forme spéciaux qui sont précédés par un signe de pourcentage (%), comme dans printf. La chaîne de mise en forme est une ressource. L'ID de cette ressource de type chaîne passée comme paramètre.

Exemple

// get the current time
COleDateTime tmStart = COleDateTime::GetCurrentTime();

// waste some time
CString str;
::Sleep(3000);

// get the current time again
COleDateTime tmFinish = COleDateTime::GetCurrentTime();

// find the difference
COleDateTimeSpan tmSpan = tmFinish - tmStart;

// tell the user
str = tmSpan.Format(_T("%S seconds elapsed"));
_tprintf_s(_T("%s\n"), (LPCTSTR) str);

Configuration requise

Header: atlcomtime.h

Voir aussi

Référence

COleDateTimeSpan, classe

Graphique de la hiérarchie

COleDateTimeSpan::GetStatus