SDK 組み込み型プロテクションとは
ソフト電池開発キット(ソフト電池SDK)を用いて、ソフトウェアのソースコードにソフト電池対応コードを追加してソフト電池化します。
なお、このページでは、C/C++、ActiveX のソフト電池関数(メソッド)のリファレンスを記載しています。
第1部 関数(メソッド)リファレンス
記載している関数(メソッド)は、頻繁に使用されるもののみであり、全ての関数(メソッド)については、
ソフト電池 SDK をインストールした「%ProgramFiles%\SdSdk\include」以下のインクルード(ヘッダ)ファイルを参照して下さい。
尚、関数(メソッド)名の後ろに記述している記号は、表1-1に示す意味を持ちます。
表1−1 記号の意味
記号
重要度
意味・内容
***
高
ソフト電池の組み込みにおいて、多くの場合実装する必要がある関数(メソッド)。関数(メソッド)の意味をよく理解する必要があります。
ほとんどのアプリケーションは、この範囲で実装可能です。
**
中
かなりきめ細かい組み込みを行う場合にのみ実装すべき関数(メソッド)。
通常は、特に使用する必要はありません。
*
低
デバッグ時に使用する関数(メソッド)。
関数(メソッド)⼀覧
C/C++、ActiveX の主なソフト電池関数(メソッド)の⼀覧を表1−2に⽰します。
表1-2 ソフト電池関数(メソッド)一覧(主なもの)
#
項目
関数(メソッド)名称
C/C++系
ActiveX 系
1
実行環境初期化
***
UC_SetSdkId
UC_Initialize
Initialize20
2
実行環境終了(後処理)
***
UC_Terminate
Terminate
3
初期化完了フラグ検査
*
UC_IsInitialized
IsInitialized
4
残量変更通知(受領)
**
UC_Message
UC_OnUcMessage
BatteryChange
5
ソフト電池 ID の GUID形式化/文字列化
**
UC_StringToGuid
UC_GuidToString
(該当なし)
6
ソフト電池マネージャのバージョン取得
*
UC_GetVersion
UC_GetVersionString
Version(プロパティ)
VersionText(プロパティ)
7
ソフト電池メーター起動
*
UC_OpenBatteryMeter
OpenBatteryMeter
8
ソフト電池メーター終了
*
UC_CloseBatteryMeter
CloseBatteryMeter (注2)
9
起動済ソフト電池メーターのハンドル取得
*
UC_GetBatteryMeter
GetBatteryMeter (注2)
10
ソフト電池充電 No.入力ダイアログ表示 (注2)
*
UC_Mode3Charge
UC_Mode3Charge
(左記を宣言して使用)
11
ソフト電池充電 No.有効性チェック (注3)
*
UC_IsValidChargeID
UC_IsValidChargeID
(左記を宣言して使用)
12
ブラウザ起動(ソフト電池ランタイムダウンロードサイト接続)
*
UC_OpneRuntimeSite
OpneRuntimeSite (注2)
13
ブラウザ起動(ソフト電池会員サイト接続)
*
UC_OpenMemberSite
OpenMemberSite
(注 1):ソフト電池バージョン 3.3 で追加。
(注 2):ソフト電池バージョン 3.5 で追加。
(注 3):ソフト電池バージョン 4.0 で追加。
表1-2 ソフト電池関数(メソッド)一覧(主なもの)
SDKID 指定タイプ
#
項目
関数(メソッド)名称
C/C++系
ActiveX 系
21
実行環境初期化
***
UC_NormalRestBySdkID
UC_TrialRestBySdkID
QueryNormalRestBySdkID
QueryTrialRestBySdkID
22
残量消費
***
UC_UseBySdkID
UseBySdkID
23
ソフト電池情報取得
**
UC_GetBatteryInfoBySdkID
GetBatteryTypeBySdkID
GetBatteryIDBySdkID
24
ソフト電池状態検査
**
UC_QueryBatteryState
QueryBatteryState
25
ソフト電池の拡張破損状況取得 (注1)
*
UC_QueryBatteryStateEx
QueryBatteryStateEx
26
体験電池設定状況取得 (注1)
**
UC_QueryTrialState
QueryTrialState (注2)
27
オープニング・ダイアログ表示 (注1)
**
UC_OpenningDialog2
UC_OpenningDialog2
(左記を宣言して使用)
28
ソフト電池関連情報設定 (注1)
**
UC_SetRtpData
SetRtpData (注2)
(注 1):ソフト電池バージョン 3.3 で追加。
(注 2):ソフト電池バージョン 3.5 で追加。
(注 3):ソフト電池バージョン 4.0 で追加。
重 要
※C/C++の場合、最低限必要なインクルードすべきヘッダーファイル及び、リンクするライブラリは以下の通りです。(「***」の関数を使用する場合。)
#include “UCApi.h”
#include “UCResult.h”
#include “UCMsg.h”
#pragma comment (lib, “ucsdkdll”)
(msvcrt.dll の静的リンクバージョンを使用する場合は、ucsdklib.lib となります。)
※「簡易タイプ(SDKID 指定不要)」と「SDKID 指定タイプ」
「簡易タイプ(SDKID 指定不要)」は、事前に実行環境の初期化処理(「UC_Initialize」関数(C/C++)、または、「Initialize20」メソッド(ActiveX))と、終了時に終了処理(「UC_Terminate」関数(C/C++)、または、「Terminate」メソッド(ActiveX))が必要な関数です。
「SDKID 指定タイプ」は、初期化処理と終了処理が不要な関数です。
※「簡易タイプ(SDKID 指定不要)」と「SDKID 指定タイプ」の使い分け
「簡易タイプ(SDKID 指定不要)」、「SDKID 指定タイプ」とも、ソフト電池の残量取得と残量消費の関数が存在します。機能的には両者とも同様の働きをしますが、「簡易タイプ(SDKID指定不要)」の方はオーバーヘッドが無い分処理速度が早くなります。但し、以下のケースでは「簡易タイプ(SDKID 指定不要)」が正しく機能しないことがあるため、「SDKID 指定タイプ」を使用して下さい。
– 初期処理呼出し直後
「UC_Initialize」関数(C/C++)、または、「Initialize20」メソッド(ActiveX)呼出し直後の場合(ソフト電池マネージャ(UCManSvc.exe)が初期処理実行中)。
– ダイアログからの呼出し
ダイアログ・メッセージのボタンなどからソフト電池関数(メソッド)を呼ぶ場合。