DevicesJson.dumpToString Method

Module: DevicesJson

Definition

Creates a JSON-formatted string from the internal representation of the data.

Python

dump_to_string(self) -> str

Returns

str

Outputs the generated JSON string, reflecting the current state of the internal data structure.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

String dumpToString()

Returns

String

Outputs the generated JSON string, reflecting the current state of the internal data structure.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public string DumpToString()

Returns

string

Outputs the generated JSON string, reflecting the current state of the internal data structure.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public String dumpToString() throws DevicesException

Returns

String

Outputs the generated JSON string, reflecting the current state of the internal data structure.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesJson_DumpToString (
    ID3_DEVICES_JSON hDevicesJson,
    char * result,
    int * resultSize)

Parameters

hDevicesJson ID3_DEVICES_JSON

in Handle to the DevicesJson object.

result char *

out Outputs the generated JSON string, reflecting the current state of the internal data structure.

resultSize int *

in Size of the ‘result’ buffer. Receives the minimum required buffer size to hold the ‘result’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘result’ (excluding terminating NULL character).

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.