WinCSVStartup

La fonction WinCSVStartup permet à une application de spécifier la version de Windows CSV requise et de récupérer les détails de l’implémentation windows CSV spécifique. Cette fonction doit être appelée par une application pour s’inscrire auprès d’une implémentation CSV Windows avant d’émettre d’autres appels CSV Windows.

Syntaxe

  
int WINAPI WinCSVStartup(   
WORD wVersionRequired,  
LPWCSVDATA lpwcsvdata  
);  

Paramètres

wVersionRequired
Spécifie la version de la prise en charge de Windows CSV requise. L’octet d’ordre élevé spécifie le numéro de version mineure (révision) ; l’octet d’ordre inférieur spécifie le numéro de version principale. La version actuelle de l’API CSV Windows est 1.0.

lpwcsvdata
Pointeur vers la structure de données CSV. La structure CSVDATA est définie comme suit :

typedef struct tagWCSVDATA {  
    WORD wVersion;  
    char szDescription[WCSVDESCRIPTION_LEN+1];  
}  CSVDATA, FAR * LPWCSVCDATA;  

WCSVDESCRIPTION est défini sur 127 et les membres de la structure sont les suivants :

wVersion

Version de Windows CSV prise en charge. L’octet d’ordre élevé spécifie le numéro de version mineure (révision) ; l’octet d’ordre inférieur spécifie le numéro de version principale.

szDescription.

Chaîne de description identifiant le fournisseur de la DLL CSV Windows.

Cette structure CVSDATA fournit des informations sur l’implémentation de DLL CSV Windows sous-jacente. Le premier champ wVersion a la même structure que le paramètre wVersionRequired , et le champ szDescription contient une chaîne identifiant le fournisseur de la DLL CSV Windows. Le champ description est uniquement destiné à fournir une chaîne d’affichage pour l’application et ne doit pas être utilisé pour faire la distinction par programmation entre les implémentations CSV Windows.

Valeurs de retour

La valeur de retour spécifie si l’application a été inscrite avec succès et si l’implémentation windows CSV peut prendre en charge le numéro de version spécifié. Si la valeur est égale à zéro, elle a été inscrite avec succès. Sinon, la valeur de retour est l’une des suivantes :

WCSVSYSNOTREADY
Indique que le système réseau sous-jacent n’est pas prêt pour la communication réseau.

WCSVVERNOTSUPPORTED
La version de la prise en charge csv de Windows demandée n’est pas fournie par cette implémentation windows CSV particulière.

WCSVINVALID
La version windows CSV spécifiée par l’application n’est pas prise en charge par cette DLL.

Remarques

Pour prendre en charge les futures implémentations windows CSV et les applications qui peuvent présenter des différences de fonctionnalités par rapport à Windows CSV version 1.0, une négociation a lieu dans WinCSVStartup. Une application passe à WinCSVStartup la version windows CSV qu’elle peut utiliser. Si cette version est inférieure à la version la plus basse prise en charge par la DLL CSV Windows, la DLL ne peut pas prendre en charge l’application et WinCSVStartup échoue. Toutefois, si la version n’est pas inférieure, l’appel réussit et retourne la version la plus élevée de Windows CSV prise en charge par la DLL. Si cette version est inférieure à la version la plus basse prise en charge par l’application, l’application échoue à son initialisation ou tente de trouver une autre DLL CSV Windows sur le système.

Cette négociation permet à une DLL CSV Windows et à une application CSV Windows de prendre en charge une gamme de versions de CSV Windows. Une application peut utiliser correctement une DLL en cas de chevauchement des versions. Le tableau suivant illustre le fonctionnement de WinCSVStartup conjointement avec différentes versions d’application et de DLL.

Versions d’application Versions de DLL Vers WinCSVStartup À partir de WinCSVStartup Résultats
1.0 1.0 1.0 1.0 Utiliser 1.0
1.0, 2.0 1.0 2.0 1.0 Utiliser 1.0
1.0 1.0, 2.0 1.0 2,0 Utiliser 1.0
1.0 2.0, 3.0 1.0 WCSVINVALID Échec
2.0, 3.0 1.0 3.0 1.0 Échec de l’application
1.0, 2.0, 3.0 1.0, 2.0, 3.0 3,0 3,0 Utiliser 3.0

Après avoir effectué son dernier appel CSV Windows, une application doit appeler WinCSVCleanup.

Chaque implémentation WINDOWS CSV doit effectuer un appel WinCSVStartup avant d’émettre d’autres appels CSV Windows. Par conséquent, cette fonction peut être utilisée à des fins d’initialisation.