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。

该类的文档由以下文件生成: