Fonction ReadLogArchiveMetadata (clfsw32.h)

  • Article

Copie une plage de la vue archive des métadonnées dans la mémoire tampon spécifiée.

Syntaxe

CLFSUSER_API BOOL ReadLogArchiveMetadata(
  [in]      CLFS_LOG_ARCHIVE_CONTEXT pvArchiveContext,
  [in]      ULONG                    cbOffset,
  [in]      ULONG                    cbBytesToRead,
  [in, out] PBYTE                    pbReadBuffer,
  [out]     PULONG                   pcbBytesRead
);

Paramètres

[in] pvArchiveContext

Pointeur vers un contexte d’archive obtenu par un appel à PrepareLogArchive.

Le contexte conserve l’état du curseur, ce qui permet l’itération via l’ensemble d’étendues de fichier dans l’archive. Le client d’archive est responsable de la désaffectation du contexte à l’aide de la fonction TerminateLogArchive .

[in] cbOffset

Décalage dans les métadonnées où commence la copie des données.

Lors du premier appel à cette fonction, spécifiez zéro (0). Lors des appels suivants, spécifiez la valeur retournée dans pcbBytesRead.

[in] cbBytesToRead

Le nombre d’octets des métadonnées instantané doit être copié dans pbReadBuffer.

Ce paramètre ne peut pas être égal à zéro (0).

[in, out] pbReadBuffer

Pointeur vers la mémoire tampon où les métadonnées instantané sont copiées.

[out] pcbBytesRead

Pointeur vers une variable qui reçoit le nombre d’octets copiés dans pbReadBuffer.

Le nombre d’octets est toujours compris entre zéro (0) et cbBytesToRead.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro (0). Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. La liste suivante identifie les codes d’erreur possibles :

Configuration requise

   
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête clfsw32.h
Bibliothèque Clfsw32.lib
DLL Clfsw32.dll

Voir aussi

Fonctions courantes du système de fichiers journaux

PrepareLogArchive

TerminateLogArchive