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