WinCSVStartup

WinCSVStartup 関数を使用すると、アプリケーションで必要な Windows CSV のバージョンを指定し、特定の Windows CSV 実装の詳細を取得できます。 この関数は、それ以降の Windows CSV 呼び出しを発行する前に、アプリケーションが Windows CSV 実装に登録するために呼び出す必要があります。

構文

  
int WINAPI WinCSVStartup(   
WORD wVersionRequired,  
LPWCSVDATA lpwcsvdata  
);  

パラメーター

wVersionRequired
必要な Windows CSV サポートのバージョンを指定します。 上位バイトはマイナー バージョン (リビジョン) 番号を指定します。下位バイトはメジャー バージョン番号を指定します。 Windows CSV API の現在のバージョンは 1.0 です。

lpwcsvdata
CSV データ構造へのポインター。 CSVDATA 構造体は次のように定義されます。

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

ここで、WCSVDESCRIPTION は 127 に定義され、構造体メンバーは次のようになります。

wVersion

サポートされている Windows CSV のバージョン。 上位バイトはマイナー バージョン (リビジョン) 番号を指定します。下位バイトはメジャー バージョン番号を指定します。

szDescription

Windows CSV DLL のベンダーを識別する説明文字列。

この CVSDATA 構造体は、基になる Windows CSV DLL の実装に関する情報を提供します。 最初の wVersion フィールドは wVersionRequired パラメーターと同じ構造を持ち、 szDescription フィールドには Windows CSV DLL のベンダーを識別する文字列が含まれています。 説明フィールドは、アプリケーションの表示文字列を提供することのみを目的としており、Windows CSV の実装をプログラムで区別するために使用しないでください。

戻り値

戻り値は、アプリケーションが正常に登録されたかどうか、および Windows CSV 実装で指定されたバージョン番号をサポートできるかどうかを指定します。 値が 0 の場合は、正常に登録されました。 それ以外の場合、戻り値は次のいずれかになります。

WCSVSYSNOTREADY
基になるネットワーク システムがネットワーク通信の準備ができていないことを示します。

WCSVVERNOTSUPPORTED
要求された Windows CSV サポートのバージョンは、この特定の Windows CSV 実装では提供されません。

WCSVINVALID
アプリケーションで指定された Windows CSV バージョンは、この DLL ではサポートされていません。

注釈

Windows CSV バージョン 1.0 と機能の違いがある可能性がある将来の Windows CSV の実装とアプリケーションをサポートするために、 WinCSVStartup でネゴシエーションが行われます。 アプリケーションが WinCSV に渡されます。使用できる Windows CSV バージョンを起動します。 このバージョンが Windows CSV DLL でサポートされている最低バージョンより低い場合、DLL はアプリケーションをサポートできず、 WinCSVStartup は失敗します。 ただし、バージョンが低くない場合、呼び出しは成功し、DLL でサポートされている Windows CSV の最上位バージョンを返します。 このバージョンがアプリケーションでサポートされている最も低いバージョンより低い場合、アプリケーションは初期化に失敗するか、システム上の別の Windows CSV DLL を見つけようとします。

このネゴシエーションにより、Windows CSV DLL と Windows CSV アプリケーションの両方で、さまざまな Windows CSV バージョンをサポートできます。 バージョンに重複がある場合、アプリケーションは DLL を正常に使用できます。 次の表は、 WinCSVStartup がさまざまなアプリケーションと DLL のバージョンと連携して動作する方法を示しています。

アプリケーションのバージョン DLL のバージョン WinCSVStartup へ WinCSVStartup から 結果
1.0 1.0 1.0 1.0 1.0 を使用する
1.0、2.0 1.0 2.0 1.0 1.0 を使用する
1.0 1.0、2.0 1.0 2.0 1.0 を使用する
1.0 2.0, 3.0 1.0 WCSVINVALID 失敗
2.0, 3.0 1.0 3.0 1.0 アプリが失敗する
1.0, 2.0, 3.0 1.0, 2.0, 3.0 3.0 3.0 3.0 を使用する

最後の Windows CSV 呼び出しを行った後、アプリケーションは WinCSVCleanup を呼び出す必要があります。

各 Windows CSV 実装では、他の Windows CSV 呼び出しを発行する前に WinCSVStartup 呼び出しを行う必要があります。 そのため、この関数は初期化の目的で使用できます。