Interface IPropertyListServiceApi

Namespace: iMobileDevice.PropertyListService

Assembly: iMobileDevice-net.dll

Syntax

public interface IPropertyListServiceApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.PropertyListService.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

property_list_service_client_free(IntPtr)

Frees a PropertyList service.

Declaration

PropertyListServiceError property_list_service_client_free(IntPtr client)

Parameters

Type	Name	Description
System.IntPtr	client	The property list service to free.

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when client is invalid, or a PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when another error occured.

| Improve this Doc View Source

property_list_service_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out PropertyListServiceClientHandle)

Creates a new property list service for the specified port.

Declaration

PropertyListServiceError property_list_service_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out PropertyListServiceClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
PropertyListServiceClientHandle	client	Pointer that will be set to a newly allocated property_list_service_client_t upon successful return.

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when one of the arguments is invalid, or PROPERTY_LIST_SERVICE_E_MUX_ERROR when connecting to the device failed.

| Improve this Doc View Source

property_list_service_disable_ssl(PropertyListServiceClientHandle)

Disable SSL for the given property list service client.

Declaration

PropertyListServiceError property_list_service_disable_ssl(PropertyListServiceClientHandle client)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The connected property list service client for which SSL should be disabled.

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG if client or client->connection is NULL, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR otherwise.

| Improve this Doc View Source

property_list_service_enable_ssl(PropertyListServiceClientHandle)

Enable SSL for the given property list service client.

Declaration

PropertyListServiceError property_list_service_enable_ssl(PropertyListServiceClientHandle client)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The connected property list service client for which SSL should be enabled.

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG if client or client->connection is NULL, PROPERTY_LIST_SERVICE_E_SSL_ERROR when SSL could not be enabled, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR otherwise.

| Improve this Doc View Source

property_list_service_receive_plist(PropertyListServiceClientHandle, out PlistHandle)

Receives a plist using the given property list service client. Binary or XML plists are automatically handled. This function is like property_list_service_receive_plist_with_timeout using a timeout of 10 seconds.

Declaration

PropertyListServiceError property_list_service_receive_plist(PropertyListServiceClientHandle client, out PlistHandle plist)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The property list service client to use for receiving
PlistHandle	plist	pointer to a plist_t that will point to the received plist upon successful return

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or *plist is NULL, PROPERTY_LIST_SERVICE_E_PLIST_ERROR when the received data cannot be converted to a plist, PROPERTY_LIST_SERVICE_E_MUX_ERROR when a communication error occurs, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

property_list_service_receive_plist_with_timeout(PropertyListServiceClientHandle, out PlistHandle, UInt32)

Receives a plist using the given property list service client with specified timeout. Binary or XML plists are automatically handled.

Declaration

PropertyListServiceError property_list_service_receive_plist_with_timeout(PropertyListServiceClientHandle client, out PlistHandle plist, uint timeout)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The property list service client to use for receiving
PlistHandle	plist	pointer to a plist_t that will point to the received plist upon successful return
System.UInt32	timeout	Maximum time in milliseconds to wait for data.

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when connection or *plist is NULL, PROPERTY_LIST_SERVICE_E_PLIST_ERROR when the received data cannot be converted to a plist, PROPERTY_LIST_SERVICE_E_MUX_ERROR when a communication error occurs, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

property_list_service_send_binary_plist(PropertyListServiceClientHandle, PlistHandle)

Sends a binary plist.

Declaration

PropertyListServiceError property_list_service_send_binary_plist(PropertyListServiceClientHandle client, PlistHandle plist)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The property list service client to use for sending.
PlistHandle	plist	plist to send

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or plist is NULL, PROPERTY_LIST_SERVICE_E_PLIST_ERROR when dict is not a valid plist, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

property_list_service_send_xml_plist(PropertyListServiceClientHandle, PlistHandle)

Sends an XML plist.

Declaration

PropertyListServiceError property_list_service_send_xml_plist(PropertyListServiceClientHandle client, PlistHandle plist)

Parameters

Type	Name	Description
PropertyListServiceClientHandle	client	The property list service client to use for sending.
PlistHandle	plist	plist to send

Returns

Type	Description
PropertyListServiceError	PROPERTY_LIST_SERVICE_E_SUCCESS on success, PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or plist is NULL, PROPERTY_LIST_SERVICE_E_PLIST_ERROR when dict is not a valid plist, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.