Fonction PdhVbOpenLog
La fonction PdhVbOpenLog ouvre le fichier journal spécifié pour la lecture et l’écriture. Cette fonction appelle PdhOpenLog.
Important
La fonction décrite dans cette rubrique peut être modifiée ou indisponible à l’avenir. Au lieu de cela, Microsoft vous recommande d’utiliser les fonctions décrites dans Fonctions compteurs de performances.
Fonction PdhVbOpenLog( _ ByVal szLogFileName As LPCTSTR, _ ByVal dwAccessFlags As DWORD, _ ByVal lpdwLogType As LPDWORD, _ ByVal hQuery As PDH_HQUERY, _ ByVal dwMaxSize As DWORD, _ ByVal szUserCaption As LPCSTR, _ ByRef phLog As PDH_HLOG _ ) As DWORD
Paramètres
-
szLogFileName [in]
-
Pointeur vers une chaîne qui spécifie le nom du fichier journal à ouvrir.
Si le fichier journal contient des données SQL, le format du nom du fichier journal est **SQL:DataSourceName!**LogFileName. Dans ce cas, la valeur du paramètre lpdwLogType est PDH_LOG_TYPE_SQL.
-
dwAccessFlags [in]
-
Type d’accès à spécifier lors de l’ouverture du fichier journal. Ce paramètre peut prendre les valeurs suivantes.
Valeur Signification - PDH_LOG_READ_ACCESS
Un fichier journal est ouvert pour une opération de lecture. - PDH_LOG_WRITE_ACCESS
Un nouveau fichier journal est ouvert pour une opération d’écriture. - PDH_LOG_UPDATE_ACCESS
Un fichier journal existant est ouvert pour une opération d’écriture. La valeur sélectionnée dans la table précédente peut être combinée à l’aide de l’opérateur OR avec l’un des indicateurs d’accès de création suivants.
Valeur Signification - PDH_LOG_CREATE_NEW
Un nouveau fichier journal portant le nom spécifié est créé. - PDH_LOG_CREATE_ALWAYS
Un nouveau fichier journal portant le nom spécifié est créé et tout fichier journal existant portant le même nom est effacé. - PDH_LOG_OPEN_EXISTING
Un fichier journal existant portant le nom spécifié est ouvert. Si un fichier journal portant le nom spécifié n’existe pas, cela est égal à PDH_LOG_CREATE_NEW. - PDH_LOG_OPEN_ALWAYS
Un fichier journal existant portant le nom spécifié est ouvert ou un nouveau fichier journal portant le nom spécifié est créé. -
lpdwLogType [in]
-
Pointeur vers une variable qui indique le type de fichier journal à ouvrir. Ce paramètre peut prendre les valeurs suivantes.
Valeur Signification - PDH_LOG_TYPE_UNDEFINED
Format de fichier journal non défini. - PDH_LOG_TYPE_CSV
Fichiers texte contenant des en-têtes de colonne dans la première ligne et des exemples de données individuels dans chaque ligne suivante. - PDH_LOG_TYPE_SQL
Les données du fichier journal sont dans SQL. - PDH_LOG_TYPE_TSV
Identique à PDH_LOG_TYPE_CSV. - PDH_LOG_TYPE_BINARY
Format de fichier journal binaire. Inclut des fichiers journaux circulaires. - PDH_LOG_TYPE_PERFMON
Format de fichier journal Perfmon. -
hQuery [in]
-
Handle de requête. Ce handle est retourné par la fonction PdhVbOpenQuery .
Ce paramètre peut avoir la valeur NULL si le fichier journal doit être ouvert pour lecture.
-
dwMaxSize [in]
-
Taille maximale du fichier journal, en octets. Cette valeur est utilisée uniquement si le fichier journal est un fichier journal de taille limitée ou circulaire.
-
szUserCaption [in]
-
Pointeur vers une chaîne qui spécifie le légende défini 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.
-
phLog [in, ref]
-
Pointeur vers une mémoire tampon qui reçoit un handle vers le fichier journal ouvert.
Valeur retournée
Si la fonction réussit, elle retourne 0.
Si la fonction échoue, la valeur renvoyée est un code d’erreur système ou un code d’erreur PDH. Voici les valeurs possibles.
| Code de retour | Description |
|---|---|
|
Les données demandées sont plus volumineuses que la mémoire tampon fournie. Impossible de retourner les données demandées. |
|
Une ou plusieurs des mémoires tampons de chaîne n’ont pas la taille correcte. |
|
Le handle n’est pas un objet PDH valide. |
|
Impossible d’ouvrir le fichier journal spécifié. |
|
Impossible de trouver le fichier spécifié. |
Notes
Lorsque vous utilisez cette fonction pour écrire des données de performances dans un fichier journal, une requête doit d’abord être ouverte à l’aide de PdhVbOpenQuery.
Il doit y avoir une requête actuellement ouverte et les compteurs souhaités doivent y être ajoutés, avant que cette fonction soit appelée.
Notez que les fichiers journaux au format Perfmon ne peuvent être ouverts qu’à des fins de lecture.
Spécifications
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge |
Windows XP [applications de bureau uniquement] |
| Serveur minimal pris en charge |
Windows Server 2003 [applications de bureau uniquement] |
| Bibliothèque |
|
| DLL |
|