Fonction PdhOpenLogW (pdh.h)
Ouvre le fichier journal spécifié pour la lecture ou l’écriture.
Syntaxe
PDH_FUNCTION PdhOpenLogW(
[in] LPCWSTR szLogFileName,
[in] DWORD dwAccessFlags,
[in] LPDWORD lpdwLogType,
[in] PDH_HQUERY hQuery,
[in] DWORD dwMaxSize,
[in] LPCWSTR szUserCaption,
[out] PDH_HLOG *phLog
);
Paramètres
[in] szLogFileName
Chaîne terminée par null qui spécifie le nom du fichier journal à ouvrir. Le nom peut contenir un chemin absolu ou relatif.
Si le paramètre lpdwLogType est PDH_LOG_TYPE_SQL, spécifiez le nom du fichier journal au format SQL:DataSourceName!LogFileName.
[in] dwAccessFlags
Type d’accès à utiliser pour ouvrir le fichier journal. Spécifiez l’une des valeurs suivantes.
Vous pouvez utiliser l’opérateur OR inclusif au niveau du bit (|) pour combiner le type d’accès avec un ou plusieurs des indicateurs de création suivants.
Valeur | Signification |
---|---|
|
Crée un fichier journal portant le nom spécifié. |
|
Crée un fichier journal portant le nom spécifié. Si le fichier journal existe déjà, la fonction supprime le fichier journal existant avant de créer le nouveau fichier. |
|
Ouvre un fichier journal existant portant le nom spécifié. Si un fichier journal portant le nom spécifié n’existe pas, cela est égal à PDH_LOG_CREATE_NEW. |
|
Ouvre un fichier journal existant portant le nom spécifié ou crée un fichier journal portant le nom spécifié. |
|
Crée un fichier journal circulaire avec le nom spécifié. Lorsque le fichier atteint la valeur du paramètre dwMaxSize , les données sont encapsulée au début du fichier journal. Vous pouvez spécifier cet indicateur uniquement si le paramètre lpdwLogType est PDH_LOG_TYPE_BINARY. |
|
Utilisé avec PDH_LOG_TYPE_TSV pour écrire le légende utilisateur ou la description du fichier journal indiquée par le paramètre szUserString de PdhUpdateLog ou PdhOpenLog. La légende utilisateur ou la description du fichier journal est écrite en tant que dernière colonne de la première ligne du journal texte. |
[in] lpdwLogType
Type de fichier journal à ouvrir. Ce paramètre peut prendre les valeurs suivantes.
[in] hQuery
Spécifiez un handle de requête si vous écrivez des données de requête dans un fichier journal. La fonction PdhOpenQuery retourne ce handle.
Ce paramètre est ignoré et doit avoir la valeur NULL si vous lisez à partir du fichier journal.
[in] dwMaxSize
Taille maximale du fichier journal, en octets. Spécifiez la taille maximale si vous souhaitez limiter la taille du fichier ou si dwAccessFlags spécifie PDH_LOG_OPT_CIRCULAR ; sinon, définissez sur 0.
Pour les fichiers journaux circulaires, vous devez spécifier une valeur suffisamment grande pour contenir au moins un exemple. La taille de l’échantillon dépend des données collectées. Toutefois, la spécification d’une valeur d’au moins un mégaoctet couvre la plupart des exemples.
[in] szUserCaption
Chaîne terminée par null qui spécifie la légende définie par l’utilisateur du fichier journal. Un fichier journal légende décrit généralement le contenu du fichier journal. Lorsqu’un fichier journal existant est ouvert, la valeur de ce paramètre est ignorée.
[out] phLog
Gérez le fichier journal ouvert.
Valeur retournée
Si la fonction réussit, elle retourne ERROR_SUCCESS.
Si la fonction échoue, la valeur renvoyée est un code d’erreur système ou un code d’erreur PDH.
Notes
Pour utiliser cette fonction pour écrire des données de performances dans un fichier journal, vous devez ouvrir une requête à l’aide de PdhOpenQuery et y ajouter les compteurs souhaités avant d’appeler cette fonction.
Les systèmes d’exploitation plus récents peuvent lire les fichiers journaux qui ont été générés sur des systèmes d’exploitation plus anciens ; toutefois, les fichiers journaux créés sur Windows Vista et les systèmes d’exploitation ultérieurs ne peuvent pas être lus sur les systèmes d’exploitation antérieurs.
Les règles suivantes s’appliquent aux fichiers journaux
READ_ACCESS nécessite OPEN_EXISTING.
UPDATE_ACCESS ne peut pas être utilisé avec les journaux basés sur des fichiers. Il ne peut être utilisé qu’avec les journaux de base de données.
WRITE_ACCESS nécessite l’une des CREATE_NEW, CREATE_ALWAYS, OPEN_EXISTING, OPEN_ALWAYS.
Exemples
Pour obtenir un exemple, consultez Écriture de données de performances dans un fichier journal.
Notes
L’en-tête pdh.h définit PdhOpenLog comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Spécifications
Client minimal pris en charge | Windows XP [applications de bureau uniquement] |
Serveur minimal pris en charge | Windows Server 2003 [applications de bureau uniquement] |
Plateforme cible | Windows |
En-tête | pdh.h |
Bibliothèque | Pdh.lib |
DLL | Pdh.dll |