UniPRT SDK v1.0.0.0
 
載入中...
搜尋中...
無符合項目
SettingsReadWrite 類別 參考文件

支持讀取和寫入打印機設置。 更多...

#include <SettingsReadWrite.h>

類別SettingsReadWrite的繼承圖:

實體方法

(instancetype) - initWithTcpComm:
 必須傳遞一個已打開的 TcpComm 連接,如果監聽來自打印機的非請求消息,該連接可以保持打開狀態。
 
(instancetype) - initWithJsonComm:
 使用給定的 JSON 通信對象初始化一個新實例。
 
(instancetype) - initWithCommDescriptor:
 創建由 SDK 管理的連接時調用的構造函數。
 
(NSDictionary< NSString *, NSString * > *) - getAllValues
 讀取所有設置的鍵/值對。
 
(NSString *) - getValueForKey:
 讀取與給定鍵關聯的設置。
 
(NSDictionary< NSString *, NSString * > *) - getValuesForKeys:
 讀取與給定鍵列表關聯的多個設置。
 
(BOOL) - setValue:forKey:
 寫入與給定鍵關聯的設置值。如果寫入成功,則返回 true。
 
(BOOL) - setValues:
 寫入與給定鍵關聯的多個設置。如果寫入成功,則返回 true。
 
(Setting *) - getPropertiesForKey:
 讀取與給定鍵列表關聯的多個設置。
 
(NSDictionary< NSString *, Setting * > *) - getPropertiesForKeys:
 讀取與給定鍵列表關聯的設置。
 
(NSDictionary< NSString *, Setting * > *) - getAllProperties
 讀取所有設置。
 

詳細描述

支持讀取和寫入打印機設置。

有關有效鍵和值的列表,請參閱:Settings Key/Value Items。

方法文件

◆ getAllProperties

- (NSDictionary< NSString *, Setting * > *) getAllProperties

讀取所有設置。

SettingsReadWrite 中實現。

傳回值
包含所有鍵及其相應屬性的字典。

◆ getAllValues

- (NSDictionary< NSString *, NSString * > *) getAllValues

讀取所有設置的鍵/值對。

SettingsReadWrite 中實現。

傳回值
包含所有設置鍵及其相應值的字典。

◆ getPropertiesForKey:

- (Setting *) getPropertiesForKey: (NSString *) key

讀取與給定鍵列表關聯的多個設置。

SettingsReadWrite 中實現。

參數
key要獲取屬性的鍵。
傳回值
包含指定鍵屬性的 Setting 對象。

◆ getPropertiesForKeys:

- (NSDictionary< NSString *, Setting * > *) getPropertiesForKeys: (NSArray< NSString * > *) keys

讀取與給定鍵列表關聯的設置。

SettingsReadWrite 中實現。

參數
keys要獲取屬性的鍵數組。
傳回值
包含指定鍵及其相應屬性的字典。

◆ getValueForKey:

- (NSString *) getValueForKey: (NSString *) key

讀取與給定鍵關聯的設置。

SettingsReadWrite 中實現。

參數
key要獲取值的鍵。
傳回值
與指定鍵關聯的值。

◆ getValuesForKeys:

- (NSDictionary< NSString *, NSString * > *) getValuesForKeys: (NSArray< NSString * > *) keys

讀取與給定鍵列表關聯的多個設置。

SettingsReadWrite 中實現。

參數
keys要獲取值的鍵數組。
傳回值
包含指定鍵及其相應值的字典。

◆ initWithCommDescriptor:

- (instancetype) initWithCommDescriptor: (NSString *) commDescriptor

創建由 SDK 管理的連接時調用的構造函數。

commDescriptor 是用於連接打印機的通信描述符。

TCP 描述符格式:"ip" 或 "ip:port"

例如 "127.0.0.1" 或 "127.0.0.1:3007"

如果未提供端口,則使用默認值。

參數
commDescriptor通信描述符。
傳回值
一個初始化的 SettingsReadWrite 實例,如果無法創建對象,則返回 nil。

◆ initWithJsonComm:

- (instancetype) initWithJsonComm: (JsonComm *) mgmtComm

使用給定的 JSON 通信對象初始化一個新實例。

參數
mgmtCommJSON 通信對象。
傳回值
一個初始化的 SettingsReadWrite 實例,如果無法創建對象,則返回 nil。

◆ initWithTcpComm:

- (instancetype) initWithTcpComm: (TcpComm *) connection

必須傳遞一個已打開的 TcpComm 連接,如果監聽來自打印機的非請求消息,該連接可以保持打開狀態。

發送/接收打印機狀態消息需要連接。

參數
connectionTCP 通信對象。
傳回值
一個初始化的 SettingsReadWrite 實例,如果無法創建對象,則返回 nil。

◆ setValue:forKey:

- (BOOL) setValue: (NSString *) value
forKey: (NSString *) key 

寫入與給定鍵關聯的設置值。如果寫入成功,則返回 true。

注意:要作為字符串處理的值應加引號。例如,value = SomeString 和 value = "SomeString" 將按接收到的內容發送,但打印機可能會以不同方式處理。

SettingsReadWrite 中實現。

參數
value要設置的值。
key要設置值的鍵。
傳回值
如果值已成功設置,則返回 YES,否則返回 NO。

◆ setValues:

- (BOOL) setValues: (NSDictionary< NSString *, NSString * > *) keysToSet

寫入與給定鍵關聯的多個設置。如果寫入成功,則返回 true。

注意:要作為字符串處理的值應加引號。例如,value = SomeString 和 value = "SomeString" 將按接收到的內容發送,但打印機可能會以不同方式處理。

SettingsReadWrite 中實現。

參數
keysToSet包含要设置的键和值的字典。
傳回值
如果值已成功设置,则返回 YES,否则返回 NO。
參數
keysToSet包含要設置的鍵和值的字典。
傳回值
如果值已成功設置,則返回 YES,否則返回 NO。

此類別(class) 文件是由下列檔案中產生: