|
|
|
產(chǎn)品名稱：
|
OPC客戶端開發(fā)工具包
|
|
型 號：
|
|
|
價 格：
|
|
|
品 牌：
|
10532
|
|
|
|
|
OPC客戶端開發(fā)工具包
|
產(chǎn)品名稱：OPC客戶端開發(fā)快速工具
產(chǎn)品規(guī)格：DLL
產(chǎn)品備注：通過OPC基金會客戶端分析軟件測試
產(chǎn)品類別：OPC快速開發(fā)工具(Win32)
產(chǎn)品說明：
一、 簡介
OM_OPCClt.dll是根據(jù)OPC DA 2.05a Specification撰寫出來的OPC DA Client的開發(fā)工具包，其具有以下特點(diǎn)：
1. 使用STL撰寫。
2. 使用Unicode字符集，源碼可方便地移植到WinCE平臺下
3. 支持WinCE平臺
4. 可連接OPC DA 2.0 和 1.0服務(wù)器
5.被多個開發(fā)平臺支持。如：VB、DELPHI、VC++和.net。
二、 API介紹
1. HRESULT OMCoInit()
初始化COM庫
2. void OMCoUninit()
反初始化COM庫
====================================================
3. HRESULT NumberOfOPCServers(LPCWSTR szMachineName, int *num)
枚舉機(jī)器上安裝的OPC服務(wù)器
szMachineName: 要枚舉服務(wù)器的機(jī)器名
num: 返回OPC服務(wù)器的數(shù)目
4. HRESULT GetOPCServerName(int nIndex, WCHAR *pBuf, int nBufSize)
獲取OPC服務(wù)器的ProgID
nIndex: OPC服務(wù)器的位置，其值在0~(num-1)之間
pBuf: 存儲獲取的OPC服務(wù)器的ProgID
nBufSize: 緩沖區(qū)的大小
5. HRESULT ConnectOPCServer(LPCWSTR szMachineName, LPCWSTR szServerName, HANDLE hClient, HANDLE *phConnect)
與OPC服務(wù)器建立連接
szMachineName: 要連接的服務(wù)器所在的機(jī)器位置
szServerName: OPC服務(wù)器的ProgID
hClient: Client傳遞的句柄，當(dāng)有Shutdown回調(diào)時會回傳此句柄
phConnect: 存儲對應(yīng)服務(wù)器的句柄
6. HRESULT EnableShutdownCallback(HANDLE hConnect, SHUTDOWNPROC lpCallback)
設(shè)置Shutdown回調(diào)，當(dāng)Server關(guān)閉時會產(chǎn)生此回調(diào)
hConnect: OPC服務(wù)器的句柄
lpCallback: 產(chǎn)生回調(diào)時執(zhí)行的函數(shù)
7. HRESULT GetSvrStatus(HANDLE hConnect, OPCSERVERSTATUS *pSvrStatus, int nVendorInfoBufSize)
獲取服務(wù)器的狀態(tài)信息
hConnect: OPC服務(wù)器的句柄
pSvrStatus: 存儲服務(wù)器的狀態(tài)信息
nVendorInfoBufSize: 指示存儲VendorInfo的緩沖區(qū)的大小
8. HRESULT DisconnectOPCServer(HANDLE hConnect)
與OPC服務(wù)器斷開連接
hConnect: 指向相應(yīng)服務(wù)器的句柄
====================================================
9. HRESULT NumberOfOPCItems(HANDLE hConnect, int *num)
獲取Server地址空間中定義的Item數(shù)目
hConnect: 對應(yīng)服務(wù)器的句柄
num: 存儲返回的Item數(shù)目
10. HRESULT GetOPCItemName(HANDLE hConnect, int nIndex, WCHAR *pBuf, int nBufSize)
獲取Item的標(biāo)志符
hConnect: 對應(yīng)服務(wù)器的句柄
nIndex: Item的位置，范圍在0~（num-1）之間
pBuf: 存儲Item標(biāo)志符的緩沖區(qū)地址
nBufSize: 指示緩沖區(qū)大小
11. HRESULT SetBrowseFilters(HANDLE hConnect, LPCWSTR szFilterCriteria, VARTYPE vtDataTypeFilter, DWORD dwAccessRightsFilter)
設(shè)置獲取Item過濾器，此函數(shù)應(yīng)在NumberOfOPCItems之前調(diào)用，適用于DA 2.0 Server
hConnect: 對應(yīng)服務(wù)器的句柄
szFilterCriteria: Server端定義的過濾字符串
vtDataTypeFilter: Item類型過濾
dwAccessRightsFilter: 訪問權(quán)限過濾
12. HRESULT SetBrowseFiltersEx(HANDLE hConnect, LPCWSTR szNameFilter, LPCWSTR szVendorFilter)
設(shè)置獲取Item過濾器，此函數(shù)應(yīng)在NumberOfOPCItems之前調(diào)用，適用于DA 3.0 Server
hConnect: 對應(yīng)服務(wù)器的句柄
szNameFilter: Item名稱過濾
szVendorFilter: Server端自定義的過濾字符串
13. HRESULT GetNameSpaceType(HANDLE hConnect, OPCNAMESPACETYPE *pNameSpaceType)
獲取服務(wù)器地址空間的類型
hConnect: 對應(yīng)服務(wù)器的句柄
pNameSpaceType: 存儲服務(wù)器地址空間的類型
14. HRESULT BrowseTo(HANDLE hConnect, LPCWSTR szNodeName)
移動到地址空間指定的節(jié)點(diǎn)位置
hConnect: 對應(yīng)服務(wù)器的句柄
szNodeName: 移動到節(jié)點(diǎn)位置的名稱
NULL：回到根節(jié)點(diǎn)
NUL String：返回上一級節(jié)點(diǎn)
非空字符串：進(jìn)入下一級指定的節(jié)點(diǎn)
15. HRESULT NumberOfNodeItems(HANDLE hConnect, OPCBROWSETYPE enFilter, int *num)
獲取地址空間當(dāng)前層節(jié)點(diǎn)的數(shù)目
hConnect: 對應(yīng)服務(wù)器的句柄
enFilter: 節(jié)點(diǎn)過濾
num: 存儲節(jié)點(diǎn)的數(shù)目
16. HRESULT GetNodeItemName(HANDLE hConnect, int nIndex, WCHAR *pBuf, int nBufSize)
獲取節(jié)點(diǎn)名稱
hConnect: 對應(yīng)服務(wù)器的句柄
nIndex: 節(jié)點(diǎn)的位置，范圍在0~(num-1)之間
pBuf: 存儲節(jié)點(diǎn)的名稱
nBufSize: 緩沖區(qū)的大小
16. HRESULT QualifyItemName(HANDLE hConnect, LPCWSTR szItemName, WCHAR *pItemID, int nBufSize)
獲取節(jié)點(diǎn)完整的名稱，如Device.Group.Node1
hConnect: 對應(yīng)服務(wù)器的名稱
szItemName: 由GetNodeItemName返回的節(jié)點(diǎn)名稱
pItemID: 存儲節(jié)點(diǎn)的ID
nBufSize: 緩沖區(qū)的大小
====================================================17. HRESULT AddOPCGroup(HANDLE hConnect, LPCWSTR szName, BOOL bActive, DWORD *pUpdateRate, LONG *pTimeBias, float *pDeadband, HANDLE *phGroup)
添加組到服務(wù)器
hConnect: 對應(yīng)服務(wù)器的句柄
szName: 組的名稱
bActive: 活動狀態(tài)
pUpdateRate: 更新速率，同時也返回Server修正過后的更新速率
pTimeBias: 時間偏置
pDeadband: 更新變化范圍
phGroup: 返回組對應(yīng)的句柄
18. HRESULT EnableDataCallback(HANDLE hConnect, HANDLE hGroup, DATACALLBACKPROC lpCallback)
設(shè)置DataCallback回調(diào)
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
lpCallback: 回調(diào)發(fā)生時執(zhí)行的函數(shù)
19. HRESULT RemoveOPCGroup(HANDLE hConnect, HANDLE hGroup)
刪除指定的組
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
20. HRESULT GetGroupState(HANDLE hConnect, HANDLE hGroup, WCHAR *pName, int nNameLen, DWORD *pUpdateRate, BOOL *pActive, LONG *pTimeBias, float *pPercentDeadband)
獲取組的屬性
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
pName: 組的名稱
nNameLen: 緩沖區(qū)的大小
pUpdateRate: 更新速率
pActive: 活動狀態(tài)
pTimeBias: 時間偏置
pPercentDeadband: 更新變化范圍
21. HRESULT SetGroupState(HANDLE hConnect, HANDLE hGroup, DWORD *pUpateRate, BOOL bActive, LONG *pTimeBias, float *pPercentDeadband)
設(shè)置組的屬性
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
pUpdateRate: 更新速率
bActive: 活動狀態(tài)
pTimeBias: 時間偏置
pPercentDeadband: 更新變化范圍
22. HRESULT RefreshOPCGroup(HANDLE hConnect, HANDLE hGroup, OPCDATASOURCE dwSource = OPC_DS_CACHE)
刷新組內(nèi)數(shù)據(jù)項的值
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
dwSource: 數(shù)據(jù)刷新方式
23. HRESULT SetGroupName(HANDLE hConnect, HANDLE hGroup, LPCWSTR szName)
更改組的名稱
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
szName: 組的名稱
====================================================
24. HRESULT AddOPCItem(HANDLE hConnect, HANDLE hGroup, LPCWSTR szName, LPCWSTR szAccessPath, VARTYPE *pCanonicalType, HANDLE hClient, HANDLE *phItem)
添加數(shù)據(jù)項到服務(wù)器
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
szName: 要添加數(shù)據(jù)項的ID
szAccessPath: 訪問路徑
pCanonicalType: 訂閱的數(shù)據(jù)類型，同時返回規(guī)范的數(shù)據(jù)類型
hClient: Client傳遞的句柄，DataCallback回調(diào)時會回傳此句柄
phItem: 返回數(shù)據(jù)項的句柄
25. HRESULT RemoveOPCItem(HANDLE hConnect, HANDLE hGroup, HANDLE hItem)
刪除指定的數(shù)據(jù)項
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
hItem: 對應(yīng)數(shù)據(jù)項的句柄
26. HRESULT ReadOPCItem(HANDLE hConnect, HANDLE hGroup, HANDLE hItem, VARIANT *pValue, FILETIME *pTimeStamp, DWORD *pQuality, OPCDATASOURCE dwSource = OPC_DS_CACHE, BOOL DoAsync = FALSE)
讀取數(shù)據(jù)項的值
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
hItem: 對應(yīng)數(shù)據(jù)項的句柄
pValue: 返回值
pTimeStamp: 返回時間
pQuality: 返回品質(zhì)
dwSource: 讀取的源
DoAsync: 是否使用異步方式
27. HRESULT WriteOPCItem(HANDLE hConnect, HANDLE hGroup, HANDLE hItem, VARIANT *pVal, BOOL DoAsync = FALSE)
寫數(shù)據(jù)項的值
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
hItem: 對應(yīng)數(shù)據(jù)項的句柄
pVar: 要寫的值
DoAsync: 是否采用異步方式
28. HRESULT ChangeOPCItemState(HANDLE hConnect, HANDLE hGroup, HANDLE hItem, BOOL bActive)
改變數(shù)據(jù)項的活動狀態(tài)
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
hItem: 對應(yīng)數(shù)據(jù)項的句柄
bActive: 數(shù)據(jù)項的活動狀態(tài)
29. HRESULT GetOPCItemInfo(HANDLE hConnect, HANDLE hGroup, LPCWSTR szName, VARTYPE *pType, DWORD *pAccessRights)
獲取數(shù)據(jù)項的信息
hConnect: 對應(yīng)服務(wù)器的句柄
hGroup: 對應(yīng)組的句柄
szName: 要獲取信息的數(shù)據(jù)項的ID
pType: 返回數(shù)據(jù)項的規(guī)范類型
pAccessRights: 返回數(shù)據(jù)項的訪問權(quán)限
30.HRESULT GetErrorString(HANDLE hConnect, HRESULT ErrorCode, WCHAR *pBuf, int nBufSize)
返回錯誤碼對應(yīng)的錯誤信息
hConnect: 對應(yīng)的服務(wù)器句柄
ErrorCode: 錯誤代碼
pBuf: 存儲錯誤信息的緩沖區(qū)
nBufSize: 緩沖區(qū)的大小 |
|
|
|
