dbSheetClient

Access版が提供するAPI一覧(早見表)


API一覧と機能説明

Access対応版が提供するAPI(アプリケーションプログラムインターフェース)の一覧について説明します。

AccessからAPIを利用する際は、「参照設定」の"dbsAcNetClass"がチェックされていることを確認の上、以下の形式でVBAコードを記述します。
(例)
Dim blnStatus As Boolean
blnStatus=dbsCls.CopyLocalfromSvr(パラメーター)

※早見表のダウンロード(PDF表示)はこちらから

dbSheetClientサーバーと連携
No API名称 機能説明
1-1 GetUserGroup ログインユーザーが所属するグループ情報(複数あり)を取得する。
1-2 SetSvr_UserLog Webサービスを利用して、DBSサーバーにユーザー操作ログを送る。
1-3 dbs_DownloadFile サーバー上の指定ファイルをダウンロードする。
1-4 dbs_UploadFile サーバーに指定ファイルをアップロードする。
1-5 StartSvrShell サーバーにある実行プログラム(*.exeあるいは*.bat)を起動する。
1-6 SetProxy クライアントPCのInternet Explorer (IE)のプロキシー設定を継承する。
1-7 GetSvrF_Info サーバー上の指定ファイルの情報(ファイルサイズと更新日時)を取得する。
1-8 GetUserLevel ログインユーザーの開発権限レベルと管理者権限レベルを取得する。
1-9 GetSvrDrive サーバーが配置された物理ドライブ名を取得する。
1-10 SendSvrMail サーバーからメールを送信する。
データベース処理
No API名称 機能説明
2-1 SetConnection DLLにカレントプロジェクトコネクションオブジェクトを渡す。
2-2 CloseConnection Access終了時にDLL内でオープンしているコネクションオブジェクトを閉じる。
2-3 GetAllTables サーバーの指定DB上の全テーブル名を取得する。
2-4 GetAllViews サーバーの指定DB上の全ビュー名を取得する。
2-5 ClearLocalData ローカル指定テーブルのデータを全てクリアする。
2-6 CheckDataExists/td> Where条件データがサーバーDB指定テーブルに存在するかどうか確認する。
2-7 ExecQuerySvr 指定したサーバーDBでネイティブSQL(複数可)を実行する。トランザクションあり。
2-8 CopyLocal_fromSvr サーバーDB指定単体テーブルのデータを(すでにある)ローカルテーブルにコピーする。
2-9 MultiCopy_fromSvr サーバーDB指定複数テーブルのデータを(すでにある)ローカルテーブルにコピーする。
2-10 ImportLocal_fromSvr サーバーDB指定テーブルと同定義のテーブルをローカルに自動作成(Create Table)しデータをコピーする。
2-11 ImportAll_fromSvr サーバーDBの全テーブルと同定義のテーブルをローカルに自動作成(Create Table)し全データをコピーする。
2-12 LockSvrRecords サーバーDB指定テーブルのWhere条件のレコードをロック/解除する。
2-13 GetCSV_fromSvr サーバーDBにSQLで問い合わせ、結果をCSV形式(カンマ区切りの文字列)で返す。
2-14 CopySvr_fromLocal ローカルテーブルのWhere条件データに合わせ、サーバーDB指定テーブル上の同一条件のデータを更新する。
2-15 ReplaceSvr_fromLocal ローカルテーブルのWhere条件データに合わせ、サーバーDB指定テーブル上の同一条件のデータを差し替える。(トランザクションON)
2-16 ReplaceSvrNT_fromLocal ローカルテーブルのWhere条件データに合わせ、サーバーDB指定テーブル上の同一条件のデータを差し替える。(トランザクションOFF)
2-17 ReplaceSvTbl_fromLocal ローカルテーブルのWhere条件データに合わせ、サーバーDB指定テーブル上の同一条件のデータを差し替える。(1000レコード以上の更新向け)
2-18 InsertSvr_fromLocal サーバーDB指定テーブルにローカルテーブルのデータを挿入する。
2-19 ResetAutoCols ローカル指定テーブル(MDB側)のオートナンバー型フィールドをリセットする。
2-20 ChgDBconnect dbSheetClientサーバーが接続するデータベースを切り替える。(引数は接続文字列)
2-21 ChgDB_Alias dbSheetClientサーバーが接続するデータベースを切り替える。(引数はエイリアスNo.)
2-22 ImportSvrProcedure サーバーDBに対して、ストアドプロシージャーやネイティブSQLを実行し、その結果をローカルの既存テーブルに書き込む。テーブルがない場合は自動生成する。
2-23 SaveXML_SvrQuery サーバーDBに対して、ストアドプロシージャーやネイティブSQLを実行し、その結果をローカルにXMLファイルで保存する。
2-24 SetID_Manager サーバーDBに各テーブルの主キー項目(整数型)の最大値を管理するテーブル("MaxValueManager")を作成し、そこに現在の最大値をセットする。
2-25 GetIncrementID サーバーDBの主キー最大値管理テーブル("MaxValueManager")より、最大値+1の値を返すと同時に、その値を管理テーブルの対象テーブル名(項目名)のデータとしてセットする。
2-26 SetWebTimeout API実行時のタイムアウト値を設定する。デフォルト値は100秒(100,000ミリ秒)である。
2-27 ChgConnectMode サーバーDBへの接続を(dbSheetClientサーバーが提供する)Webサービス経由にするか、DBへの直接ローカル接続(LAN)にするかを設定する。
2-28 GetProjectUser Webサービスを利用して、指定プロジェクトに参加しているユーザー情報を取得する。
2-29 DiffCopy_fromSvr ローカルテーブルとサーバーテーブルのデータを比較し、差分レコードをローカルに取り込む。"DBS_UPDATE_DATE"の値を比較し、異なるレコードのみ差し替える。
2-30 ImportSchema_fromSvr サーバーDB指定テーブルと同定義のテーブルをローカルに自動作成(Create Table)する。データはコピーしない。
2-31 GetArray_fromSvr サーバーDBに対するSQL結果を2次元配列で取得する。
2-32 SetNullUpdate サーバーDB更新系APIでローカル側に対象レコードが存在しない場合に更新を許可する(True)か、処理を中断する(False)かを設定する。
2-33 ReplaceSvrNT_fromLocal2 ローカルテーブルのstrLC_Where条件データに合わせ、サーバーDB指定テーブルstrDBS_Table上のstrSV_where条件のデータを差し替える。
2-34 ExportSvr_fromLocal Accessの指定テーブルをサーバーDB(SQL Server / Oracle)のテーブルに移行する。
2-35 GetRecordset_fromSvr サーバーDB(SQL Server / Oracle)に対するSQLリクエストの結果をADODBレコードセット形式で返す。
2-36 GetDBSInformation 実行版(開発版)から渡されるサーバー情報やDB接続情報、ログイン情報を構造体dbSheetInfo2形式で取得する。
2-37 ReplaceSvrNT_fromRecordset ローカルのADODBレコードセットをサーバーの指定レコードと差し替える。挿入も可能。
その他
No API名称 機能説明
3-1 GetDLL_Version 現在PCにインストールされているDLL("dbsAcNetClass.dll")のバージョン情報を取得する。
3-2 MakeColumnHTML GoogleチャートAPIを利用し、棒グラフ表示HTMLを作成する。
3-3 MakeLineHTML GoogleチャートAPIを利用し、折れ線グラフ表示HTMLを作成する。
3-4 MakePieChartHTML GoogleチャートAPIを利用し、円グラフ(3D)表示HTMLを作成する。
3-5 MakeTableHTML GoogleチャートAPIを利用し、表形式HTMLを作成する。
3-6 MergeChartHTML GoogleチャートAPIで作成したHTMLをマージ(融合)する。
3-7 SetLogoutMode API実行時にログ出力するかどうかを設定する。

お問い合わせ

お問い合わせフォーム