Egalware/mht-siemens
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'develop'

Browse Source
This commit is contained in:
Samuele E. Locatelli
2020-05-11 17:20:14 +02:00
parent 3c4ad2d916 9966d80fe3
commit d8d11805f9
70 changed files with 50154 additions and 22513 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+329
View File
@@ -0,0 +1,329 @@
# ---> VisualStudio
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
build/
bld/
[Bb]in/
[Oo]bj/
# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUNIT
*.VisualState.xml
TestResult.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# DNX
project.lock.json
artifacts/
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# Windows Azure Build Output
csx/
*.build.csdef
# Windows Store app package directory
AppPackages/
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/
# Others
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.pfx
*.publishsettings
node_modules/
orleans.codegen.cs
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
# SQL Server files
*.mdf
*.ldf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
# Microsoft Fakes
FakesAssemblies/
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# ---> C Sharp
# Build Folders (you can keep bin if you'd like, to store dlls and pdbs)
[Bb]in/
[Oo]bj/
# mstest test results
TestResults
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
# User-specific files
*.suo
*.user
*.sln.docstates
# Build results
[Dd]ebug/
[Rr]elease/
x64/
*_i.c
*_p.c
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.log
*.vspscc
*.vssscc
.builds
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
# Visual Studio profiler
*.psess
*.vsp
*.vspx
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*
# NCrunch
*.ncrunch*
.*crunch*.local.xml
# Installshield output folder
[Ee]xpress
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish
# Publish Web Output
*.Publish.xml
# NuGet Packages Directory
packages
# Windows Azure Build Output
csx
*.build.csdef
# Windows Store app package directory
AppPackages/
# Others
[Bb]in
[Oo]bj
sql
TestResults
[Tt]est[Rr]esult*
*.Cache
ClientBin
[Ss]tyle[Cc]op.*
~$*
*.dbmdl
Generated_Code #added for RIA/Silverlight projects
# Backup & report files from converting an old project file to a newer
# Visual Studio version. Backup files are not needed, because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
MTH-Siemens/App.config
+17 -12
View File
@@ -1,13 +1,18 @@
<?xml version="1.0" encoding="utf-8" ?>
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2" />
</startup>
<appSettings>
<add key="appName" value="MHT-Proxy"/>
<add key="verbose" value="false"/>
<!--conf file-->
<add key="memConfPath" value="setupData.json"/>
<add key="sampleTimerMs" value="1000"/>
</appSettings>
</configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
</startup>
<appSettings>
<add key="appName" value="MHT-Proxy"/>
<add key="verbose" value="false"/>
<!--conf file-->
<add key="memConfPath" value="setupData.json"/>
<add key="sampleTimerMs" value="1000"/>
</appSettings>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<probing privatePath="lib;libs"/>
</assemblyBinding>
</runtime>
</configuration>
MTH-Siemens/MHT-Siemens.csproj
+13 -6
View File
@@ -8,10 +8,11 @@
<OutputType>WinExe</OutputType>
<RootNamespace>MHT_Siemens</RootNamespace>
<AssemblyName>MHT-Siemens</AssemblyName>
<TargetFrameworkVersion>v4.6.2</TargetFrameworkVersion>
<TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
<FileAlignment>512</FileAlignment>
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
<Deterministic>true</Deterministic>
<TargetFrameworkProfile />
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<PlatformTarget>AnyCPU</PlatformTarget>
@@ -36,14 +37,14 @@
<ApplicationIcon>SteamWare.ico</ApplicationIcon>
</PropertyGroup>
<ItemGroup>
<Reference Include="Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
<HintPath>..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
<Reference Include="Newtonsoft.Json, Version=11.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
<HintPath>..\packages\Newtonsoft.Json.11.0.1\lib\net40\Newtonsoft.Json.dll</HintPath>
</Reference>
<Reference Include="NLog, Version=4.0.0.0, Culture=neutral, PublicKeyToken=5120e14c03d0593c, processorArchitecture=MSIL">
<HintPath>..\packages\NLog.4.7.0\lib\net45\NLog.dll</HintPath>
<HintPath>..\packages\NLog.4.6.0\lib\net40-client\NLog.dll</HintPath>
</Reference>
<Reference Include="S7.Net, Version=0.4.0.0, Culture=neutral, PublicKeyToken=d5812d469e84c693, processorArchitecture=MSIL">
<HintPath>..\packages\S7netplus.0.4.0\lib\net452\S7.Net.dll</HintPath>
<Reference Include="S7.Net, Version=1.0.0.0, Culture=neutral, PublicKeyToken=d5812d469e84c693, processorArchitecture=MSIL">
<HintPath>..\packages\S7netplus.0.1.9\lib\net40\S7.Net.dll</HintPath>
</Reference>
<Reference Include="System" />
<Reference Include="System.Configuration" />
@@ -119,4 +120,10 @@
</ItemGroup>
<ItemGroup />
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Target Name="AfterBuild">
<ItemGroup>
<MoveToLibFolder Include="$(OutputPath)*.dll ; $(OutputPath)*.pdb ; $(OutputPath)*.xml" />
</ItemGroup>
<Move SourceFiles="@(MoveToLibFolder)" DestinationFolder="$(OutputPath)lib" OverwriteReadOnlyFiles="true" />
</Target>
</Project>
MTH-Siemens/NLog.xsd
+170 -316
View File
@@ -37,12 +37,12 @@
</xs:attribute>
<xs:attribute name="globalThreshold" type="NLogLevel">
<xs:annotation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged.</xs:documentation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged..</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwExceptions" type="xs:boolean">
<xs:annotation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false. Not recommend to set to true in production!</xs:documentation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwConfigExceptions" type="xs:boolean">
@@ -72,7 +72,7 @@
</xs:attribute>
<xs:attribute name="parseMessageTemplates" type="xs:boolean">
<xs:annotation>
<xs:documentation>Perform message template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
<xs:documentation>Perform mesage template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -123,7 +123,7 @@
</xs:choice>
<xs:attribute name="name" use="optional">
<xs:annotation>
<xs:documentation>Name of the logger. May include wildcard characters ('*' or '?').</xs:documentation>
<xs:documentation>Name of the logger. May include '*' character which acts like a wildcard. Allowed forms are: *, Name, *Name, Name* and *Name*</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="levels" type="NLogLevelList">
@@ -156,9 +156,9 @@
<xs:documentation>Ignore further rules if this one matches.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ruleName" type="xs:string" use="optional">
<xs:attribute name="enabled" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName.</xs:documentation>
<xs:documentation>Enable or disable logging rule. Disabled rules are ignored.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -171,11 +171,6 @@
<xs:element name="whenNotEqual" type="whenNotEqual" />
<xs:element name="whenRepeated" type="whenRepeated" />
</xs:choice>
<xs:attribute name="defaultAction" type="FilterResult">
<xs:annotation>
<xs:documentation>Default action if none of the filters match.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:simpleType name="NLogLevel">
<xs:restriction base="xs:string">
@@ -215,19 +210,12 @@
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLogVariable">
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="value" minOccurs="0" maxOccurs="1" type="xs:string">
<xs:annotation>
<xs:documentation>Variable value. Note, the 'value' attribute has precedence over this one.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Variable name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="SimpleLayoutAttribute">
<xs:attribute name="value" type="SimpleLayoutAttribute" use="required">
<xs:annotation>
<xs:documentation>Variable value.</xs:documentation>
</xs:annotation>
@@ -351,7 +339,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="asyncFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="flushOnConditionOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -365,11 +352,6 @@
<xs:documentation>Condition expression. Log events who meet this condition will cause a flush on the wrapped target.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="flushOnConditionOnly" type="xs:boolean">
<xs:annotation>
<xs:documentation>Only flush when LogEvent matches condition. Ignore explicit-flush, config-reload-flush and shutdown-flush</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the target.</xs:documentation>
@@ -443,15 +425,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -497,11 +479,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -512,14 +489,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -537,9 +509,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -610,18 +592,6 @@
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Tls13" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="NLog.Targets.NetworkTargetConnectionsOverflowAction">
<xs:restriction base="xs:string">
<xs:enumeration value="AllowNewConnnection" />
@@ -636,15 +606,25 @@
<xs:enumeration value="Discard" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.NLogViewerParameterInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
@@ -652,11 +632,6 @@
<xs:documentation>Viewer parameter name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether an attribute with empty value should be included in the output</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ColoredConsole">
<xs:complexContent>
@@ -670,8 +645,6 @@
<xs:element name="enableAnsiOutput" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="errorStream" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectOutputRedirected" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="useDefaultRowHighlightingRules" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="highlight-row" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleRowHighlightingRule" />
<xs:element name="highlight-word" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleWordHighlightingRule" />
@@ -717,16 +690,6 @@
<xs:documentation>Indicates whether the error stream (stderr) should be used instead of the output stream (stdout).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectOutputRedirected" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console has been redirected to file - Disables coloring logic when System.Console.IsOutputRedirected = true</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="useDefaultRowHighlightingRules" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to use default row highlighting rules.</xs:documentation>
@@ -837,11 +800,9 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="header" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectConsoleAvailable" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="error" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBuffer" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -864,11 +825,6 @@
<xs:documentation>Footer.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectConsoleAvailable" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console is available - Disables console writing if Environment.UserInteractive = False (Windows Service) - Disables console writing if Console Standard Input is not available (Non-Console-App)</xs:documentation>
@@ -884,11 +840,6 @@
<xs:documentation>Indicates whether to send the log messages to the standard error instead of the standard output.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBuffer" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether to enable batch writing using char[]-buffers, instead of using </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -903,24 +854,21 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="useTransactions" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbProvider" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="dbPassword" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionStringName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="connectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="commandproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="installConnectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="install-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="uninstall-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="isolationLevel" minOccurs="0" maxOccurs="1" type="System.Data.IsolationLevel" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
<xs:element name="commandText" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
@@ -932,9 +880,9 @@
<xs:documentation>Obsolete - value will be ignored! The logging code always runs outside of transaction. Gets or sets a value indicating whether to use database transactions. Some data providers require this.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbProvider" type="xs:string">
@@ -947,14 +895,14 @@
<xs:documentation>Database password. If the ConnectionString is not provided this value will be used to construct the "Password=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="connectionStringName" type="xs:string">
@@ -967,9 +915,9 @@
<xs:documentation>Connection string. When provided, it overrides the values specified in DBHost, DBUserName, DBPassword, DBDatabase.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="installConnectionString" type="SimpleLayoutAttribute">
@@ -977,11 +925,6 @@
<xs:documentation>Connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="isolationLevel" type="System.Data.IsolationLevel">
<xs:annotation>
<xs:documentation>Configures isolated transaction batch writing. If supported by the database, then it will improve insert performance.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1007,51 +950,6 @@
<xs:enumeration value="TableDirect" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Data.IsolationLevel">
<xs:restriction base="xs:string">
<xs:enumeration value="Unspecified" />
<xs:enumeration value="Chaos" />
<xs:enumeration value="ReadUncommitted" />
<xs:enumeration value="ReadCommitted" />
<xs:enumeration value="RepeatableRead" />
<xs:enumeration value="Serializable" />
<xs:enumeration value="Snapshot" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.DatabaseObjectPropertyInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="format" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="culture" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertyType" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the property value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
<xs:annotation>
<xs:documentation>Culture used for parsing property string-value for type-conversion</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Value to assign on the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name for the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="propertyType" type="xs:string">
<xs:annotation>
<xs:documentation>Type of the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLog.Targets.DatabaseCommandInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
@@ -1100,7 +998,7 @@
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbType" type="xs:string">
@@ -1130,7 +1028,7 @@
</xs:attribute>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the database parameter value.</xs:documentation>
<xs:documentation>Convert format of the database parameter value .</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
@@ -1237,7 +1135,7 @@
</xs:attribute>
<xs:attribute name="entryType" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Optional entry type. When not set, or when not convertible to then determined by </xs:documentation>
<xs:documentation>Optional entrytype. When not set, or when not convertible to then determined by </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="eventId" type="SimpleLayoutAttribute">
@@ -1326,7 +1224,6 @@
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxArchiveDays" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="enableArchiveFileCompression" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveNumbering" minOccurs="0" maxOccurs="1" type="NLog.Targets.ArchiveNumberingMode" />
<xs:element name="archiveFileName" minOccurs="0" maxOccurs="1" type="Layout" />
@@ -1336,20 +1233,19 @@
<xs:element name="maxArchiveFiles" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="writeFooterOnArchivingOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxLogFilenames" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="deleteOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileAttributes" minOccurs="0" maxOccurs="1" type="NLog.Targets.Win32FileAttributes" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveOldFileOnStartupAboveSize" minOccurs="0" maxOccurs="1" type="xs:long" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="networkWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="openFileCacheTimeout" minOccurs="0" maxOccurs="1" type="xs:integer" />
@@ -1393,11 +1289,6 @@
<xs:documentation>Line ending mode.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxArchiveDays" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum days of archive files that should be kept.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableArchiveFileCompression" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to compress archive files into the zip archive format.</xs:documentation>
@@ -1440,7 +1331,62 @@
</xs:attribute>
<xs:attribute name="maxLogFilenames" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum number of log file names that should be stored as existing.</xs:documentation>
<xs:documentation>Maximum number of log filenames that should be stored as existing.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Value indicationg whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="deleteOldFileOnStartup" type="xs:boolean">
@@ -1453,66 +1399,6 @@
<xs:documentation>File attributes (Windows only).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartupAboveSize" type="xs:long">
<xs:annotation>
<xs:documentation>Value of the file size threshold to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1634,7 +1520,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="filter" minOccurs="0" maxOccurs="1" type="Filter" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2112,13 +1997,13 @@
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2161,11 +2046,6 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
@@ -2196,6 +2076,11 @@
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -2214,15 +2099,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2268,11 +2153,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -2283,14 +2163,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -2308,9 +2183,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -2700,7 +2585,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="enableTraceFail" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="rawWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -2714,11 +2598,6 @@
<xs:documentation>Layout used to format log messages.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableTraceFail" type="xs:boolean">
<xs:annotation>
<xs:documentation>Forward to (Instead of )</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rawWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Always use independent of </xs:documentation>
@@ -2963,9 +2842,6 @@
<xs:complexContent>
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.JsonAttribute" />
<xs:element name="excludeProperties" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2973,22 +2849,9 @@
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxRecursionLimit" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
<xs:documentation>List of property names to exclude when is true</xs:documentation>
@@ -3019,6 +2882,16 @@
<xs:documentation>How far should the JSON serializer follow object references before backing off</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3027,7 +2900,6 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeUnicode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -3043,12 +2915,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeUnicode" type="xs:boolean">
@@ -3093,24 +2960,16 @@
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeCallSite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
</xs:choice>
<xs:attribute name="includeAllProperties" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to include all properties from the log events</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeCallSite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include call site (class and method name) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeMdc" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include contents of the dictionary.</xs:documentation>
@@ -3131,11 +2990,6 @@
<xs:documentation>Indicates whether to include contents of the stack.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeSourceInfo" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include source info (file name and line number) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3167,12 +3021,12 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="elementValue" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
@@ -3219,6 +3073,11 @@
<xs:documentation>XML attribute name to use when rendering property-value When null (or empty) then value-attribute is not included and value is formatted as XML-element-value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementName" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the root XML element</xs:documentation>
@@ -3239,11 +3098,6 @@
<xs:documentation>Auto indent and create new lines</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3266,7 +3120,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
@@ -3277,10 +3131,10 @@
</xs:complexType>
<xs:complexType name="NLog.Layouts.XmlElement">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="value" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -3294,11 +3148,6 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the element</xs:documentation>
@@ -3309,6 +3158,11 @@
<xs:documentation>Value inside the element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether a ElementValue with empty value should be included in the output</xs:documentation>
MTH-Siemens/SiemensProxy.Designer.cs
Generated
+21 -3
View File
@@ -42,6 +42,7 @@
this.tsslApp = new System.Windows.Forms.ToolStripStatusLabel();
this.toolStripProgressBar1 = new System.Windows.Forms.ToolStripProgressBar();
this.txtCpuType = new System.Windows.Forms.TextBox();
this.txtLog = new System.Windows.Forms.TextBox();
this.statusStrip1.SuspendLayout();
this.SuspendLayout();
//
@@ -143,9 +144,9 @@
this.statusStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] {
this.tsslApp,
this.toolStripProgressBar1});
this.statusStrip1.Location = new System.Drawing.Point(0, 118);
this.statusStrip1.Location = new System.Drawing.Point(0, 236);
this.statusStrip1.Name = "statusStrip1";
this.statusStrip1.Size = new System.Drawing.Size(554, 22);
this.statusStrip1.Size = new System.Drawing.Size(555, 22);
this.statusStrip1.TabIndex = 12;
this.statusStrip1.Text = "statusStrip1";
//
@@ -171,11 +172,27 @@
this.txtCpuType.Text = "S71200";
this.txtCpuType.TextAlign = System.Windows.Forms.HorizontalAlignment.Right;
//
// txtLog
//
this.txtLog.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom)
| System.Windows.Forms.AnchorStyles.Left)
| System.Windows.Forms.AnchorStyles.Right)));
this.txtLog.BackColor = System.Drawing.Color.Black;
this.txtLog.Enabled = false;
this.txtLog.ForeColor = System.Drawing.SystemColors.MenuHighlight;
this.txtLog.Location = new System.Drawing.Point(13, 82);
this.txtLog.Multiline = true;
this.txtLog.Name = "txtLog";
this.txtLog.Size = new System.Drawing.Size(530, 151);
this.txtLog.TabIndex = 14;
this.txtLog.Text = "...";
//
// SiemensProxy
//
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(554, 140);
this.ClientSize = new System.Drawing.Size(555, 258);
this.Controls.Add(this.txtLog);
this.Controls.Add(this.txtCpuType);
this.Controls.Add(this.statusStrip1);
this.Controls.Add(this.txtSlot);
@@ -212,6 +229,7 @@
private System.Windows.Forms.ToolStripStatusLabel tsslApp;
private System.Windows.Forms.ToolStripProgressBar toolStripProgressBar1;
private System.Windows.Forms.TextBox txtCpuType;
private System.Windows.Forms.TextBox txtLog;
}
}
MTH-Siemens/SiemensProxy.cs
+64 -21
View File
@@ -109,28 +109,28 @@ namespace MHT_Siemens
/// </summary>
private void loadPlc()
{
lg.Info("Refreshing connection...");
lgInfo("Refreshing connection...");
parametri = currDataProxy.confPLC;
// ora tento avvio PLC... SE PING OK...
if (testPing() == IPStatus.Success)
{
try
{
lg.Info($"PLC parameters: CPU {parametri.tipoCpu} | IP: {parametri.ipAdrr} | R/S: {parametri.rack}/{parametri.slot}");
lgInfo($"PLC parameters: CPU {parametri.tipoCpu} | IP: {parametri.ipAdrr} | R/S: {parametri.rack}/{parametri.slot}");
currPLC = new Plc(parametri.tipoCpu, parametri.ipAdrr, parametri.rack, parametri.slot);
currPLC.Open();
if (currPLC.IsConnected)
{
lg.Info("PLC Connected!");
lgInfo("PLC Connected!");
}
else
{
lg.Info("Connection error!");
lgInfo("Connection error!");
}
}
catch (Exception exc)
{
lg.Error(exc, "Errore in INIT PLC");
lgError(exc, "Errore in INIT PLC");
}
}
}
@@ -139,10 +139,10 @@ namespace MHT_Siemens
/// </summary>
protected void loadMemConf()
{
lg.Info("Starting loadMemConf");
lgInfo("Starting loadMemConf");
if (File.Exists(setupFile))
{
lg.Info($"File found: {setupFile}");
lgInfo($"File found: {setupFile}");
try
{
StreamReader reader = new StreamReader(setupFile);
@@ -150,7 +150,7 @@ namespace MHT_Siemens
if (!string.IsNullOrEmpty(jsonData))
{
currDataProxy = JsonConvert.DeserializeObject<dataProxy>(jsonData);
lg.Info("Completed data deserialization");
lgInfo("Completed data deserialization");
}
reader.Close();
}
@@ -162,7 +162,7 @@ namespace MHT_Siemens
// se non esistesse creo un nuovo file default
if (currDataProxy == null)
{
lg.Info($"File NOT found: {setupFile} - creating new");
lgInfo($"File NOT found: {setupFile} - creating new");
dataConf newParam = new dataConf()
{
Column = "Valore assoluto",
@@ -192,7 +192,7 @@ namespace MHT_Siemens
//write string to file
File.WriteAllText(setupFile, json);
lg.Info($"Setup File saved: {setupFile}");
lgInfo($"Setup File saved: {setupFile}");
}
// adesso valorizzo tutti i parametri
@@ -220,15 +220,15 @@ namespace MHT_Siemens
private void CheckTimer_Tick(object sender, EventArgs e)
{
// loggo!
lg.Info("Program Alive control...");
lgInfo("Program Alive control...");
//verifico PLC
if (currPLC.IsConnected)
{
lg.Info("PLC Connected!");
lgInfo("PLC Connected!");
}
else
{
lg.Info("Connection error!");
lgInfo("Connection error!");
}
}
@@ -241,7 +241,7 @@ namespace MHT_Siemens
if (dataChanged())
{
// loggo!
lg.Info("New Value found");
lgInfo("Data Change on File");
// invio a PLC
saveToPLC();
@@ -273,10 +273,10 @@ namespace MHT_Siemens
byte[] DB_Byte = new byte[4];
S7.Net.Types.Double.ToByteArray(valore).CopyTo(DB_Byte, 0);
currPLC.WriteBytes(DataType.DataBlock, memoria.DbNum, memoria.indiceMem, DB_Byte);
// loggo invio al PLC!
lgInfo($"Value sent to PLC: {item.Key} | {valore}");
}
}
// loggo invio al PLC!
lg.Info("New Value sent to PLC");
}
/// <summary>
/// Effettua comparazioen dati vecchi/nuovi
@@ -344,7 +344,7 @@ namespace MHT_Siemens
if ((currentLine = sr.ReadLine()) == null)
{
// vuoto: loggo ed esco!
lg.Error("Errore intestazione vuota!");
lgError("Errore intestazione vuota!");
return;
}
}
@@ -372,14 +372,14 @@ namespace MHT_Siemens
else
{
// vuoto: loggo ed esco!
lg.Error("Errore riga vuota!");
lgError("Errore riga vuota!");
return;
}
}
}
else
{
lg.Error($"Errore! file non trovato: {currDataProxy.csvFilePath}");
lgError($"Errore! file non trovato: {currDataProxy.csvFilePath}");
}
}
@@ -425,14 +425,14 @@ namespace MHT_Siemens
// se passa il ping faccio il resto...
if (pingStatus != IPStatus.Success)
{
lg.Error("Errore ping");
lgError("Errore ping");
}
else
{
if (!currPLC.IsConnected) currPLC.Open();
if (!currPLC.IsConnected)
{
lg.Error( "Errore connessione");
lgError("Errore connessione");
}
else
{
@@ -441,6 +441,49 @@ namespace MHT_Siemens
}
return answ;
}
private void appenRTLog(string contenuto)
{
// se troppe righe trimmo...
string fullLog = limitLine2show($"{contenuto}{Environment.NewLine}{txtLog.Text}");
// update
txtLog.Text = fullLog;
}
/// <summary>
/// Effettua un trim della stringa al numero max di linee da mostrare a video
/// </summary>
/// <param name="newString"></param>
/// <returns></returns>
public string limitLine2show(string newString)
{
if (!string.IsNullOrEmpty(newString))
{
// se num righe superiore a limite trimmo...
if (newString.Split('\n').Length > 50)
{
//int idx = newString.LastIndexOf('\r');
int idx = newString.LastIndexOf(Environment.NewLine);
newString = newString.Substring(0, idx);
}
}
return newString;
}
protected void lgInfo(string contenuto)
{
lg.Info(contenuto);
appenRTLog(contenuto);
}
protected void lgError(string contenuto)
{
lg.Error(contenuto);
appenRTLog(contenuto);
}
protected void lgError(Exception exc, string contenuto)
{
lg.Error(exc, contenuto);
appenRTLog(contenuto);
}
#endregion
}
MTH-Siemens/bin/Release/MHT-Siemens.exe.config
+18
View File
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
</startup>
<appSettings>
<add key="appName" value="MHT-Proxy"/>
<add key="verbose" value="false"/>
<!--conf file-->
<add key="memConfPath" value="setupData.json"/>
<add key="sampleTimerMs" value="1000"/>
</appSettings>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<probing privatePath="lib;libs"/>
</assemblyBinding>
</runtime>
</configuration>
MTH-Siemens/bin/Release/NLog.config
+54
View File
@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
autoReload="true"
throwExceptions="false"
internalLogLevel="Off" internalLogFile="c:\temp\nlog-internal.log">
<!-- optional, add some variables
https://github.com/nlog/NLog/wiki/Configuration-file#variables
-->
<variable name="logDir" value="${basedir}/logs"/>
<!--
See https://github.com/nlog/nlog/wiki/Configuration-file
for information on customizing logging rules and outputs.
-->
<targets>
<target xsi:type="File"
name="f_base"
fileName="${logDir}/${shortdate}.log"
layout="${longdate} [${uppercase:${level}}] ${logger:shortName=true}|${message}"
archiveFileName="${logDir}/${shortdate}.{###}.log"
archiveNumbering="Sequence"
archiveAboveSize="10240000"
maxArchiveFiles="60"
enableArchiveFileCompression="false"
keepFileOpen="false"
/>
<target xsi:type="File"
name="f_error"
fileName="${logDir}/${shortdate}.log"
layout="${longdate} [${uppercase:${level}}] ${logger:shortName=true}|${message}${newline}${exception:format=tostring}"
archiveFileName="${logDir}/${shortdate}.{###}.log"
archiveNumbering="Sequence"
archiveAboveSize="10240000"
maxArchiveFiles="60"
enableArchiveFileCompression="false"
keepFileOpen="false"
/>
</targets>
<rules>
<!-- add your logging rules here -->
<!--
Write all events with minimal level of Debug (So Debug, Info, Warn, Error and Fatal, but not Trace) to "f"
<logger name="*" minlevel="Debug" writeTo="f" />
-->
<logger name="*" minlevel="Debug" maxlevel="Warn" final="true" writeTo="f_base" />
<logger name="*" minlevel="Error" writeTo="f_error" />
</rules>
</nlog>
packages/NLog.4.7.0/lib/net40-client/NLog.xml → MTH-Siemens/bin/Release/lib/NLog.xml
+554 -1630
View File
File diff suppressed because it is too large Load Diff
packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.xml → MTH-Siemens/bin/Release/lib/Newtonsoft.Json.xml
+246 -396
View File
File diff suppressed because it is too large Load Diff
MTH-Siemens/bin/Release/lib/S7.Net.xml
+991
View File
@@ -0,0 +1,991 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>S7.Net</name>
</assembly>
<members>
<member name="T:S7.Net.Conversion">
<summary>
Conversion methods to convert from Siemens numeric format to C# and back
</summary>
</member>
<member name="M:S7.Net.Conversion.BinStringToInt32(System.String)">
<summary>
Converts a binary string to Int32 value
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.BinStringToByte(System.String)">
<summary>
Converts a binary string to a byte. Can return null.
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ValToBinString(System.Object)">
<summary>
Converts the value to a binary string
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.SelectBit(System.Byte,System.Int32)">
<summary>
Helper to get a bit value given a byte and the bit index.
Example: DB1.DBX0.5 -> var bytes = ReadBytes(DB1.DBW0); bool bit = bytes[0].SelectBit(5);
</summary>
<param name="data"></param>
<param name="bitPosition"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToShort(System.UInt16)">
<summary>
Converts from ushort value to short value; it's used to retrieve negative values from words
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUshort(System.Int16)">
<summary>
Converts from short value to ushort value; it's used to pass negative values to DWs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToInt(System.UInt32)">
<summary>
Converts from UInt32 value to Int32 value; it's used to retrieve negative values from DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Int32)">
<summary>
Converts from Int32 value to UInt32 value; it's used to pass negative values to DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Double)">
<summary>
Converts from double to DWord (DBD)
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToDouble(System.UInt32)">
<summary>
Converts from DWord (DBD) to double
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="T:S7.Net.COTP">
<summary>
COTP Protocol functions and types
</summary>
</member>
<member name="T:S7.Net.COTP.TPDU">
<summary>
Describes a COTP TPDU (Transport protocol data unit)
</summary>
</member>
<member name="M:S7.Net.COTP.TPDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads COTP TPDU (Transport protocol data unit) from the network stream
See: https://tools.ietf.org/html/rfc905
</summary>
<param name="socket">The socket to read from</param>
<returns>COTP DPDU instance</returns>
</member>
<member name="T:S7.Net.COTP.TSDU">
<summary>
Describes a COTP TSDU (Transport service data unit). One TSDU consist of 1 ore more TPDUs
</summary>
</member>
<member name="M:S7.Net.COTP.TSDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads the full COTP TSDU (Transport service data unit)
See: https://tools.ietf.org/html/rfc905
</summary>
<returns>Data in TSDU</returns>
</member>
<member name="T:S7.Net.CpuType">
<summary>
Types of S7 cpu supported by the library
</summary>
</member>
<member name="F:S7.Net.CpuType.S7200">
<summary>
S7 200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7300">
<summary>
S7 300 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7400">
<summary>
S7 400 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71200">
<summary>
S7 1200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71500">
<summary>
S7 1500 cpu type
</summary>
</member>
<member name="T:S7.Net.ErrorCode">
<summary>
Types of error code that can be set after a function is called
</summary>
</member>
<member name="F:S7.Net.ErrorCode.NoError">
<summary>
The function has been executed correctly
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongCPU_Type">
<summary>
Wrong type of CPU error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ConnectionError">
<summary>
Connection error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.IPAddressNotAvailable">
<summary>
Ip address not available
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongVarFormat">
<summary>
Wrong format of the variable
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongNumberReceivedBytes">
<summary>
Wrong number of received bytes
</summary>
</member>
<member name="F:S7.Net.ErrorCode.SendData">
<summary>
Error on send data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ReadData">
<summary>
Error on read data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WriteData">
<summary>
Error on write data
</summary>
</member>
<member name="T:S7.Net.DataType">
<summary>
Types of memory area that can be read
</summary>
</member>
<member name="F:S7.Net.DataType.Input">
<summary>
Input area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Output">
<summary>
Output area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Memory">
<summary>
Merkers area memory (M0, M0.0, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.DataBlock">
<summary>
DB area memory (DB1, DB2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Timer">
<summary>
Timer area memory(T1, T2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Counter">
<summary>
Counter area memory (C1, C2, ...)
</summary>
</member>
<member name="T:S7.Net.VarType">
<summary>
Types
</summary>
</member>
<member name="F:S7.Net.VarType.Bit">
<summary>
S7 Bit variable type (bool)
</summary>
</member>
<member name="F:S7.Net.VarType.Byte">
<summary>
S7 Byte variable type (8 bits)
</summary>
</member>
<member name="F:S7.Net.VarType.Word">
<summary>
S7 Word variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DWord">
<summary>
S7 DWord variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Int">
<summary>
S7 Int variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DInt">
<summary>
DInt variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Real">
<summary>
Real variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.String">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.StringEx">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.Timer">
<summary>
Timer variable type
</summary>
</member>
<member name="F:S7.Net.VarType.Counter">
<summary>
Counter variable type
</summary>
</member>
<member name="T:S7.Net.Plc">
<summary>
Creates an instance of S7.Net driver
</summary>
</member>
<member name="P:S7.Net.Plc.IP">
<summary>
IP address of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.CPU">
<summary>
CPU type of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Rack">
<summary>
Rack of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Slot">
<summary>
Slot of the CPU of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.MaxPDUSize">
<summary>
Max PDU size this cpu supports
</summary>
</member>
<member name="P:S7.Net.Plc.IsAvailable">
<summary>
Returns true if a connection to the PLC can be established
</summary>
</member>
<member name="P:S7.Net.Plc.IsConnected">
<summary>
Checks if the socket is connected and polls the other peer (the PLC) to see if it's connected.
This is the variable that you should continously check to see if the communication is working
See also: http://stackoverflow.com/questions/2661764/how-to-check-if-a-socket-is-connected-disconnected-in-c
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorString">
<summary>
Contains the last error registered when executing a function
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorCode">
<summary>
Contains the last error code registered when executing a function
</summary>
</member>
<member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int16,System.Int16)">
<summary>
Creates a PLC object with all the parameters needed for connections.
For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
You need slot > 0 if you are connecting to external ethernet card (CP).
For S7-300 and S7-400 the default is rack = 0 and slot = 2.
</summary>
<param name="cpu">CpuType of the PLC (select from the enum)</param>
<param name="ip">Ip address of the PLC</param>
<param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
<param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
If you use an external ethernet card, this must be set accordingly.</param>
</member>
<member name="M:S7.Net.Plc.Open">
<summary>
Open a <see cref="T:System.Net.Sockets.Socket"/> and connects to the PLC, sending all the corrected package
and returning if the connection was successful (<see cref="F:S7.Net.ErrorCode.NoError"/>) of it was wrong.
</summary>
<returns>Returns ErrorCode.NoError if the connection was successful, otherwise check the ErrorCode</returns>
</member>
<member name="M:S7.Net.Plc.Close">
<summary>
Disonnects from the PLC and close the socket
</summary>
</member>
<member name="M:S7.Net.Plc.ReadMultipleVars(System.Collections.Generic.List{S7.Net.Types.DataItem})">
<summary>
Reads multiple vars in a single request.
You have to create and pass a list of DataItems and you obtain in response the same list with the values.
Values are stored in the property "Value" of the dataItem and are already converted.
If you don't want the conversion, just create a dataItem of bytes.
DataItems must not be more than 20 (protocol restriction) and bytes must not be more than 200 + 22 of header (protocol restriction).
</summary>
<param name="dataItems">List of dataitems that contains the list of variables that must be read. Maximum 20 dataitems are accepted.</param>
</member>
<member name="M:S7.Net.Plc.ReadBytes(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
<returns>Returns the bytes in an array</returns>
</member>
<member name="M:S7.Net.Plc.Read(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte)">
<summary>
Read and decode a certain number of bytes of the "VarType" provided.
This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="varType">Type of the variable/s that you are reading</param>
<param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
<param name="varCount"></param>
</member>
<member name="M:S7.Net.Plc.Read(System.String)">
<summary>
Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct(System.Type,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
</summary>
<param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a struct that must be cast.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
</summary>
<typeparam name="T">The struct type</typeparam>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass(System.Object,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<param name="sourceClass">Instance of the class that will store the values</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>The number of read bytes</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
type, the class needs a default constructor.
</summary>
<typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Func{``0},System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<typeparam name="T">The class that will be instantiated</typeparam>
<param name="classFactory">Function to instantiate the class</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32)">
<summary>
Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
You must specify the memory area type, memory are address, byte start address and bytes count.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(System.String,System.Object)">
<summary>
Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the write was not successful, check <see cref="P:S7.Net.Plc.LastErrorCode"/> or <see cref="P:S7.Net.Plc.LastErrorString"/>.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<param name="value">Value to be written to the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteStruct(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# struct to a DB in the PLC
</summary>
<param name="structValue">The struct to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteClass(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# class to a DB in the PLC
</summary>
<param name="classValue">The class to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ClearLastError">
<summary>
Sets the <see cref="P:S7.Net.Plc.LastErrorCode"/> to <see cref="F:S7.Net.ErrorCode.NoError"/> and <see cref="P:S7.Net.Plc.LastErrorString"/> to <see cref="F:System.String.Empty"/>.
</summary>
</member>
<member name="M:S7.Net.Plc.ReadHeaderPackage(System.Int32)">
<summary>
Creates the header to read bytes from the PLC
</summary>
<param name="amount"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.CreateReadDataRequestPackage(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType),
the address of the memory, the address of the byte and the bytes count.
</summary>
<param name="dataType">MemoryType (DB, Timer, Counter, etc.)</param>
<param name="db">Address of the memory to be read</param>
<param name="startByteAdr">Start address of the byte</param>
<param name="count">Number of bytes to be read</param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.WriteBytesWithASingleRequest(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Writes up to 200 bytes to the PLC and returns NoError if successful. You must specify the memory area type, memory are address, byte start address and bytes count.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ParseBytes(S7.Net.VarType,System.Byte[],System.Int32,System.Byte)">
<summary>
Given a S7 variable type (Bool, Word, DWord, etc.), it converts the bytes in the appropriate C# format.
</summary>
<param name="varType"></param>
<param name="bytes"></param>
<param name="varCount"></param>
<param name="bitAdr"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.VarTypeToByteLength(S7.Net.VarType,System.Int32)">
<summary>
Given a S7 <see cref="T:S7.Net.VarType"/> (Bool, Word, DWord, etc.), it returns how many bytes to read.
</summary>
<param name="varType"></param>
<param name="varCount"></param>
<returns>Byte lenght of variable</returns>
</member>
<member name="M:S7.Net.Plc.Dispose(System.Boolean)">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="M:S7.Net.Plc.Dispose">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="T:S7.Net.TPKT">
<summary>
Describes a TPKT Packet
</summary>
</member>
<member name="M:S7.Net.TPKT.Read(System.Net.Sockets.Socket)">
<summary>
Reds a TPKT from the socket
</summary>
<param name="socket">The socket to read from</param>
<returns>TPKT Instace</returns>
</member>
<member name="T:S7.Net.Types.Bit">
<summary>
Contains the conversion methods to convert Bit from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Bit.FromByte(System.Byte,System.Byte)">
<summary>
Converts a Bit to bool
</summary>
</member>
<member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[])">
<summary>
Converts an array of bytes to a BitArray
</summary>
</member>
<member name="T:S7.Net.Types.Boolean">
<summary>
Contains the methods to read, set and reset bits inside bytes
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.GetValue(System.Byte,System.Int32)">
<summary>
Returns the value of a bit in a bit, given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.SetBit(System.Byte,System.Int32)">
<summary>
Sets the value of a bit to 1 (true), given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte,System.Int32)">
<summary>
Resets the value of a bit to 0 (false), given the address of the bit
</summary>
</member>
<member name="T:S7.Net.Types.Byte">
<summary>
Contains the methods to convert from bytes to byte arrays
</summary>
</member>
<member name="M:S7.Net.Types.Byte.ToByteArray(System.Byte)">
<summary>
Converts a byte to byte array
</summary>
</member>
<member name="M:S7.Net.Types.Byte.FromByteArray(System.Byte[])">
<summary>
Converts a byte array to byte
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Class">
<summary>
Contains the methods to convert a C# class to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Class.GetClassSize(System.Object)">
<summary>
Gets the size of the class in bytes.
</summary>
<param name="instance">An instance of the class</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Class.FromBytes(System.Object,System.Byte[])">
<summary>
Sets the object's values with the given array of bytes
</summary>
<param name="sourceClass">The object to fill in the given array of bytes</param>
<param name="bytes">The array of bytes</param>
</member>
<member name="M:S7.Net.Types.Class.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="sourceClass">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Counter">
<summary>
Contains the conversion methods to convert Counter from S7 plc to C# ushort (UInt16).
</summary>
</member>
<member name="M:S7.Net.Types.Counter.FromByteArray(System.Byte[])">
<summary>
Converts a Counter (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
<member name="T:S7.Net.Types.DataItem">
<summary>
Create an instance of a memory block that can be read by using ReadMultipleVars
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DataType">
<summary>
Memory area to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.VarType">
<summary>
Type of data to be read (default is bytes)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DB">
<summary>
Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.StartByteAdr">
<summary>
Address of the first byte to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.BitAdr">
<summary>
Addess of bit to read from StartByteAdr
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Count">
<summary>
Number of variables to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Value">
<summary>
Contains the value of the memory area after the read has been executed
</summary>
</member>
<member name="M:S7.Net.Types.DataItem.#ctor">
<summary>
Create an instance of DataItem
</summary>
</member>
<member name="T:S7.Net.Types.DInt">
<summary>
Contains the conversion methods to convert DInt from S7 plc to C# int (Int32).
</summary>
</member>
<member name="M:S7.Net.Types.DInt.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DInt (4 bytes) to int (Int32)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32)">
<summary>
Converts a int (Int32) to S7 DInt (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32[])">
<summary>
Converts an array of int (Int32) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DInt to an array of int (Int32)
</summary>
</member>
<member name="T:S7.Net.Types.Double">
<summary>
Contains the conversion methods to convert Real from S7 plc to C# double.
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Real (4 bytes) to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.Int32)">
<summary>
Converts a S7 DInt to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.UInt32)">
<summary>
Converts a S7 DWord to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double)">
<summary>
Converts a double to S7 Real (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double[])">
<summary>
Converts an array of double to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Real to an array of double
</summary>
</member>
<member name="T:S7.Net.Types.DWord">
<summary>
Contains the conversion methods to convert DWord from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DWord (4 bytes) to uint (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromBytes(System.Byte,System.Byte,System.Byte,System.Byte)">
<summary>
Converts 4 bytes to DWord (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32)">
<summary>
Converts a uint (UInt32) to S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32[])">
<summary>
Converts an array of uint (UInt32) to an array of S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DWord to an array of uint (UInt32)
</summary>
</member>
<member name="T:S7.Net.Types.Int">
<summary>
Contains the conversion methods to convert Int from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Int.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Int (2 bytes) to short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16)">
<summary>
Converts a short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16[])">
<summary>
Converts an array of short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Int to an array of short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.CWord(System.Int32)">
<summary>
Converts a C# int value to a C# short value, to be used as word.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.StringEx">
<summary>
Contains the methods to convert from S7 strings to C# strings
there are two kinds how strings a send. This one is with a pre of two bytes
they contain the length of the string
</summary>
</member>
<member name="M:S7.Net.Types.StringEx.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.String">
<summary>
Contains the methods to convert from S7 strings to C# strings
</summary>
</member>
<member name="M:S7.Net.Types.String.ToByteArray(System.String)">
<summary>
Converts a string to S7 bytes
</summary>
</member>
<member name="M:S7.Net.Types.String.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Struct">
<summary>
Contains the method to convert a C# struct to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Struct.GetStructSize(System.Type)">
<summary>
Gets the size of the struct in bytes.
</summary>
<param name="structType">the type of the struct</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Struct.FromBytes(System.Type,System.Byte[])">
<summary>
Creates a struct of a specified type by an array of bytes.
</summary>
<param name="structType">The struct type</param>
<param name="bytes">The array of bytes</param>
<returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
</member>
<member name="M:S7.Net.Types.Struct.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="structValue">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Timer">
<summary>
Converts the Timer data type to C# data type
</summary>
</member>
<member name="M:S7.Net.Types.Timer.FromByteArray(System.Byte[])">
<summary>
Converts the timer bytes to a double
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushorts (Uint16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToArray(System.Byte[])">
<summary>
Converts an array of bytes formatted as time to an array of doubles
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Word">
<summary>
Contains the conversion methods to convert Words from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromByteArray(System.Byte[])">
<summary>
Converts a word (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromBytes(System.Byte,System.Byte)">
<summary>
Converts 2 bytes to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
</members>
</doc>
MTH-Siemens/bin/Release/logs/.placeholder.txt
+1
View File
@@ -0,0 +1 @@

MTH-Siemens/bin/Release/setup.json
+19
View File
@@ -0,0 +1,19 @@
{
"csvFilePath": "c:\\zz\\prova1.csv",
"csvHasHeader": true,
"csvSeparator": ";",
"confPLC": {
"ipAdrr": "192.168.0.102",
"tipoCpu": "S71500",
"rack": 0,
"slot": 1
},
"parametersList": {
"DB999.DBD32": {
"Column": "Valore assoluto",
"Index": 7,
"MemConf": "DB999.DBD32",
"DataType": "real"
}
}
}
MTH-Siemens/obj/Release/MHT-Siemens.csproj.CopyComplete
View File
MTH-Siemens/obj/Release/MHT-Siemens.csproj.FileListAbsolute.txt
+20
View File
@@ -0,0 +1,20 @@
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\NLog.config
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\setup.json
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\logs\.placeholder.txt
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\MHT-Siemens.exe.config
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\MHT-Siemens.exe
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\MHT-Siemens.pdb
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\Newtonsoft.Json.dll
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\NLog.dll
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\S7.Net.dll
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\Newtonsoft.Json.xml
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\NLog.xml
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.csprojAssemblyReference.cache
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT_Siemens.Properties.Resources.resources
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT_Siemens.SiemensProxy.resources
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.csproj.GenerateResource.cache
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.csproj.CoreCompileInputs.cache
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.csproj.CopyComplete
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.exe
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\obj\Release\MHT-Siemens.pdb
C:\Users\samuele.steamw\Documents\VisualStudioProject\MHT-Siemens\MTH-Siemens\bin\Release\S7.Net.xml
MTH-Siemens/obj/Release/MHT_Siemens.Properties.Resources.resources
BIN
View File
Binary file not shown.
MTH-Siemens/obj/Release/MHT_Siemens.SiemensProxy.resources
BIN
View File
Binary file not shown.
MTH-Siemens/packages.config
+6 -5
View File
@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Newtonsoft.Json" version="12.0.3" targetFramework="net462" />
<package id="NLog" version="4.7.0" targetFramework="net462" />
<package id="NLog.Config" version="4.7.0" targetFramework="net462" />
<package id="NLog.Schema" version="4.7.0" targetFramework="net462" />
<package id="S7netplus" version="0.4.0" targetFramework="net462" />
<package id="Newtonsoft.Json" version="11.0.1" targetFramework="net40" />
<package id="NLog" version="4.6.0" targetFramework="net40" />
<package id="NLog.Config" version="4.6.0" targetFramework="net40" />
<package id="NLog.Schema" version="4.6.0" targetFramework="net40" />
<package id="PrettyBin" version="1.1.0" targetFramework="net462" />
<package id="S7netplus" version="0.1.9" targetFramework="net40" />
</packages>
packages/NLog.4.7.0/.signature.p7s → packages/NLog.4.6.0/.signature.p7s
Vendored
BIN
View File
Binary file not shown.
packages/NLog.4.6.0/NLog.4.6.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/NLog.4.7.0/lib/xamarinios10/NLog.xml → packages/NLog.4.6.0/lib/monoandroid44/NLog.xml
Vendored
+534 -1476
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/netstandard2.0/NLog.xml → packages/NLog.4.6.0/lib/net35/NLog.xml
Vendored
+2584 -2016
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/net45/NLog.xml → packages/NLog.4.6.0/lib/net40-client/NLog.xml
Vendored
+559 -1833
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/net35/NLog.xml → packages/NLog.4.6.0/lib/net45/NLog.xml
Vendored
+987 -1628
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.6.0/lib/netstandard1.3/NLog.xml
Vendored
+24668
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/netstandard1.3/NLog.xml → packages/NLog.4.6.0/lib/netstandard1.5/NLog.xml
Vendored
+1382 -1394
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/netstandard1.5/NLog.xml → packages/NLog.4.6.0/lib/netstandard2.0/NLog.xml
Vendored
+1250 -1536
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/sl4/NLog.xml → packages/NLog.4.6.0/lib/sl4/NLog.xml
Vendored
+412 -1352
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/wp8/NLog.xml → packages/NLog.4.6.0/lib/sl5/NLog.xml
Vendored
+1239 -1356
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/sl5/NLog.xml → packages/NLog.4.6.0/lib/wp8/NLog.xml
Vendored
+419 -2184
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/lib/monoandroid44/NLog.xml → packages/NLog.4.6.0/lib/xamarinios10/NLog.xml
Vendored
+452 -1527
View File
File diff suppressed because it is too large Load Diff
packages/NLog.4.7.0/NLog.4.7.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/NLog.Schema.4.7.0/.signature.p7s → packages/NLog.Config.4.6.0/.signature.p7s
Vendored
BIN
View File
Binary file not shown.
packages/NLog.Config.4.7.0/NLog.Config.4.7.0.nupkg → packages/NLog.Config.4.6.0/NLog.Config.4.6.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/NLog.Config.4.7.0/content/NLog.config → packages/NLog.Config.4.6.0/content/NLog.config
Vendored
View File
packages/NLog.Config.4.7.0/contentFiles/any/any/NLog.config → packages/NLog.Config.4.6.0/contentFiles/any/any/NLog.config
Vendored
View File
packages/NLog.Config.4.7.0/tools/Install.ps1 → packages/NLog.Config.4.6.0/tools/Install.ps1
Vendored
View File
packages/NLog.Config.4.7.0/.signature.p7s → packages/NLog.Schema.4.6.0/.signature.p7s
Vendored
BIN
View File
Binary file not shown.
packages/NLog.Schema.4.6.0/NLog.Schema.4.6.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/NLog.Schema.4.7.0/content/NLog.xsd → packages/NLog.Schema.4.6.0/content/NLog.xsd
Vendored
+170 -316
View File
@@ -37,12 +37,12 @@
</xs:attribute>
<xs:attribute name="globalThreshold" type="NLogLevel">
<xs:annotation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged.</xs:documentation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged..</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwExceptions" type="xs:boolean">
<xs:annotation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false. Not recommend to set to true in production!</xs:documentation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwConfigExceptions" type="xs:boolean">
@@ -72,7 +72,7 @@
</xs:attribute>
<xs:attribute name="parseMessageTemplates" type="xs:boolean">
<xs:annotation>
<xs:documentation>Perform message template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
<xs:documentation>Perform mesage template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -123,7 +123,7 @@
</xs:choice>
<xs:attribute name="name" use="optional">
<xs:annotation>
<xs:documentation>Name of the logger. May include wildcard characters ('*' or '?').</xs:documentation>
<xs:documentation>Name of the logger. May include '*' character which acts like a wildcard. Allowed forms are: *, Name, *Name, Name* and *Name*</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="levels" type="NLogLevelList">
@@ -156,9 +156,9 @@
<xs:documentation>Ignore further rules if this one matches.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ruleName" type="xs:string" use="optional">
<xs:attribute name="enabled" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName.</xs:documentation>
<xs:documentation>Enable or disable logging rule. Disabled rules are ignored.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -171,11 +171,6 @@
<xs:element name="whenNotEqual" type="whenNotEqual" />
<xs:element name="whenRepeated" type="whenRepeated" />
</xs:choice>
<xs:attribute name="defaultAction" type="FilterResult">
<xs:annotation>
<xs:documentation>Default action if none of the filters match.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:simpleType name="NLogLevel">
<xs:restriction base="xs:string">
@@ -215,19 +210,12 @@
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLogVariable">
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="value" minOccurs="0" maxOccurs="1" type="xs:string">
<xs:annotation>
<xs:documentation>Variable value. Note, the 'value' attribute has precedence over this one.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Variable name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="SimpleLayoutAttribute">
<xs:attribute name="value" type="SimpleLayoutAttribute" use="required">
<xs:annotation>
<xs:documentation>Variable value.</xs:documentation>
</xs:annotation>
@@ -351,7 +339,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="asyncFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="flushOnConditionOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -365,11 +352,6 @@
<xs:documentation>Condition expression. Log events who meet this condition will cause a flush on the wrapped target.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="flushOnConditionOnly" type="xs:boolean">
<xs:annotation>
<xs:documentation>Only flush when LogEvent matches condition. Ignore explicit-flush, config-reload-flush and shutdown-flush</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the target.</xs:documentation>
@@ -443,15 +425,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -497,11 +479,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -512,14 +489,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -537,9 +509,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -610,18 +592,6 @@
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Tls13" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="NLog.Targets.NetworkTargetConnectionsOverflowAction">
<xs:restriction base="xs:string">
<xs:enumeration value="AllowNewConnnection" />
@@ -636,15 +606,25 @@
<xs:enumeration value="Discard" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.NLogViewerParameterInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
@@ -652,11 +632,6 @@
<xs:documentation>Viewer parameter name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether an attribute with empty value should be included in the output</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ColoredConsole">
<xs:complexContent>
@@ -670,8 +645,6 @@
<xs:element name="enableAnsiOutput" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="errorStream" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectOutputRedirected" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="useDefaultRowHighlightingRules" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="highlight-row" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleRowHighlightingRule" />
<xs:element name="highlight-word" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleWordHighlightingRule" />
@@ -717,16 +690,6 @@
<xs:documentation>Indicates whether the error stream (stderr) should be used instead of the output stream (stdout).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectOutputRedirected" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console has been redirected to file - Disables coloring logic when System.Console.IsOutputRedirected = true</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="useDefaultRowHighlightingRules" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to use default row highlighting rules.</xs:documentation>
@@ -837,11 +800,9 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="header" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectConsoleAvailable" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="error" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBuffer" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -864,11 +825,6 @@
<xs:documentation>Footer.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectConsoleAvailable" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console is available - Disables console writing if Environment.UserInteractive = False (Windows Service) - Disables console writing if Console Standard Input is not available (Non-Console-App)</xs:documentation>
@@ -884,11 +840,6 @@
<xs:documentation>Indicates whether to send the log messages to the standard error instead of the standard output.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBuffer" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether to enable batch writing using char[]-buffers, instead of using </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -903,24 +854,21 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="useTransactions" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbProvider" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="dbPassword" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionStringName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="connectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="commandproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="installConnectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="install-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="uninstall-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="isolationLevel" minOccurs="0" maxOccurs="1" type="System.Data.IsolationLevel" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
<xs:element name="commandText" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
@@ -932,9 +880,9 @@
<xs:documentation>Obsolete - value will be ignored! The logging code always runs outside of transaction. Gets or sets a value indicating whether to use database transactions. Some data providers require this.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbProvider" type="xs:string">
@@ -947,14 +895,14 @@
<xs:documentation>Database password. If the ConnectionString is not provided this value will be used to construct the "Password=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="connectionStringName" type="xs:string">
@@ -967,9 +915,9 @@
<xs:documentation>Connection string. When provided, it overrides the values specified in DBHost, DBUserName, DBPassword, DBDatabase.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="installConnectionString" type="SimpleLayoutAttribute">
@@ -977,11 +925,6 @@
<xs:documentation>Connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="isolationLevel" type="System.Data.IsolationLevel">
<xs:annotation>
<xs:documentation>Configures isolated transaction batch writing. If supported by the database, then it will improve insert performance.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1007,51 +950,6 @@
<xs:enumeration value="TableDirect" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Data.IsolationLevel">
<xs:restriction base="xs:string">
<xs:enumeration value="Unspecified" />
<xs:enumeration value="Chaos" />
<xs:enumeration value="ReadUncommitted" />
<xs:enumeration value="ReadCommitted" />
<xs:enumeration value="RepeatableRead" />
<xs:enumeration value="Serializable" />
<xs:enumeration value="Snapshot" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.DatabaseObjectPropertyInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="format" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="culture" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertyType" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the property value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
<xs:annotation>
<xs:documentation>Culture used for parsing property string-value for type-conversion</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Value to assign on the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name for the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="propertyType" type="xs:string">
<xs:annotation>
<xs:documentation>Type of the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLog.Targets.DatabaseCommandInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
@@ -1100,7 +998,7 @@
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbType" type="xs:string">
@@ -1130,7 +1028,7 @@
</xs:attribute>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the database parameter value.</xs:documentation>
<xs:documentation>Convert format of the database parameter value .</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
@@ -1237,7 +1135,7 @@
</xs:attribute>
<xs:attribute name="entryType" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Optional entry type. When not set, or when not convertible to then determined by </xs:documentation>
<xs:documentation>Optional entrytype. When not set, or when not convertible to then determined by </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="eventId" type="SimpleLayoutAttribute">
@@ -1326,7 +1224,6 @@
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxArchiveDays" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="enableArchiveFileCompression" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveNumbering" minOccurs="0" maxOccurs="1" type="NLog.Targets.ArchiveNumberingMode" />
<xs:element name="archiveFileName" minOccurs="0" maxOccurs="1" type="Layout" />
@@ -1336,20 +1233,19 @@
<xs:element name="maxArchiveFiles" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="writeFooterOnArchivingOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxLogFilenames" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="deleteOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileAttributes" minOccurs="0" maxOccurs="1" type="NLog.Targets.Win32FileAttributes" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveOldFileOnStartupAboveSize" minOccurs="0" maxOccurs="1" type="xs:long" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="networkWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="openFileCacheTimeout" minOccurs="0" maxOccurs="1" type="xs:integer" />
@@ -1393,11 +1289,6 @@
<xs:documentation>Line ending mode.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxArchiveDays" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum days of archive files that should be kept.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableArchiveFileCompression" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to compress archive files into the zip archive format.</xs:documentation>
@@ -1440,7 +1331,62 @@
</xs:attribute>
<xs:attribute name="maxLogFilenames" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum number of log file names that should be stored as existing.</xs:documentation>
<xs:documentation>Maximum number of log filenames that should be stored as existing.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Value indicationg whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="deleteOldFileOnStartup" type="xs:boolean">
@@ -1453,66 +1399,6 @@
<xs:documentation>File attributes (Windows only).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartupAboveSize" type="xs:long">
<xs:annotation>
<xs:documentation>Value of the file size threshold to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1634,7 +1520,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="filter" minOccurs="0" maxOccurs="1" type="Filter" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2112,13 +1997,13 @@
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2161,11 +2046,6 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
@@ -2196,6 +2076,11 @@
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -2214,15 +2099,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2268,11 +2153,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -2283,14 +2163,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -2308,9 +2183,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -2700,7 +2585,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="enableTraceFail" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="rawWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -2714,11 +2598,6 @@
<xs:documentation>Layout used to format log messages.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableTraceFail" type="xs:boolean">
<xs:annotation>
<xs:documentation>Forward to (Instead of )</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rawWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Always use independent of </xs:documentation>
@@ -2963,9 +2842,6 @@
<xs:complexContent>
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.JsonAttribute" />
<xs:element name="excludeProperties" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2973,22 +2849,9 @@
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxRecursionLimit" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
<xs:documentation>List of property names to exclude when is true</xs:documentation>
@@ -3019,6 +2882,16 @@
<xs:documentation>How far should the JSON serializer follow object references before backing off</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3027,7 +2900,6 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeUnicode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -3043,12 +2915,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeUnicode" type="xs:boolean">
@@ -3093,24 +2960,16 @@
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeCallSite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
</xs:choice>
<xs:attribute name="includeAllProperties" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to include all properties from the log events</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeCallSite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include call site (class and method name) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeMdc" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include contents of the dictionary.</xs:documentation>
@@ -3131,11 +2990,6 @@
<xs:documentation>Indicates whether to include contents of the stack.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeSourceInfo" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include source info (file name and line number) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3167,12 +3021,12 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="elementValue" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
@@ -3219,6 +3073,11 @@
<xs:documentation>XML attribute name to use when rendering property-value When null (or empty) then value-attribute is not included and value is formatted as XML-element-value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementName" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the root XML element</xs:documentation>
@@ -3239,11 +3098,6 @@
<xs:documentation>Auto indent and create new lines</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3266,7 +3120,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
@@ -3277,10 +3131,10 @@
</xs:complexType>
<xs:complexType name="NLog.Layouts.XmlElement">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="value" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -3294,11 +3148,6 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the element</xs:documentation>
@@ -3309,6 +3158,11 @@
<xs:documentation>Value inside the element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether a ElementValue with empty value should be included in the output</xs:documentation>
packages/NLog.Schema.4.7.0/contentFiles/any/any/NLog.xsd → packages/NLog.Schema.4.6.0/contentFiles/any/any/NLog.xsd
Vendored
+170 -316
View File
@@ -37,12 +37,12 @@
</xs:attribute>
<xs:attribute name="globalThreshold" type="NLogLevel">
<xs:annotation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged.</xs:documentation>
<xs:documentation>Global log level threshold for application log messages. Messages below this level won't be logged..</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwExceptions" type="xs:boolean">
<xs:annotation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false. Not recommend to set to true in production!</xs:documentation>
<xs:documentation>Throw an exception when there is an internal error. Default value is: false.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="throwConfigExceptions" type="xs:boolean">
@@ -72,7 +72,7 @@
</xs:attribute>
<xs:attribute name="parseMessageTemplates" type="xs:boolean">
<xs:annotation>
<xs:documentation>Perform message template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
<xs:documentation>Perform mesage template parsing and formatting of LogEvent messages (true = Always, false = Never, empty = Auto Detect). Default value is: empty.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -123,7 +123,7 @@
</xs:choice>
<xs:attribute name="name" use="optional">
<xs:annotation>
<xs:documentation>Name of the logger. May include wildcard characters ('*' or '?').</xs:documentation>
<xs:documentation>Name of the logger. May include '*' character which acts like a wildcard. Allowed forms are: *, Name, *Name, Name* and *Name*</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="levels" type="NLogLevelList">
@@ -156,9 +156,9 @@
<xs:documentation>Ignore further rules if this one matches.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ruleName" type="xs:string" use="optional">
<xs:attribute name="enabled" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName.</xs:documentation>
<xs:documentation>Enable or disable logging rule. Disabled rules are ignored.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
@@ -171,11 +171,6 @@
<xs:element name="whenNotEqual" type="whenNotEqual" />
<xs:element name="whenRepeated" type="whenRepeated" />
</xs:choice>
<xs:attribute name="defaultAction" type="FilterResult">
<xs:annotation>
<xs:documentation>Default action if none of the filters match.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:simpleType name="NLogLevel">
<xs:restriction base="xs:string">
@@ -215,19 +210,12 @@
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLogVariable">
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="value" minOccurs="0" maxOccurs="1" type="xs:string">
<xs:annotation>
<xs:documentation>Variable value. Note, the 'value' attribute has precedence over this one.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Variable name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="SimpleLayoutAttribute">
<xs:attribute name="value" type="SimpleLayoutAttribute" use="required">
<xs:annotation>
<xs:documentation>Variable value.</xs:documentation>
</xs:annotation>
@@ -351,7 +339,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="asyncFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="flushOnConditionOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -365,11 +352,6 @@
<xs:documentation>Condition expression. Log events who meet this condition will cause a flush on the wrapped target.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="flushOnConditionOnly" type="xs:boolean">
<xs:annotation>
<xs:documentation>Only flush when LogEvent matches condition. Ignore explicit-flush, config-reload-flush and shutdown-flush</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the target.</xs:documentation>
@@ -443,15 +425,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -497,11 +479,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -512,14 +489,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -537,9 +509,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -610,18 +592,6 @@
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Tls13" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="NLog.Targets.NetworkTargetConnectionsOverflowAction">
<xs:restriction base="xs:string">
<xs:enumeration value="AllowNewConnnection" />
@@ -636,15 +606,25 @@
<xs:enumeration value="Discard" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Security.Authentication.SslProtocols">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Ssl2" />
<xs:enumeration value="Ssl3" />
<xs:enumeration value="Tls" />
<xs:enumeration value="Tls11" />
<xs:enumeration value="Tls12" />
<xs:enumeration value="Default" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.NLogViewerParameterInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
@@ -652,11 +632,6 @@
<xs:documentation>Viewer parameter name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether an attribute with empty value should be included in the output</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ColoredConsole">
<xs:complexContent>
@@ -670,8 +645,6 @@
<xs:element name="enableAnsiOutput" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="errorStream" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectOutputRedirected" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="useDefaultRowHighlightingRules" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="highlight-row" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleRowHighlightingRule" />
<xs:element name="highlight-word" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.ConsoleWordHighlightingRule" />
@@ -717,16 +690,6 @@
<xs:documentation>Indicates whether the error stream (stderr) should be used instead of the output stream (stdout).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectOutputRedirected" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console has been redirected to file - Disables coloring logic when System.Console.IsOutputRedirected = true</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="useDefaultRowHighlightingRules" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to use default row highlighting rules.</xs:documentation>
@@ -837,11 +800,9 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="header" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="autoFlush" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="detectConsoleAvailable" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="error" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBuffer" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -864,11 +825,6 @@
<xs:documentation>Footer.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoFlush" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-flush after </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="detectConsoleAvailable" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to auto-check if the console is available - Disables console writing if Environment.UserInteractive = False (Windows Service) - Disables console writing if Console Standard Input is not available (Non-Console-App)</xs:documentation>
@@ -884,11 +840,6 @@
<xs:documentation>Indicates whether to send the log messages to the standard error instead of the standard output.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBuffer" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether to enable batch writing using char[]-buffers, instead of using </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -903,24 +854,21 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="useTransactions" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbProvider" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="dbPassword" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbUserName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionStringName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="connectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="commandproperty" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseObjectPropertyInfo" />
<xs:element name="dbDatabase" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="dbHost" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="installConnectionString" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="install-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="uninstall-command" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseCommandInfo" />
<xs:element name="isolationLevel" minOccurs="0" maxOccurs="1" type="System.Data.IsolationLevel" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
<xs:element name="commandText" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.DatabaseParameterInfo" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
@@ -932,9 +880,9 @@
<xs:documentation>Obsolete - value will be ignored! The logging code always runs outside of transaction. Gets or sets a value indicating whether to use database transactions. Some data providers require this.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbProvider" type="xs:string">
@@ -947,14 +895,14 @@
<xs:documentation>Database password. If the ConnectionString is not provided this value will be used to construct the "Password=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
<xs:documentation>Indicates whether to keep the database connection open between the log events.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbUserName" type="SimpleLayoutAttribute">
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string.</xs:documentation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="connectionStringName" type="xs:string">
@@ -967,9 +915,9 @@
<xs:documentation>Connection string. When provided, it overrides the values specified in DBHost, DBUserName, DBPassword, DBDatabase.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbDatabase" type="SimpleLayoutAttribute">
<xs:attribute name="dbHost" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string.</xs:documentation>
<xs:documentation>Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="installConnectionString" type="SimpleLayoutAttribute">
@@ -977,11 +925,6 @@
<xs:documentation>Connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="isolationLevel" type="System.Data.IsolationLevel">
<xs:annotation>
<xs:documentation>Configures isolated transaction batch writing. If supported by the database, then it will improve insert performance.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1007,51 +950,6 @@
<xs:enumeration value="TableDirect" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="System.Data.IsolationLevel">
<xs:restriction base="xs:string">
<xs:enumeration value="Unspecified" />
<xs:enumeration value="Chaos" />
<xs:enumeration value="ReadUncommitted" />
<xs:enumeration value="ReadCommitted" />
<xs:enumeration value="RepeatableRead" />
<xs:enumeration value="Serializable" />
<xs:enumeration value="Snapshot" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NLog.Targets.DatabaseObjectPropertyInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="format" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="culture" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertyType" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the property value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
<xs:annotation>
<xs:documentation>Culture used for parsing property string-value for type-conversion</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Value to assign on the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name for the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="propertyType" type="xs:string">
<xs:annotation>
<xs:documentation>Type of the object-property</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="NLog.Targets.DatabaseCommandInfo">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="commandType" minOccurs="0" maxOccurs="1" type="System.Data.CommandType" />
@@ -1100,7 +998,7 @@
</xs:attribute>
<xs:attribute name="layout" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Layout that should be use to calculate the value for the parameter.</xs:documentation>
<xs:documentation>Layout that should be use to calcuate the value for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dbType" type="xs:string">
@@ -1130,7 +1028,7 @@
</xs:attribute>
<xs:attribute name="format" type="xs:string">
<xs:annotation>
<xs:documentation>Convert format of the database parameter value.</xs:documentation>
<xs:documentation>Convert format of the database parameter value .</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="culture" type="xs:string">
@@ -1237,7 +1135,7 @@
</xs:attribute>
<xs:attribute name="entryType" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Optional entry type. When not set, or when not convertible to then determined by </xs:documentation>
<xs:documentation>Optional entrytype. When not set, or when not convertible to then determined by </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="eventId" type="SimpleLayoutAttribute">
@@ -1326,7 +1224,6 @@
<xs:element name="footer" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="encoding" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxArchiveDays" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="enableArchiveFileCompression" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveNumbering" minOccurs="0" maxOccurs="1" type="NLog.Targets.ArchiveNumberingMode" />
<xs:element name="archiveFileName" minOccurs="0" maxOccurs="1" type="Layout" />
@@ -1336,20 +1233,19 @@
<xs:element name="maxArchiveFiles" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="writeFooterOnArchivingOnly" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxLogFilenames" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="deleteOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileAttributes" minOccurs="0" maxOccurs="1" type="NLog.Targets.Win32FileAttributes" />
<xs:element name="createDirs" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="cleanupFileName" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveOldFileOnStartupAboveSize" minOccurs="0" maxOccurs="1" type="xs:long" />
<xs:element name="archiveOldFileOnStartup" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="archiveDateFormat" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="enableFileDelete" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="writeBom" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="replaceFileContentsOnEachWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceMutexConcurrentWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="forceManaged" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="fileNameKind" minOccurs="0" maxOccurs="1" type="NLog.Targets.FilePathKind" />
<xs:element name="fileName" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="networkWrites" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="openFileCacheTimeout" minOccurs="0" maxOccurs="1" type="xs:integer" />
@@ -1393,11 +1289,6 @@
<xs:documentation>Line ending mode.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxArchiveDays" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum days of archive files that should be kept.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableArchiveFileCompression" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to compress archive files into the zip archive format.</xs:documentation>
@@ -1440,7 +1331,62 @@
</xs:attribute>
<xs:attribute name="maxLogFilenames" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum number of log file names that should be stored as existing.</xs:documentation>
<xs:documentation>Maximum number of log filenames that should be stored as existing.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Value indicationg whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="deleteOldFileOnStartup" type="xs:boolean">
@@ -1453,66 +1399,6 @@
<xs:documentation>File attributes (Windows only).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="createDirs" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to create directories if they do not exist.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cleanupFileName" type="xs:boolean">
<xs:annotation>
<xs:documentation>Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. If set to false, nothing gets written when the filename is wrong.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartupAboveSize" type="xs:long">
<xs:annotation>
<xs:documentation>Value of the file size threshold to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveOldFileOnStartup" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to archive old log file on startup.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="archiveDateFormat" type="xs:string">
<xs:annotation>
<xs:documentation>Value specifying the date format to use when archiving files.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableFileDelete" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to enable log file(s) to be deleted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="writeBom" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to write BOM (byte order mark) in created files</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="replaceFileContentsOnEachWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to replace file contents on each write instead of appending log message at the end.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceMutexConcurrentWrites" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether file creation calls should be synchronized by a system global mutex.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forceManaged" type="xs:boolean">
<xs:annotation>
<xs:documentation>Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileNameKind" type="NLog.Targets.FilePathKind">
<xs:annotation>
<xs:documentation>Is the an absolute or relative path?</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fileName" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Name of the file to write to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -1634,7 +1520,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="condition" minOccurs="0" maxOccurs="1" type="Condition" />
<xs:element name="filter" minOccurs="0" maxOccurs="1" type="Filter" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2112,13 +1997,13 @@
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="name" type="xs:string">
@@ -2161,11 +2046,6 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
@@ -2196,6 +2076,11 @@
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimizeBufferReuse" type="xs:boolean">
<xs:annotation>
<xs:documentation>Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit</xs:documentation>
@@ -2214,15 +2099,15 @@
<xs:element name="lineEnding" minOccurs="0" maxOccurs="1" type="LineEndingMode" />
<xs:element name="maxMessageSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="newLine" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="address" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="connectionCacheSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxConnections" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="onConnectionOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetConnectionsOverflowAction" />
<xs:element name="onOverflow" minOccurs="0" maxOccurs="1" type="NLog.Targets.NetworkTargetOverflowAction" />
<xs:element name="keepConnection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="sslProtocols" minOccurs="0" maxOccurs="1" type="System.Security.Authentication.SslProtocols" />
<xs:element name="maxQueueSize" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="keepAliveTimeSeconds" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
<xs:element name="ndlcItemSeparator" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2268,11 +2153,6 @@
<xs:documentation>Indicates whether to append newline at the end of log message.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="SimpleLayoutAttribute">
<xs:annotation>
<xs:documentation>Network address.</xs:documentation>
@@ -2283,14 +2163,9 @@
<xs:documentation>Size of the connection cache (number of connections which are kept alive).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxConnections" type="xs:integer">
@@ -2308,9 +2183,19 @@
<xs:documentation>Action that should be taken if the message is larger than maxMessageSize.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepConnection" type="xs:boolean">
<xs:attribute name="sslProtocols" type="System.Security.Authentication.SslProtocols">
<xs:annotation>
<xs:documentation>Indicates whether to keep connection open whenever possible.</xs:documentation>
<xs:documentation>Get or set the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxQueueSize" type="xs:integer">
<xs:annotation>
<xs:documentation>Maximum queue size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="keepAliveTimeSeconds" type="xs:integer">
<xs:annotation>
<xs:documentation>The number of seconds a connection will remain idle before the first keep-alive probe is sent</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ndlcItemSeparator" type="xs:string">
@@ -2700,7 +2585,6 @@
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="enableTraceFail" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="rawWrite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="optimizeBufferReuse" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -2714,11 +2598,6 @@
<xs:documentation>Layout used to format log messages.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enableTraceFail" type="xs:boolean">
<xs:annotation>
<xs:documentation>Forward to (Instead of )</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rawWrite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Always use independent of </xs:documentation>
@@ -2963,9 +2842,6 @@
<xs:complexContent>
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.JsonAttribute" />
<xs:element name="excludeProperties" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -2973,22 +2849,9 @@
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="maxRecursionLimit" minOccurs="0" maxOccurs="1" type="xs:integer" />
<xs:element name="renderEmptyObject" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="suppressSpaces" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
<xs:documentation>List of property names to exclude when is true</xs:documentation>
@@ -3019,6 +2882,16 @@
<xs:documentation>How far should the JSON serializer follow object references before backing off</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="renderEmptyObject" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to render the empty object value {}</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressSpaces" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to suppress the extra spaces in the output json</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3027,7 +2900,6 @@
<xs:element name="layout" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeForwardSlash" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="escapeUnicode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
@@ -3043,12 +2915,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeForwardSlash" type="xs:boolean">
<xs:annotation>
<xs:documentation>Should forward slashes be escaped? If true, / will be converted to \/</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Json encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="escapeUnicode" type="xs:boolean">
@@ -3093,24 +2960,16 @@
<xs:extension base="Layout">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="includeAllProperties" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeCallSite" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeMdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeNdlc" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="includeSourceInfo" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="parameter" minOccurs="0" maxOccurs="unbounded" type="NLog.Targets.NLogViewerParameterInfo" />
</xs:choice>
<xs:attribute name="includeAllProperties" type="xs:boolean">
<xs:annotation>
<xs:documentation>Option to include all properties from the log events</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeCallSite" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include call site (class and method name) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeMdc" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include contents of the dictionary.</xs:documentation>
@@ -3131,11 +2990,6 @@
<xs:documentation>Indicates whether to include contents of the stack.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeSourceInfo" type="xs:boolean">
<xs:annotation>
<xs:documentation>Indicates whether to include source info (file name and line number) in the information sent over the network.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3167,12 +3021,12 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="elementValue" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
</xs:choice>
<xs:attribute name="excludeProperties" type="xs:string">
<xs:annotation>
@@ -3219,6 +3073,11 @@
<xs:documentation>XML attribute name to use when rendering property-value When null (or empty) then value-attribute is not included and value is formatted as XML-element-value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementName" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the root XML element</xs:documentation>
@@ -3239,11 +3098,6 @@
<xs:documentation>Auto indent and create new lines</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -3266,7 +3120,7 @@
</xs:attribute>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
<xs:documentation>Determines wether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
@@ -3277,10 +3131,10 @@
</xs:complexType>
<xs:complexType name="NLog.Layouts.XmlElement">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="encode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="name" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="value" minOccurs="0" maxOccurs="1" type="Layout" />
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlAttribute" />
<xs:element name="elementEncode" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="element" minOccurs="0" maxOccurs="unbounded" type="NLog.Layouts.XmlElement" />
<xs:element name="includeEmptyValue" minOccurs="0" maxOccurs="1" type="xs:boolean" />
<xs:element name="indentXml" minOccurs="0" maxOccurs="1" type="xs:boolean" />
@@ -3294,11 +3148,6 @@
<xs:element name="propertiesElementName" minOccurs="0" maxOccurs="1" type="xs:string" />
<xs:element name="propertiesElementValueAttribute" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:choice>
<xs:attribute name="encode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Determines whether or not this attribute will be Xml encoded.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the element</xs:documentation>
@@ -3309,6 +3158,11 @@
<xs:documentation>Value inside the element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementEncode" type="xs:boolean">
<xs:annotation>
<xs:documentation>Xml Encode the value for the XML element</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeEmptyValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether a ElementValue with empty value should be included in the output</xs:documentation>
packages/NLog.Schema.4.7.0/NLog.Schema.4.7.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/Newtonsoft.Json.12.0.3/LICENSE.md → packages/Newtonsoft.Json.11.0.1/LICENSE.md
Vendored
View File
packages/Newtonsoft.Json.11.0.1/Newtonsoft.Json.11.0.1.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/net20/Newtonsoft.Json.xml
Vendored
+44 -375
View File
@@ -661,18 +661,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -685,44 +679,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -818,7 +774,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -829,15 +785,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -900,7 +847,7 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -929,33 +876,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1384,7 +1304,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1699,30 +1619,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -1936,20 +1837,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -1961,12 +1848,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2005,9 +1886,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2455,24 +2336,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2502,17 +2365,6 @@
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2777,14 +2629,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -2796,7 +2648,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3100,11 +2952,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -3550,7 +3397,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -4190,26 +4037,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -4870,21 +4697,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -5242,34 +5059,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -5282,14 +5085,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -5456,10 +5251,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -6065,38 +5856,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -6192,13 +5983,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -6691,10 +6475,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -6972,7 +6752,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -6982,7 +6762,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -6997,7 +6777,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7013,7 +6793,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7025,7 +6805,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7038,7 +6818,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7300,7 +7080,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7357,7 +7137,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7410,7 +7190,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7438,7 +7218,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7493,7 +7273,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7518,7 +7298,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7546,7 +7326,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8237,13 +8017,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -8366,12 +8139,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -8538,11 +8305,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -8694,53 +8456,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -8837,26 +8555,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -10144,6 +9842,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -10256,43 +9963,5 @@
issue <a href="http://msdn.microsoft.com/en-us/magazine/cc135410.aspx">Nov 2007</a>.
</remarks>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.11.0.1/lib/net35/Newtonsoft.Json.xml
Vendored
+9096
View File
File diff suppressed because it is too large Load Diff
packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/net40/Newtonsoft.Json.xml
Vendored
+46 -396
View File
@@ -771,18 +771,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -795,44 +789,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -928,7 +884,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -939,15 +895,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -1010,12 +957,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -1044,33 +991,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1514,7 +1434,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1829,30 +1749,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
@@ -1900,30 +1801,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -2137,20 +2019,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -2162,12 +2030,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2206,9 +2068,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2662,24 +2524,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2709,17 +2553,6 @@
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2984,14 +2817,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -3003,7 +2836,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3307,11 +3140,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -3769,7 +3597,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -4427,26 +4255,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -5123,21 +4931,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -5510,34 +5308,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -5550,14 +5334,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -5724,10 +5500,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -6361,38 +6133,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -6506,13 +6278,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -7017,10 +6782,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -7307,7 +7068,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7317,7 +7078,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7332,7 +7093,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7348,7 +7109,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7360,7 +7121,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -7373,7 +7134,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7635,7 +7396,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7692,7 +7453,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7745,7 +7506,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7773,7 +7534,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7828,7 +7589,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7853,7 +7614,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7881,7 +7642,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8604,13 +8365,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -8756,12 +8510,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -8928,11 +8676,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -9084,53 +8827,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -9227,26 +8926,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -9502,6 +9181,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -9604,43 +9292,5 @@
A <see cref="T:Newtonsoft.Json.JsonWriter"/> write method has not been called.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/net45/Newtonsoft.Json.xml
Vendored
+71 -396
View File
@@ -771,18 +771,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -795,44 +789,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -928,7 +884,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -939,15 +895,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -1010,12 +957,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -1044,33 +991,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1514,7 +1434,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1829,30 +1749,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
@@ -1900,30 +1801,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -2137,20 +2019,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -2162,12 +2030,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2206,9 +2068,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2761,24 +2623,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2808,17 +2652,6 @@
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -3083,14 +2916,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -3102,7 +2935,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3496,11 +3329,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -4537,7 +4365,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -5831,26 +5659,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -6617,21 +6425,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -7042,34 +6840,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -7082,14 +6866,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -7331,10 +7107,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -7968,38 +7740,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -8113,13 +7885,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -8633,10 +8398,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -8923,7 +8684,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8933,7 +8694,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8948,7 +8709,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8964,7 +8725,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8976,7 +8737,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8989,7 +8750,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9251,7 +9012,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9308,7 +9069,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9361,7 +9122,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9389,7 +9150,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9444,7 +9205,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9469,7 +9230,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9497,7 +9258,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9847,6 +9608,31 @@
<param name="message">The trace message.</param>
<param name="ex">The trace exception. This parameter is optional.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.DynamicValueProvider">
<summary>
Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.#ctor(System.Reflection.MemberInfo)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DynamicValueProvider"/> class.
</summary>
<param name="memberInfo">The member info.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(System.Object,System.Object)">
<summary>
Sets the value.
</summary>
<param name="target">The target to set the value on.</param>
<param name="value">The value to set on the target.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.GetValue(System.Object)">
<summary>
Gets the value.
</summary>
<param name="target">The target to get the value from.</param>
<returns>The value.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ErrorContext">
<summary>
Provides information surrounding an error.
@@ -10195,13 +9981,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -10347,12 +10126,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -10519,11 +10292,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -10675,53 +10443,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -10818,26 +10542,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -11093,6 +10797,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -11195,43 +10908,5 @@
A <see cref="T:Newtonsoft.Json.JsonWriter"/> write method has not been called.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/netstandard1.0/Newtonsoft.Json.xml
Vendored
+45 -376
View File
@@ -675,18 +675,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -699,44 +693,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -832,7 +788,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -843,15 +799,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -914,12 +861,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -948,33 +895,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1418,7 +1338,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1733,30 +1653,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -1961,20 +1862,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -1986,12 +1873,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2030,9 +1911,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2576,24 +2457,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2614,17 +2477,6 @@
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2889,14 +2741,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -2908,7 +2760,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3302,11 +3154,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -4343,7 +4190,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -5628,26 +5475,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -6387,21 +6214,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -6719,34 +6536,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -6759,14 +6562,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -7008,10 +6803,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -7645,38 +7436,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -7790,13 +7581,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -8310,10 +8094,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -8600,7 +8380,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8610,7 +8390,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8625,7 +8405,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8641,7 +8421,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8653,7 +8433,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8666,7 +8446,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8928,7 +8708,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8976,7 +8756,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9029,7 +8809,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9057,7 +8837,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9112,7 +8892,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9137,7 +8917,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9165,7 +8945,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9832,13 +9612,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -9967,12 +9740,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -10139,11 +9906,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -10295,53 +10057,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -10438,26 +10156,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -10791,6 +10489,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -10908,43 +10615,5 @@
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <see cref="M:System.Reflection.Assembly.Load(System.Reflection.AssemblyName)"/> is used to load the assembly.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/netstandard1.3/Newtonsoft.Json.xml
Vendored
+151 -379
View File
@@ -675,18 +675,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -699,44 +693,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -832,7 +788,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -843,15 +799,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -914,12 +861,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -948,33 +895,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1418,7 +1338,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1686,6 +1606,58 @@
If this is <c>null</c>, default serialization settings will be used.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string.
</summary>
<param name="node">The node to serialize.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string.
</summary>
<param name="value">The JSON string.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
@@ -1733,30 +1705,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -1961,20 +1914,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -1986,12 +1925,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2030,9 +1963,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2576,24 +2509,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2614,17 +2529,6 @@
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2889,14 +2793,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -2908,7 +2812,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3302,11 +3206,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -4343,7 +4242,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -5628,26 +5527,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -6350,6 +6229,11 @@
Occurs when a property value changes.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanging">
<summary>
Occurs when a property value is changing.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class.
@@ -6387,21 +6271,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -6563,6 +6437,12 @@
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanging(System.String)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
@@ -6719,34 +6599,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -6759,14 +6625,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -7008,10 +6866,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -7645,38 +7499,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -7790,13 +7644,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -8310,10 +8157,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -8429,7 +8272,7 @@
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.OptOut">
<summary>
All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="!:NonSerializedAttribute"/>.
All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
This is the default member serialization mode.
</summary>
</member>
@@ -8441,8 +8284,8 @@
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.Fields">
<summary>
All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="!:NonSerializedAttribute"/>.
This member serialization mode can also be set by marking the class with <see cref="!:SerializableAttribute"/>
All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/>
and setting IgnoreSerializableAttribute on <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> to <c>false</c>.
</summary>
</member>
@@ -8600,7 +8443,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8610,7 +8453,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8625,7 +8468,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8641,7 +8484,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8653,7 +8496,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8666,7 +8509,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8928,7 +8771,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8976,7 +8819,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9029,7 +8872,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9057,7 +8900,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9112,7 +8955,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9137,7 +8980,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9165,7 +9008,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9273,6 +9116,22 @@
<c>true</c> if serialized compiler generated members; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreIsSpecifiedMembers">
<summary>
Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types.
@@ -9372,6 +9231,13 @@
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.
@@ -9832,13 +9698,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -9945,6 +9804,23 @@
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonISerializableContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonISerializableContract.ISerializableCreator">
<summary>
Gets or sets the <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.
</summary>
<value>The <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonISerializableContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonLinqContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -9967,12 +9843,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -10139,11 +10009,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -10295,53 +10160,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -10438,26 +10259,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -10791,6 +10592,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -10908,43 +10718,5 @@
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <see cref="M:System.Reflection.Assembly.Load(System.Reflection.AssemblyName)"/> is used to load the assembly.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/netstandard2.0/Newtonsoft.Json.xml
Vendored
+46 -421
View File
@@ -771,18 +771,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -795,44 +789,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -928,7 +884,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -939,15 +895,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -1010,12 +957,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -1044,33 +991,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1514,7 +1434,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1829,30 +1749,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
@@ -1900,30 +1801,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -2137,20 +2019,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -2162,12 +2030,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2206,9 +2068,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2761,24 +2623,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2808,17 +2652,6 @@
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -3083,14 +2916,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -3102,7 +2935,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3496,11 +3329,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -4537,7 +4365,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -5831,26 +5659,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -6617,21 +6425,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -7042,34 +6840,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -7082,14 +6866,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -7331,10 +7107,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -7968,38 +7740,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -8113,13 +7885,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -8633,10 +8398,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -8923,7 +8684,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8933,7 +8694,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8948,7 +8709,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8964,7 +8725,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8976,7 +8737,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8989,7 +8750,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9251,7 +9012,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9308,7 +9069,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9361,7 +9122,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9389,7 +9150,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9444,7 +9205,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9469,7 +9230,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9497,7 +9258,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9847,31 +9608,6 @@
<param name="message">The trace message.</param>
<param name="ex">The trace exception. This parameter is optional.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.DynamicValueProvider">
<summary>
Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.#ctor(System.Reflection.MemberInfo)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DynamicValueProvider"/> class.
</summary>
<param name="memberInfo">The member info.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(System.Object,System.Object)">
<summary>
Sets the value.
</summary>
<param name="target">The target to set the value on.</param>
<param name="value">The value to set on the target.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.GetValue(System.Object)">
<summary>
Gets the value.
</summary>
<param name="target">The target to get the value from.</param>
<returns>The value.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ErrorContext">
<summary>
Provides information surrounding an error.
@@ -10220,13 +9956,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -10372,12 +10101,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -10544,11 +10267,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -10700,53 +10418,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -10843,26 +10517,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -11118,6 +10772,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -11220,43 +10883,5 @@
A <see cref="T:Newtonsoft.Json.JsonWriter"/> write method has not been called.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.xml
Vendored
+43 -346
View File
@@ -635,18 +635,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -659,44 +653,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -806,12 +762,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -840,33 +796,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1310,7 +1239,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1782,20 +1711,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -1807,12 +1722,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -1851,9 +1760,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2298,24 +2207,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2336,17 +2227,6 @@
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2611,14 +2491,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -2630,7 +2510,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -2934,11 +2814,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -3396,7 +3271,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -4045,26 +3920,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -4703,21 +4558,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -4988,34 +4833,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -5028,14 +4859,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -5202,10 +5025,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -5839,38 +5658,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -5966,13 +5785,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -6477,10 +6289,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -6758,7 +6566,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -6768,7 +6576,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -6783,7 +6591,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -6799,7 +6607,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -6811,7 +6619,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -6824,7 +6632,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7086,7 +6894,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7134,7 +6942,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7187,7 +6995,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7215,7 +7023,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7270,7 +7078,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7295,7 +7103,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7323,7 +7131,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -7989,13 +7797,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -8101,12 +7902,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -8273,11 +8068,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -8429,53 +8219,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -8572,26 +8318,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -8851,6 +8577,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -8968,43 +8703,5 @@
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <see cref="M:System.Reflection.Assembly.Load(System.String)"/> is used to load the assembly.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.xml → packages/Newtonsoft.Json.11.0.1/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.xml
Vendored
+48 -501
View File
@@ -675,18 +675,12 @@
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
Gets or sets a value indicating whether integer values are allowed when deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
<value><c>true</c> if integers are allowed when deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
@@ -699,44 +693,6 @@
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -832,7 +788,7 @@
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
Gets or sets a flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
@@ -843,15 +799,6 @@
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
@@ -914,12 +861,12 @@
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
@@ -948,33 +895,6 @@
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -1418,7 +1338,7 @@
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
@@ -1686,77 +1606,6 @@
If this is <c>null</c>, default serialization settings will be used.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string.
</summary>
<param name="node">The node to serialize.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string.
</summary>
<param name="value">The JSON string.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
@@ -1804,30 +1653,11 @@
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
A flag to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
@@ -2032,20 +1862,6 @@
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
@@ -2057,12 +1873,6 @@
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
@@ -2101,9 +1911,9 @@
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
@@ -2647,24 +2457,6 @@
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
@@ -2685,17 +2477,6 @@
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
@@ -2960,14 +2741,14 @@
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
@@ -2979,7 +2760,7 @@
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
@@ -3373,11 +3154,6 @@
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
@@ -4414,7 +4190,7 @@
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -5699,26 +5475,6 @@
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
@@ -6421,11 +6177,6 @@
Occurs when a property value changes.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanging">
<summary>
Occurs when a property value is changing.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class.
@@ -6463,21 +6214,11 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
@@ -6639,12 +6380,6 @@
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanging(System.String)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
@@ -6801,34 +6536,20 @@
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
@@ -6841,14 +6562,6 @@
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
@@ -7090,10 +6803,6 @@
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
@@ -7727,38 +7436,38 @@
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
Selects a collection of elements using a JPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
A <see cref="T:System.String"/> that contains a JPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
@@ -7872,13 +7581,6 @@
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
@@ -8392,10 +8094,6 @@
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
@@ -8511,7 +8209,7 @@
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.OptOut">
<summary>
All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="!:NonSerializedAttribute"/>.
This is the default member serialization mode.
</summary>
</member>
@@ -8523,8 +8221,8 @@
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.Fields">
<summary>
All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/>
All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="!:NonSerializedAttribute"/>.
This member serialization mode can also be set by marking the class with <see cref="!:SerializableAttribute"/>
and setting IgnoreSerializableAttribute on <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> to <c>false</c>.
</summary>
</member>
@@ -8682,7 +8380,7 @@
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -8692,7 +8390,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8707,7 +8405,7 @@
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8723,7 +8421,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8735,7 +8433,7 @@
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
@@ -8748,7 +8446,7 @@
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9010,7 +8708,7 @@
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9058,7 +8756,7 @@
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9111,7 +8809,7 @@
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9139,7 +8837,7 @@
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9194,7 +8892,7 @@
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9219,7 +8917,7 @@
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9247,7 +8945,7 @@
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
@@ -9355,22 +9053,6 @@
<c>true</c> if serialized compiler generated members; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreIsSpecifiedMembers">
<summary>
Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types.
@@ -9470,13 +9152,6 @@
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.
@@ -9937,13 +9612,6 @@
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
@@ -10050,23 +9718,6 @@
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonISerializableContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonISerializableContract.ISerializableCreator">
<summary>
Gets or sets the <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.
</summary>
<value>The <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonISerializableContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonLinqContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
@@ -10089,12 +9740,6 @@
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
@@ -10261,11 +9906,6 @@
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
@@ -10417,53 +10057,9 @@
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
<param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
@@ -10560,26 +10156,6 @@
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
@@ -10913,6 +10489,15 @@
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
<summary>
Determines whether the member is an indexed property.
</summary>
<param name="member">The member.</param>
<returns>
<c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
@@ -11030,43 +10615,5 @@
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <see cref="M:System.Reflection.Assembly.Load(System.Reflection.AssemblyName)"/> is used to load the assembly.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
packages/Newtonsoft.Json.12.0.3/.signature.p7s
Vendored
BIN
View File
Binary file not shown.
packages/Newtonsoft.Json.12.0.3/Newtonsoft.Json.12.0.3.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/Newtonsoft.Json.12.0.3/packageIcon.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 8.7 KiB

packages/PrettyBin.1.1.0/PrettyBin.1.1.0.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/PrettyBin.1.1.0/README.md
Vendored
+14
View File
@@ -0,0 +1,14 @@
PrettyBin
=========
Make bin folder of your project small, pretty and easy to maintain!
Moves dll,pdb and xml in bin/lib subfolder and ensures, that everything works.
Your bin folder will look like this:
/lib
app.exe
app.config
packages/PrettyBin.1.1.0/content/App.config.install.xdt
Vendored
+15
View File
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
<!--
<runtime xdt:Transform="InsertIfMissing">
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"
xdt:Transform="InsertIfMissing">
<probing xdt:Transform="InsertIfMissing"
privatePath="lib;libs" />
</assemblyBinding>
</runtime>
-->
</configuration>
packages/PrettyBin.1.1.0/license.txt
Vendored
+7
View File
@@ -0,0 +1,7 @@
Copyright (c) 2014, Ershov Andrey
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
packages/PrettyBin.1.1.0/makePackage.bat
Vendored
+2
View File
@@ -0,0 +1,2 @@
del PrettyBin.*.*.*.nupkg
nuget.exe pack PrettyBin.nuspec
packages/PrettyBin.1.1.0/tools/init.ps1
Vendored
+3
View File
@@ -0,0 +1,3 @@
param($installPath, $toolsPath, $package, $project)
Write-Host 'Init BinPrettify'
packages/PrettyBin.1.1.0/tools/install.ps1
Vendored
+156
View File
@@ -0,0 +1,156 @@
param($installPath, $toolsPath, $package, $project)
$path = $project.FullName
$appConfigItem = $project.ProjectItems | where {$_.Name -eq "App.config"}
if ($appConfigItem -eq $null)
{
throw [System.IO.FileNotFoundException] "Project $path does not have App.config. PrettyBin is for exetutable projects only. "
}
Write-Host 'Install PrettifyBin; '
[xml]$doc = [xml](Get-Content $path)
# If a Namespace URI was not given, use the Xml document's default namespace.
$NamespaceURI = $doc.DocumentElement.NamespaceURI
Write-Host $NamespaceURI
# In order for SelectSingleNode() to actually work, we need to use the fully qualified node path along with an Xml Namespace Manager, so set them up.
$xmlNsManager = New-Object System.Xml.XmlNamespaceManager($doc.NameTable)
$xmlNsManager.AddNamespace("ns", $NamespaceURI)
# ============ This script attemps to Create this tags in csproj: ========
#
# <Target Name="AfterBuild">
# <ItemGroup>
# <MoveToLibFolder Include="$(OutputPath)*.dll ; $(OutputPath)*.pdb ; $(OutputPath)*.xml" />
# </ItemGroup>
# <Move SourceFiles="@(MoveToLibFolder)" DestinationFolder="$(OutputPath)lib" OverwriteReadOnlyFiles="true" />
# </Target>
$targetNode = $doc.SelectSingleNode("//ns:Project/ns:Target[@Name='AfterBuild']", $xmlNsManager)
if ($targetNode -eq $null)
{
Write-Host 'No Target AfterBuild Node. Creating'
$targetNode = $doc.CreateElement('Target', $NamespaceURI )
$targetNode.SetAttribute("Name" ,"AfterBuild")
$doc.Project.AppendChild($targetNode)
}
$filesToMoveNode = $targetNode.SelectSingleNode("//ns:ItemGroup/ns:MoveToLibFolder", $xmlNsManager)
if ($filesToMoveNode -eq $null)
{
Write-Host 'No ItemGroup whith MoveToLibFolder tag. Creating'
$itemGroup = $doc.CreateElement('ItemGroup', $NamespaceURI)
$filesToMoveNode = $doc.CreateElement('MoveToLibFolder', $NamespaceURI)
$itemGroup.AppendChild($filesToMoveNode)
$targetNode.AppendChild($itemGroup)
}
$filesToMoveNode.SetAttribute("Include" ,'$(OutputPath)*.dll ; $(OutputPath)*.pdb ; $(OutputPath)*.xml')
$MoveNode = $targetNode.SelectSingleNode('//ns:Move[contains(@SourceFiles,"@(MoveToLibFolder)")]', $xmlNsManager)
if ($MoveNode -eq $null)
{
Write-Host 'No Move tag in AfterBuild Target. Creating'
$MoveNode = $doc.CreateElement('Move', $NamespaceURI)
$MoveNode.SetAttribute("SourceFiles" ,'@(MoveToLibFolder)')
$targetNode.AppendChild($MoveNode)
}
$MoveNode.SetAttribute("DestinationFolder",'$(OutputPath)lib')
$MoveNode.SetAttribute("OverwriteReadOnlyFiles","true")
$doc.Save($path)
# ============ This script attemps to Edit this tags in App.config: ========
#
# <configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
# <runtime>
# <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
# <probing privatePath="lib;libs" />
# </assemblyBinding>
# </runtime>
# </configuration>
Write-Host 'Edititing App.config'
# find the App.config file
$configItem = $project.ProjectItems | where {$_.Name -eq "App.config"}
# find its path on the file system
$configPath= $configItem.Properties | where {$_.Name -eq "LocalPath"}
# Get XML content of App.config
[xml]$app = [xml](Get-Content $configPath.Value)
# If a Namespace URI was not given, use the Xml document's default namespace.
$NamespaceAppURI = $app.DocumentElement.NamespaceURI
# In order for SelectSingleNode() to actually work, we need to use the fully qualified node path along with an Xml Namespace Manager, so set them up.
$xmlNsManager.AddNamespace("appns", $NamespaceAppURI)
# Adding of configuration section
$configurationNode = $app.SelectSingleNode("//appns:configuration", $xmlNsManager)
if ($configurationNode -eq $null)
{
Write-Host 'No Configuration Node. Creating'
# Для чего тут нужен NamespaceURI
$configurationNode = $app.CreateElement('Configuration', $NamespaceAppURI )
$configurationNode.SetAttribute("xmlns:xdt" ,"http://schemas.microsoft.com/XML-Document-Transform")
$app.AppendChild($configurationNode)
}
# Adding of runtime section
$runtimeNode = $configurationNode.SelectSingleNode("//appns:runtime", $xmlNsManager)
if ($runtimeNode -eq $null)
{
Write-Host 'No runtime Node. Creating'
$runtimeNode = $app.CreateElement('runtime', $NamespaceAppURI )
$configurationNode.AppendChild($runtimeNode)
}
# Adding of assemblyBinding section
Write-Host 'runtimeNode items'
$assemblyBindingNode = $null
foreach ($item in $runtimeNode.ChildNodes)
{
if ($item.Name -eq 'assemblyBinding')
{
$assemblyBindingNode = $item
break
}
}
#$assemblyBindingNode = $runtimeNode.SelectSingleNode("//appns:assemblyBinding", $xmlNsManager)
if ($assemblyBindingNode -eq $null)
{
Write-Host 'No assemblyBinding Node. Creating'
$assemblyBindingNode = $app.CreateElement('assemblyBinding', $NamespaceAppURI )
$runtimeNode.AppendChild($assemblyBindingNode)
}
$assemblyBindingNode.SetAttribute("xmlns" ,"urn:schemas-microsoft-com:asm.v1")
# Adding of probing section
$probingNode = $assemblyBindingNode.SelectSingleNode("//appns:probing", $xmlNsManager)
if ($probingNode -eq $null)
{
Write-Host 'No probing Node. Creating'
$probingNode = $app.CreateElement('probing', $NamespaceAppURI )
$assemblyBindingNode.AppendChild($probingNode)
}
$probingNode.SetAttribute("privatePath" ,"lib;libs")
$app.save($configPath.Value)
packages/PrettyBin.1.1.0/tools/uninstall.ps1
Vendored
+45
View File
@@ -0,0 +1,45 @@
param($installPath, $toolsPath, $package, $project)
Try
{
$path = $project.FullName
Write-Host 'Uninstall PrettifyBin; '
[ xml ]$doc = [ xml ](Get-Content $path)
# If a Namespace URI was not given, use the Xml document's default namespace.
$NamespaceURI = $doc.DocumentElement.NamespaceURI
Write-Host $NamespaceURI
# In order for SelectSingleNode() to actually work, we need to use the fully qualified node path along with an Xml Namespace Manager, so set them up.
$xmlNsManager = New-Object System.Xml.XmlNamespaceManager($doc.NameTable)
$xmlNsManager.AddNamespace("ns", $NamespaceURI)
# ============ This script attemps to remove this tags in csproj: ========
#
# <Target Name="AfterBuild">
# <Move SourceFiles="@(MoveToLibFolder)" DestinationFolder="$(OutputPath)lib" OverwriteReadOnlyFiles="true" />
# </Target>
$moveNode = $doc.SelectSingleNode("//ns:Project/ns:Target[@Name='AfterBuild']/ns:Move[contains(@SourceFiles,'@(MoveToLibFolder)')]", $xmlNsManager)
if ($moveNode -ne $null)
{
Write-Host 'We will delete move node'
$moveNode.ParentNode.RemoveChild($moveNode)
}
$doc.Save($path)
}
Catch
{
$ErrorMessage = $_.Exception.Message
$FailedItem = $_.Exception.ItemName
Write-Host $ErrorMessage
Write-Host $FailedItem
Break
}
packages/S7netplus.0.4.0/.signature.p7s → packages/S7netplus.0.1.9/.signature.p7s
Vendored
BIN
View File
Binary file not shown.
packages/S7netplus.0.1.9/S7netplus.0.1.9.nupkg
Vendored
BIN
View File
Binary file not shown.
packages/S7netplus.0.1.9/lib/net35/S7.Net.xml
Vendored
+991
View File
@@ -0,0 +1,991 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>S7.Net</name>
</assembly>
<members>
<member name="T:S7.Net.Conversion">
<summary>
Conversion methods to convert from Siemens numeric format to C# and back
</summary>
</member>
<member name="M:S7.Net.Conversion.BinStringToInt32(System.String)">
<summary>
Converts a binary string to Int32 value
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.BinStringToByte(System.String)">
<summary>
Converts a binary string to a byte. Can return null.
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ValToBinString(System.Object)">
<summary>
Converts the value to a binary string
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.SelectBit(System.Byte,System.Int32)">
<summary>
Helper to get a bit value given a byte and the bit index.
Example: DB1.DBX0.5 -> var bytes = ReadBytes(DB1.DBW0); bool bit = bytes[0].SelectBit(5);
</summary>
<param name="data"></param>
<param name="bitPosition"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToShort(System.UInt16)">
<summary>
Converts from ushort value to short value; it's used to retrieve negative values from words
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUshort(System.Int16)">
<summary>
Converts from short value to ushort value; it's used to pass negative values to DWs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToInt(System.UInt32)">
<summary>
Converts from UInt32 value to Int32 value; it's used to retrieve negative values from DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Int32)">
<summary>
Converts from Int32 value to UInt32 value; it's used to pass negative values to DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Double)">
<summary>
Converts from double to DWord (DBD)
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToDouble(System.UInt32)">
<summary>
Converts from DWord (DBD) to double
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="T:S7.Net.COTP">
<summary>
COTP Protocol functions and types
</summary>
</member>
<member name="T:S7.Net.COTP.TPDU">
<summary>
Describes a COTP TPDU (Transport protocol data unit)
</summary>
</member>
<member name="M:S7.Net.COTP.TPDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads COTP TPDU (Transport protocol data unit) from the network stream
See: https://tools.ietf.org/html/rfc905
</summary>
<param name="socket">The socket to read from</param>
<returns>COTP DPDU instance</returns>
</member>
<member name="T:S7.Net.COTP.TSDU">
<summary>
Describes a COTP TSDU (Transport service data unit). One TSDU consist of 1 ore more TPDUs
</summary>
</member>
<member name="M:S7.Net.COTP.TSDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads the full COTP TSDU (Transport service data unit)
See: https://tools.ietf.org/html/rfc905
</summary>
<returns>Data in TSDU</returns>
</member>
<member name="T:S7.Net.CpuType">
<summary>
Types of S7 cpu supported by the library
</summary>
</member>
<member name="F:S7.Net.CpuType.S7200">
<summary>
S7 200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7300">
<summary>
S7 300 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7400">
<summary>
S7 400 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71200">
<summary>
S7 1200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71500">
<summary>
S7 1500 cpu type
</summary>
</member>
<member name="T:S7.Net.ErrorCode">
<summary>
Types of error code that can be set after a function is called
</summary>
</member>
<member name="F:S7.Net.ErrorCode.NoError">
<summary>
The function has been executed correctly
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongCPU_Type">
<summary>
Wrong type of CPU error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ConnectionError">
<summary>
Connection error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.IPAddressNotAvailable">
<summary>
Ip address not available
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongVarFormat">
<summary>
Wrong format of the variable
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongNumberReceivedBytes">
<summary>
Wrong number of received bytes
</summary>
</member>
<member name="F:S7.Net.ErrorCode.SendData">
<summary>
Error on send data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ReadData">
<summary>
Error on read data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WriteData">
<summary>
Error on write data
</summary>
</member>
<member name="T:S7.Net.DataType">
<summary>
Types of memory area that can be read
</summary>
</member>
<member name="F:S7.Net.DataType.Input">
<summary>
Input area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Output">
<summary>
Output area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Memory">
<summary>
Merkers area memory (M0, M0.0, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.DataBlock">
<summary>
DB area memory (DB1, DB2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Timer">
<summary>
Timer area memory(T1, T2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Counter">
<summary>
Counter area memory (C1, C2, ...)
</summary>
</member>
<member name="T:S7.Net.VarType">
<summary>
Types
</summary>
</member>
<member name="F:S7.Net.VarType.Bit">
<summary>
S7 Bit variable type (bool)
</summary>
</member>
<member name="F:S7.Net.VarType.Byte">
<summary>
S7 Byte variable type (8 bits)
</summary>
</member>
<member name="F:S7.Net.VarType.Word">
<summary>
S7 Word variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DWord">
<summary>
S7 DWord variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Int">
<summary>
S7 Int variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DInt">
<summary>
DInt variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Real">
<summary>
Real variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.String">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.StringEx">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.Timer">
<summary>
Timer variable type
</summary>
</member>
<member name="F:S7.Net.VarType.Counter">
<summary>
Counter variable type
</summary>
</member>
<member name="T:S7.Net.Plc">
<summary>
Creates an instance of S7.Net driver
</summary>
</member>
<member name="P:S7.Net.Plc.IP">
<summary>
IP address of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.CPU">
<summary>
CPU type of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Rack">
<summary>
Rack of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Slot">
<summary>
Slot of the CPU of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.MaxPDUSize">
<summary>
Max PDU size this cpu supports
</summary>
</member>
<member name="P:S7.Net.Plc.IsAvailable">
<summary>
Returns true if a connection to the PLC can be established
</summary>
</member>
<member name="P:S7.Net.Plc.IsConnected">
<summary>
Checks if the socket is connected and polls the other peer (the PLC) to see if it's connected.
This is the variable that you should continously check to see if the communication is working
See also: http://stackoverflow.com/questions/2661764/how-to-check-if-a-socket-is-connected-disconnected-in-c
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorString">
<summary>
Contains the last error registered when executing a function
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorCode">
<summary>
Contains the last error code registered when executing a function
</summary>
</member>
<member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int16,System.Int16)">
<summary>
Creates a PLC object with all the parameters needed for connections.
For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
You need slot > 0 if you are connecting to external ethernet card (CP).
For S7-300 and S7-400 the default is rack = 0 and slot = 2.
</summary>
<param name="cpu">CpuType of the PLC (select from the enum)</param>
<param name="ip">Ip address of the PLC</param>
<param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
<param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
If you use an external ethernet card, this must be set accordingly.</param>
</member>
<member name="M:S7.Net.Plc.Open">
<summary>
Open a <see cref="T:System.Net.Sockets.Socket"/> and connects to the PLC, sending all the corrected package
and returning if the connection was successful (<see cref="F:S7.Net.ErrorCode.NoError"/>) of it was wrong.
</summary>
<returns>Returns ErrorCode.NoError if the connection was successful, otherwise check the ErrorCode</returns>
</member>
<member name="M:S7.Net.Plc.Close">
<summary>
Disonnects from the PLC and close the socket
</summary>
</member>
<member name="M:S7.Net.Plc.ReadMultipleVars(System.Collections.Generic.List{S7.Net.Types.DataItem})">
<summary>
Reads multiple vars in a single request.
You have to create and pass a list of DataItems and you obtain in response the same list with the values.
Values are stored in the property "Value" of the dataItem and are already converted.
If you don't want the conversion, just create a dataItem of bytes.
DataItems must not be more than 20 (protocol restriction) and bytes must not be more than 200 + 22 of header (protocol restriction).
</summary>
<param name="dataItems">List of dataitems that contains the list of variables that must be read. Maximum 20 dataitems are accepted.</param>
</member>
<member name="M:S7.Net.Plc.ReadBytes(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
<returns>Returns the bytes in an array</returns>
</member>
<member name="M:S7.Net.Plc.Read(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte)">
<summary>
Read and decode a certain number of bytes of the "VarType" provided.
This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="varType">Type of the variable/s that you are reading</param>
<param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
<param name="varCount"></param>
</member>
<member name="M:S7.Net.Plc.Read(System.String)">
<summary>
Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct(System.Type,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
</summary>
<param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a struct that must be cast.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
</summary>
<typeparam name="T">The struct type</typeparam>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass(System.Object,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<param name="sourceClass">Instance of the class that will store the values</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>The number of read bytes</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
type, the class needs a default constructor.
</summary>
<typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Func{``0},System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<typeparam name="T">The class that will be instantiated</typeparam>
<param name="classFactory">Function to instantiate the class</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32)">
<summary>
Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
You must specify the memory area type, memory are address, byte start address and bytes count.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(System.String,System.Object)">
<summary>
Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the write was not successful, check <see cref="P:S7.Net.Plc.LastErrorCode"/> or <see cref="P:S7.Net.Plc.LastErrorString"/>.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<param name="value">Value to be written to the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteStruct(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# struct to a DB in the PLC
</summary>
<param name="structValue">The struct to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteClass(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# class to a DB in the PLC
</summary>
<param name="classValue">The class to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ClearLastError">
<summary>
Sets the <see cref="P:S7.Net.Plc.LastErrorCode"/> to <see cref="F:S7.Net.ErrorCode.NoError"/> and <see cref="P:S7.Net.Plc.LastErrorString"/> to <see cref="F:System.String.Empty"/>.
</summary>
</member>
<member name="M:S7.Net.Plc.ReadHeaderPackage(System.Int32)">
<summary>
Creates the header to read bytes from the PLC
</summary>
<param name="amount"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.CreateReadDataRequestPackage(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType),
the address of the memory, the address of the byte and the bytes count.
</summary>
<param name="dataType">MemoryType (DB, Timer, Counter, etc.)</param>
<param name="db">Address of the memory to be read</param>
<param name="startByteAdr">Start address of the byte</param>
<param name="count">Number of bytes to be read</param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.WriteBytesWithASingleRequest(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Writes up to 200 bytes to the PLC and returns NoError if successful. You must specify the memory area type, memory are address, byte start address and bytes count.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ParseBytes(S7.Net.VarType,System.Byte[],System.Int32,System.Byte)">
<summary>
Given a S7 variable type (Bool, Word, DWord, etc.), it converts the bytes in the appropriate C# format.
</summary>
<param name="varType"></param>
<param name="bytes"></param>
<param name="varCount"></param>
<param name="bitAdr"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.VarTypeToByteLength(S7.Net.VarType,System.Int32)">
<summary>
Given a S7 <see cref="T:S7.Net.VarType"/> (Bool, Word, DWord, etc.), it returns how many bytes to read.
</summary>
<param name="varType"></param>
<param name="varCount"></param>
<returns>Byte lenght of variable</returns>
</member>
<member name="M:S7.Net.Plc.Dispose(System.Boolean)">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="M:S7.Net.Plc.Dispose">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="T:S7.Net.TPKT">
<summary>
Describes a TPKT Packet
</summary>
</member>
<member name="M:S7.Net.TPKT.Read(System.Net.Sockets.Socket)">
<summary>
Reds a TPKT from the socket
</summary>
<param name="socket">The socket to read from</param>
<returns>TPKT Instace</returns>
</member>
<member name="T:S7.Net.Types.Bit">
<summary>
Contains the conversion methods to convert Bit from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Bit.FromByte(System.Byte,System.Byte)">
<summary>
Converts a Bit to bool
</summary>
</member>
<member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[])">
<summary>
Converts an array of bytes to a BitArray
</summary>
</member>
<member name="T:S7.Net.Types.Boolean">
<summary>
Contains the methods to read, set and reset bits inside bytes
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.GetValue(System.Byte,System.Int32)">
<summary>
Returns the value of a bit in a bit, given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.SetBit(System.Byte,System.Int32)">
<summary>
Sets the value of a bit to 1 (true), given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte,System.Int32)">
<summary>
Resets the value of a bit to 0 (false), given the address of the bit
</summary>
</member>
<member name="T:S7.Net.Types.Byte">
<summary>
Contains the methods to convert from bytes to byte arrays
</summary>
</member>
<member name="M:S7.Net.Types.Byte.ToByteArray(System.Byte)">
<summary>
Converts a byte to byte array
</summary>
</member>
<member name="M:S7.Net.Types.Byte.FromByteArray(System.Byte[])">
<summary>
Converts a byte array to byte
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Class">
<summary>
Contains the methods to convert a C# class to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Class.GetClassSize(System.Object)">
<summary>
Gets the size of the class in bytes.
</summary>
<param name="instance">An instance of the class</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Class.FromBytes(System.Object,System.Byte[])">
<summary>
Sets the object's values with the given array of bytes
</summary>
<param name="sourceClass">The object to fill in the given array of bytes</param>
<param name="bytes">The array of bytes</param>
</member>
<member name="M:S7.Net.Types.Class.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="sourceClass">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Counter">
<summary>
Contains the conversion methods to convert Counter from S7 plc to C# ushort (UInt16).
</summary>
</member>
<member name="M:S7.Net.Types.Counter.FromByteArray(System.Byte[])">
<summary>
Converts a Counter (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
<member name="T:S7.Net.Types.DataItem">
<summary>
Create an instance of a memory block that can be read by using ReadMultipleVars
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DataType">
<summary>
Memory area to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.VarType">
<summary>
Type of data to be read (default is bytes)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DB">
<summary>
Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.StartByteAdr">
<summary>
Address of the first byte to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.BitAdr">
<summary>
Addess of bit to read from StartByteAdr
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Count">
<summary>
Number of variables to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Value">
<summary>
Contains the value of the memory area after the read has been executed
</summary>
</member>
<member name="M:S7.Net.Types.DataItem.#ctor">
<summary>
Create an instance of DataItem
</summary>
</member>
<member name="T:S7.Net.Types.DInt">
<summary>
Contains the conversion methods to convert DInt from S7 plc to C# int (Int32).
</summary>
</member>
<member name="M:S7.Net.Types.DInt.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DInt (4 bytes) to int (Int32)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32)">
<summary>
Converts a int (Int32) to S7 DInt (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32[])">
<summary>
Converts an array of int (Int32) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DInt to an array of int (Int32)
</summary>
</member>
<member name="T:S7.Net.Types.Double">
<summary>
Contains the conversion methods to convert Real from S7 plc to C# double.
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Real (4 bytes) to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.Int32)">
<summary>
Converts a S7 DInt to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.UInt32)">
<summary>
Converts a S7 DWord to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double)">
<summary>
Converts a double to S7 Real (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double[])">
<summary>
Converts an array of double to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Real to an array of double
</summary>
</member>
<member name="T:S7.Net.Types.DWord">
<summary>
Contains the conversion methods to convert DWord from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DWord (4 bytes) to uint (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromBytes(System.Byte,System.Byte,System.Byte,System.Byte)">
<summary>
Converts 4 bytes to DWord (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32)">
<summary>
Converts a uint (UInt32) to S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32[])">
<summary>
Converts an array of uint (UInt32) to an array of S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DWord to an array of uint (UInt32)
</summary>
</member>
<member name="T:S7.Net.Types.Int">
<summary>
Contains the conversion methods to convert Int from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Int.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Int (2 bytes) to short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16)">
<summary>
Converts a short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16[])">
<summary>
Converts an array of short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Int to an array of short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.CWord(System.Int32)">
<summary>
Converts a C# int value to a C# short value, to be used as word.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.StringEx">
<summary>
Contains the methods to convert from S7 strings to C# strings
there are two kinds how strings a send. This one is with a pre of two bytes
they contain the length of the string
</summary>
</member>
<member name="M:S7.Net.Types.StringEx.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.String">
<summary>
Contains the methods to convert from S7 strings to C# strings
</summary>
</member>
<member name="M:S7.Net.Types.String.ToByteArray(System.String)">
<summary>
Converts a string to S7 bytes
</summary>
</member>
<member name="M:S7.Net.Types.String.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Struct">
<summary>
Contains the method to convert a C# struct to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Struct.GetStructSize(System.Type)">
<summary>
Gets the size of the struct in bytes.
</summary>
<param name="structType">the type of the struct</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Struct.FromBytes(System.Type,System.Byte[])">
<summary>
Creates a struct of a specified type by an array of bytes.
</summary>
<param name="structType">The struct type</param>
<param name="bytes">The array of bytes</param>
<returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
</member>
<member name="M:S7.Net.Types.Struct.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="structValue">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Timer">
<summary>
Converts the Timer data type to C# data type
</summary>
</member>
<member name="M:S7.Net.Types.Timer.FromByteArray(System.Byte[])">
<summary>
Converts the timer bytes to a double
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushorts (Uint16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToArray(System.Byte[])">
<summary>
Converts an array of bytes formatted as time to an array of doubles
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Word">
<summary>
Contains the conversion methods to convert Words from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromByteArray(System.Byte[])">
<summary>
Converts a word (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromBytes(System.Byte,System.Byte)">
<summary>
Converts 2 bytes to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
</members>
</doc>
packages/S7netplus.0.1.9/lib/net40/S7.Net.xml
Vendored
+991
View File
@@ -0,0 +1,991 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>S7.Net</name>
</assembly>
<members>
<member name="T:S7.Net.Conversion">
<summary>
Conversion methods to convert from Siemens numeric format to C# and back
</summary>
</member>
<member name="M:S7.Net.Conversion.BinStringToInt32(System.String)">
<summary>
Converts a binary string to Int32 value
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.BinStringToByte(System.String)">
<summary>
Converts a binary string to a byte. Can return null.
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ValToBinString(System.Object)">
<summary>
Converts the value to a binary string
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.SelectBit(System.Byte,System.Int32)">
<summary>
Helper to get a bit value given a byte and the bit index.
Example: DB1.DBX0.5 -> var bytes = ReadBytes(DB1.DBW0); bool bit = bytes[0].SelectBit(5);
</summary>
<param name="data"></param>
<param name="bitPosition"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToShort(System.UInt16)">
<summary>
Converts from ushort value to short value; it's used to retrieve negative values from words
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUshort(System.Int16)">
<summary>
Converts from short value to ushort value; it's used to pass negative values to DWs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToInt(System.UInt32)">
<summary>
Converts from UInt32 value to Int32 value; it's used to retrieve negative values from DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Int32)">
<summary>
Converts from Int32 value to UInt32 value; it's used to pass negative values to DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Double)">
<summary>
Converts from double to DWord (DBD)
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToDouble(System.UInt32)">
<summary>
Converts from DWord (DBD) to double
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="T:S7.Net.COTP">
<summary>
COTP Protocol functions and types
</summary>
</member>
<member name="T:S7.Net.COTP.TPDU">
<summary>
Describes a COTP TPDU (Transport protocol data unit)
</summary>
</member>
<member name="M:S7.Net.COTP.TPDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads COTP TPDU (Transport protocol data unit) from the network stream
See: https://tools.ietf.org/html/rfc905
</summary>
<param name="socket">The socket to read from</param>
<returns>COTP DPDU instance</returns>
</member>
<member name="T:S7.Net.COTP.TSDU">
<summary>
Describes a COTP TSDU (Transport service data unit). One TSDU consist of 1 ore more TPDUs
</summary>
</member>
<member name="M:S7.Net.COTP.TSDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads the full COTP TSDU (Transport service data unit)
See: https://tools.ietf.org/html/rfc905
</summary>
<returns>Data in TSDU</returns>
</member>
<member name="T:S7.Net.CpuType">
<summary>
Types of S7 cpu supported by the library
</summary>
</member>
<member name="F:S7.Net.CpuType.S7200">
<summary>
S7 200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7300">
<summary>
S7 300 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7400">
<summary>
S7 400 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71200">
<summary>
S7 1200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71500">
<summary>
S7 1500 cpu type
</summary>
</member>
<member name="T:S7.Net.ErrorCode">
<summary>
Types of error code that can be set after a function is called
</summary>
</member>
<member name="F:S7.Net.ErrorCode.NoError">
<summary>
The function has been executed correctly
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongCPU_Type">
<summary>
Wrong type of CPU error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ConnectionError">
<summary>
Connection error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.IPAddressNotAvailable">
<summary>
Ip address not available
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongVarFormat">
<summary>
Wrong format of the variable
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongNumberReceivedBytes">
<summary>
Wrong number of received bytes
</summary>
</member>
<member name="F:S7.Net.ErrorCode.SendData">
<summary>
Error on send data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ReadData">
<summary>
Error on read data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WriteData">
<summary>
Error on write data
</summary>
</member>
<member name="T:S7.Net.DataType">
<summary>
Types of memory area that can be read
</summary>
</member>
<member name="F:S7.Net.DataType.Input">
<summary>
Input area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Output">
<summary>
Output area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Memory">
<summary>
Merkers area memory (M0, M0.0, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.DataBlock">
<summary>
DB area memory (DB1, DB2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Timer">
<summary>
Timer area memory(T1, T2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Counter">
<summary>
Counter area memory (C1, C2, ...)
</summary>
</member>
<member name="T:S7.Net.VarType">
<summary>
Types
</summary>
</member>
<member name="F:S7.Net.VarType.Bit">
<summary>
S7 Bit variable type (bool)
</summary>
</member>
<member name="F:S7.Net.VarType.Byte">
<summary>
S7 Byte variable type (8 bits)
</summary>
</member>
<member name="F:S7.Net.VarType.Word">
<summary>
S7 Word variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DWord">
<summary>
S7 DWord variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Int">
<summary>
S7 Int variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DInt">
<summary>
DInt variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Real">
<summary>
Real variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.String">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.StringEx">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.Timer">
<summary>
Timer variable type
</summary>
</member>
<member name="F:S7.Net.VarType.Counter">
<summary>
Counter variable type
</summary>
</member>
<member name="T:S7.Net.Plc">
<summary>
Creates an instance of S7.Net driver
</summary>
</member>
<member name="P:S7.Net.Plc.IP">
<summary>
IP address of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.CPU">
<summary>
CPU type of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Rack">
<summary>
Rack of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Slot">
<summary>
Slot of the CPU of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.MaxPDUSize">
<summary>
Max PDU size this cpu supports
</summary>
</member>
<member name="P:S7.Net.Plc.IsAvailable">
<summary>
Returns true if a connection to the PLC can be established
</summary>
</member>
<member name="P:S7.Net.Plc.IsConnected">
<summary>
Checks if the socket is connected and polls the other peer (the PLC) to see if it's connected.
This is the variable that you should continously check to see if the communication is working
See also: http://stackoverflow.com/questions/2661764/how-to-check-if-a-socket-is-connected-disconnected-in-c
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorString">
<summary>
Contains the last error registered when executing a function
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorCode">
<summary>
Contains the last error code registered when executing a function
</summary>
</member>
<member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int16,System.Int16)">
<summary>
Creates a PLC object with all the parameters needed for connections.
For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
You need slot > 0 if you are connecting to external ethernet card (CP).
For S7-300 and S7-400 the default is rack = 0 and slot = 2.
</summary>
<param name="cpu">CpuType of the PLC (select from the enum)</param>
<param name="ip">Ip address of the PLC</param>
<param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
<param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
If you use an external ethernet card, this must be set accordingly.</param>
</member>
<member name="M:S7.Net.Plc.Open">
<summary>
Open a <see cref="T:System.Net.Sockets.Socket"/> and connects to the PLC, sending all the corrected package
and returning if the connection was successful (<see cref="F:S7.Net.ErrorCode.NoError"/>) of it was wrong.
</summary>
<returns>Returns ErrorCode.NoError if the connection was successful, otherwise check the ErrorCode</returns>
</member>
<member name="M:S7.Net.Plc.Close">
<summary>
Disonnects from the PLC and close the socket
</summary>
</member>
<member name="M:S7.Net.Plc.ReadMultipleVars(System.Collections.Generic.List{S7.Net.Types.DataItem})">
<summary>
Reads multiple vars in a single request.
You have to create and pass a list of DataItems and you obtain in response the same list with the values.
Values are stored in the property "Value" of the dataItem and are already converted.
If you don't want the conversion, just create a dataItem of bytes.
DataItems must not be more than 20 (protocol restriction) and bytes must not be more than 200 + 22 of header (protocol restriction).
</summary>
<param name="dataItems">List of dataitems that contains the list of variables that must be read. Maximum 20 dataitems are accepted.</param>
</member>
<member name="M:S7.Net.Plc.ReadBytes(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
<returns>Returns the bytes in an array</returns>
</member>
<member name="M:S7.Net.Plc.Read(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte)">
<summary>
Read and decode a certain number of bytes of the "VarType" provided.
This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="varType">Type of the variable/s that you are reading</param>
<param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
<param name="varCount"></param>
</member>
<member name="M:S7.Net.Plc.Read(System.String)">
<summary>
Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct(System.Type,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
</summary>
<param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a struct that must be cast.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
</summary>
<typeparam name="T">The struct type</typeparam>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass(System.Object,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<param name="sourceClass">Instance of the class that will store the values</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>The number of read bytes</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
type, the class needs a default constructor.
</summary>
<typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Func{``0},System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<typeparam name="T">The class that will be instantiated</typeparam>
<param name="classFactory">Function to instantiate the class</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32)">
<summary>
Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
You must specify the memory area type, memory are address, byte start address and bytes count.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(System.String,System.Object)">
<summary>
Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the write was not successful, check <see cref="P:S7.Net.Plc.LastErrorCode"/> or <see cref="P:S7.Net.Plc.LastErrorString"/>.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<param name="value">Value to be written to the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteStruct(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# struct to a DB in the PLC
</summary>
<param name="structValue">The struct to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteClass(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# class to a DB in the PLC
</summary>
<param name="classValue">The class to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ClearLastError">
<summary>
Sets the <see cref="P:S7.Net.Plc.LastErrorCode"/> to <see cref="F:S7.Net.ErrorCode.NoError"/> and <see cref="P:S7.Net.Plc.LastErrorString"/> to <see cref="F:System.String.Empty"/>.
</summary>
</member>
<member name="M:S7.Net.Plc.ReadHeaderPackage(System.Int32)">
<summary>
Creates the header to read bytes from the PLC
</summary>
<param name="amount"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.CreateReadDataRequestPackage(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType),
the address of the memory, the address of the byte and the bytes count.
</summary>
<param name="dataType">MemoryType (DB, Timer, Counter, etc.)</param>
<param name="db">Address of the memory to be read</param>
<param name="startByteAdr">Start address of the byte</param>
<param name="count">Number of bytes to be read</param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.WriteBytesWithASingleRequest(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Writes up to 200 bytes to the PLC and returns NoError if successful. You must specify the memory area type, memory are address, byte start address and bytes count.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ParseBytes(S7.Net.VarType,System.Byte[],System.Int32,System.Byte)">
<summary>
Given a S7 variable type (Bool, Word, DWord, etc.), it converts the bytes in the appropriate C# format.
</summary>
<param name="varType"></param>
<param name="bytes"></param>
<param name="varCount"></param>
<param name="bitAdr"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.VarTypeToByteLength(S7.Net.VarType,System.Int32)">
<summary>
Given a S7 <see cref="T:S7.Net.VarType"/> (Bool, Word, DWord, etc.), it returns how many bytes to read.
</summary>
<param name="varType"></param>
<param name="varCount"></param>
<returns>Byte lenght of variable</returns>
</member>
<member name="M:S7.Net.Plc.Dispose(System.Boolean)">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="M:S7.Net.Plc.Dispose">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="T:S7.Net.TPKT">
<summary>
Describes a TPKT Packet
</summary>
</member>
<member name="M:S7.Net.TPKT.Read(System.Net.Sockets.Socket)">
<summary>
Reds a TPKT from the socket
</summary>
<param name="socket">The socket to read from</param>
<returns>TPKT Instace</returns>
</member>
<member name="T:S7.Net.Types.Bit">
<summary>
Contains the conversion methods to convert Bit from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Bit.FromByte(System.Byte,System.Byte)">
<summary>
Converts a Bit to bool
</summary>
</member>
<member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[])">
<summary>
Converts an array of bytes to a BitArray
</summary>
</member>
<member name="T:S7.Net.Types.Boolean">
<summary>
Contains the methods to read, set and reset bits inside bytes
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.GetValue(System.Byte,System.Int32)">
<summary>
Returns the value of a bit in a bit, given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.SetBit(System.Byte,System.Int32)">
<summary>
Sets the value of a bit to 1 (true), given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte,System.Int32)">
<summary>
Resets the value of a bit to 0 (false), given the address of the bit
</summary>
</member>
<member name="T:S7.Net.Types.Byte">
<summary>
Contains the methods to convert from bytes to byte arrays
</summary>
</member>
<member name="M:S7.Net.Types.Byte.ToByteArray(System.Byte)">
<summary>
Converts a byte to byte array
</summary>
</member>
<member name="M:S7.Net.Types.Byte.FromByteArray(System.Byte[])">
<summary>
Converts a byte array to byte
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Class">
<summary>
Contains the methods to convert a C# class to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Class.GetClassSize(System.Object)">
<summary>
Gets the size of the class in bytes.
</summary>
<param name="instance">An instance of the class</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Class.FromBytes(System.Object,System.Byte[])">
<summary>
Sets the object's values with the given array of bytes
</summary>
<param name="sourceClass">The object to fill in the given array of bytes</param>
<param name="bytes">The array of bytes</param>
</member>
<member name="M:S7.Net.Types.Class.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="sourceClass">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Counter">
<summary>
Contains the conversion methods to convert Counter from S7 plc to C# ushort (UInt16).
</summary>
</member>
<member name="M:S7.Net.Types.Counter.FromByteArray(System.Byte[])">
<summary>
Converts a Counter (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
<member name="T:S7.Net.Types.DataItem">
<summary>
Create an instance of a memory block that can be read by using ReadMultipleVars
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DataType">
<summary>
Memory area to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.VarType">
<summary>
Type of data to be read (default is bytes)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DB">
<summary>
Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.StartByteAdr">
<summary>
Address of the first byte to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.BitAdr">
<summary>
Addess of bit to read from StartByteAdr
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Count">
<summary>
Number of variables to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Value">
<summary>
Contains the value of the memory area after the read has been executed
</summary>
</member>
<member name="M:S7.Net.Types.DataItem.#ctor">
<summary>
Create an instance of DataItem
</summary>
</member>
<member name="T:S7.Net.Types.DInt">
<summary>
Contains the conversion methods to convert DInt from S7 plc to C# int (Int32).
</summary>
</member>
<member name="M:S7.Net.Types.DInt.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DInt (4 bytes) to int (Int32)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32)">
<summary>
Converts a int (Int32) to S7 DInt (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32[])">
<summary>
Converts an array of int (Int32) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DInt to an array of int (Int32)
</summary>
</member>
<member name="T:S7.Net.Types.Double">
<summary>
Contains the conversion methods to convert Real from S7 plc to C# double.
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Real (4 bytes) to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.Int32)">
<summary>
Converts a S7 DInt to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.UInt32)">
<summary>
Converts a S7 DWord to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double)">
<summary>
Converts a double to S7 Real (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double[])">
<summary>
Converts an array of double to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Real to an array of double
</summary>
</member>
<member name="T:S7.Net.Types.DWord">
<summary>
Contains the conversion methods to convert DWord from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DWord (4 bytes) to uint (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromBytes(System.Byte,System.Byte,System.Byte,System.Byte)">
<summary>
Converts 4 bytes to DWord (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32)">
<summary>
Converts a uint (UInt32) to S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32[])">
<summary>
Converts an array of uint (UInt32) to an array of S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DWord to an array of uint (UInt32)
</summary>
</member>
<member name="T:S7.Net.Types.Int">
<summary>
Contains the conversion methods to convert Int from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Int.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Int (2 bytes) to short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16)">
<summary>
Converts a short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16[])">
<summary>
Converts an array of short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Int to an array of short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.CWord(System.Int32)">
<summary>
Converts a C# int value to a C# short value, to be used as word.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.StringEx">
<summary>
Contains the methods to convert from S7 strings to C# strings
there are two kinds how strings a send. This one is with a pre of two bytes
they contain the length of the string
</summary>
</member>
<member name="M:S7.Net.Types.StringEx.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.String">
<summary>
Contains the methods to convert from S7 strings to C# strings
</summary>
</member>
<member name="M:S7.Net.Types.String.ToByteArray(System.String)">
<summary>
Converts a string to S7 bytes
</summary>
</member>
<member name="M:S7.Net.Types.String.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Struct">
<summary>
Contains the method to convert a C# struct to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Struct.GetStructSize(System.Type)">
<summary>
Gets the size of the struct in bytes.
</summary>
<param name="structType">the type of the struct</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Struct.FromBytes(System.Type,System.Byte[])">
<summary>
Creates a struct of a specified type by an array of bytes.
</summary>
<param name="structType">The struct type</param>
<param name="bytes">The array of bytes</param>
<returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
</member>
<member name="M:S7.Net.Types.Struct.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="structValue">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Timer">
<summary>
Converts the Timer data type to C# data type
</summary>
</member>
<member name="M:S7.Net.Types.Timer.FromByteArray(System.Byte[])">
<summary>
Converts the timer bytes to a double
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushorts (Uint16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToArray(System.Byte[])">
<summary>
Converts an array of bytes formatted as time to an array of doubles
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Word">
<summary>
Contains the conversion methods to convert Words from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromByteArray(System.Byte[])">
<summary>
Converts a word (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromBytes(System.Byte,System.Byte)">
<summary>
Converts 2 bytes to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
</members>
</doc>
packages/S7netplus.0.1.9/lib/net45/S7.Net.xml
Vendored
+991
View File
@@ -0,0 +1,991 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>S7.Net</name>
</assembly>
<members>
<member name="T:S7.Net.Conversion">
<summary>
Conversion methods to convert from Siemens numeric format to C# and back
</summary>
</member>
<member name="M:S7.Net.Conversion.BinStringToInt32(System.String)">
<summary>
Converts a binary string to Int32 value
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.BinStringToByte(System.String)">
<summary>
Converts a binary string to a byte. Can return null.
</summary>
<param name="txt"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ValToBinString(System.Object)">
<summary>
Converts the value to a binary string
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.SelectBit(System.Byte,System.Int32)">
<summary>
Helper to get a bit value given a byte and the bit index.
Example: DB1.DBX0.5 -> var bytes = ReadBytes(DB1.DBW0); bool bit = bytes[0].SelectBit(5);
</summary>
<param name="data"></param>
<param name="bitPosition"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToShort(System.UInt16)">
<summary>
Converts from ushort value to short value; it's used to retrieve negative values from words
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUshort(System.Int16)">
<summary>
Converts from short value to ushort value; it's used to pass negative values to DWs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToInt(System.UInt32)">
<summary>
Converts from UInt32 value to Int32 value; it's used to retrieve negative values from DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Int32)">
<summary>
Converts from Int32 value to UInt32 value; it's used to pass negative values to DBDs
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToUInt(System.Double)">
<summary>
Converts from double to DWord (DBD)
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Conversion.ConvertToDouble(System.UInt32)">
<summary>
Converts from DWord (DBD) to double
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="T:S7.Net.COTP">
<summary>
COTP Protocol functions and types
</summary>
</member>
<member name="T:S7.Net.COTP.TPDU">
<summary>
Describes a COTP TPDU (Transport protocol data unit)
</summary>
</member>
<member name="M:S7.Net.COTP.TPDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads COTP TPDU (Transport protocol data unit) from the network stream
See: https://tools.ietf.org/html/rfc905
</summary>
<param name="socket">The socket to read from</param>
<returns>COTP DPDU instance</returns>
</member>
<member name="T:S7.Net.COTP.TSDU">
<summary>
Describes a COTP TSDU (Transport service data unit). One TSDU consist of 1 ore more TPDUs
</summary>
</member>
<member name="M:S7.Net.COTP.TSDU.Read(System.Net.Sockets.Socket)">
<summary>
Reads the full COTP TSDU (Transport service data unit)
See: https://tools.ietf.org/html/rfc905
</summary>
<returns>Data in TSDU</returns>
</member>
<member name="T:S7.Net.CpuType">
<summary>
Types of S7 cpu supported by the library
</summary>
</member>
<member name="F:S7.Net.CpuType.S7200">
<summary>
S7 200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7300">
<summary>
S7 300 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S7400">
<summary>
S7 400 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71200">
<summary>
S7 1200 cpu type
</summary>
</member>
<member name="F:S7.Net.CpuType.S71500">
<summary>
S7 1500 cpu type
</summary>
</member>
<member name="T:S7.Net.ErrorCode">
<summary>
Types of error code that can be set after a function is called
</summary>
</member>
<member name="F:S7.Net.ErrorCode.NoError">
<summary>
The function has been executed correctly
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongCPU_Type">
<summary>
Wrong type of CPU error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ConnectionError">
<summary>
Connection error
</summary>
</member>
<member name="F:S7.Net.ErrorCode.IPAddressNotAvailable">
<summary>
Ip address not available
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongVarFormat">
<summary>
Wrong format of the variable
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WrongNumberReceivedBytes">
<summary>
Wrong number of received bytes
</summary>
</member>
<member name="F:S7.Net.ErrorCode.SendData">
<summary>
Error on send data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.ReadData">
<summary>
Error on read data
</summary>
</member>
<member name="F:S7.Net.ErrorCode.WriteData">
<summary>
Error on write data
</summary>
</member>
<member name="T:S7.Net.DataType">
<summary>
Types of memory area that can be read
</summary>
</member>
<member name="F:S7.Net.DataType.Input">
<summary>
Input area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Output">
<summary>
Output area memory
</summary>
</member>
<member name="F:S7.Net.DataType.Memory">
<summary>
Merkers area memory (M0, M0.0, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.DataBlock">
<summary>
DB area memory (DB1, DB2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Timer">
<summary>
Timer area memory(T1, T2, ...)
</summary>
</member>
<member name="F:S7.Net.DataType.Counter">
<summary>
Counter area memory (C1, C2, ...)
</summary>
</member>
<member name="T:S7.Net.VarType">
<summary>
Types
</summary>
</member>
<member name="F:S7.Net.VarType.Bit">
<summary>
S7 Bit variable type (bool)
</summary>
</member>
<member name="F:S7.Net.VarType.Byte">
<summary>
S7 Byte variable type (8 bits)
</summary>
</member>
<member name="F:S7.Net.VarType.Word">
<summary>
S7 Word variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DWord">
<summary>
S7 DWord variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Int">
<summary>
S7 Int variable type (16 bits, 2 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.DInt">
<summary>
DInt variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.Real">
<summary>
Real variable type (32 bits, 4 bytes)
</summary>
</member>
<member name="F:S7.Net.VarType.String">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.StringEx">
<summary>
String variable type (variable)
</summary>
</member>
<member name="F:S7.Net.VarType.Timer">
<summary>
Timer variable type
</summary>
</member>
<member name="F:S7.Net.VarType.Counter">
<summary>
Counter variable type
</summary>
</member>
<member name="T:S7.Net.Plc">
<summary>
Creates an instance of S7.Net driver
</summary>
</member>
<member name="P:S7.Net.Plc.IP">
<summary>
IP address of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.CPU">
<summary>
CPU type of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Rack">
<summary>
Rack of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.Slot">
<summary>
Slot of the CPU of the PLC
</summary>
</member>
<member name="P:S7.Net.Plc.MaxPDUSize">
<summary>
Max PDU size this cpu supports
</summary>
</member>
<member name="P:S7.Net.Plc.IsAvailable">
<summary>
Returns true if a connection to the PLC can be established
</summary>
</member>
<member name="P:S7.Net.Plc.IsConnected">
<summary>
Checks if the socket is connected and polls the other peer (the PLC) to see if it's connected.
This is the variable that you should continously check to see if the communication is working
See also: http://stackoverflow.com/questions/2661764/how-to-check-if-a-socket-is-connected-disconnected-in-c
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorString">
<summary>
Contains the last error registered when executing a function
</summary>
</member>
<member name="P:S7.Net.Plc.LastErrorCode">
<summary>
Contains the last error code registered when executing a function
</summary>
</member>
<member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int16,System.Int16)">
<summary>
Creates a PLC object with all the parameters needed for connections.
For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
You need slot > 0 if you are connecting to external ethernet card (CP).
For S7-300 and S7-400 the default is rack = 0 and slot = 2.
</summary>
<param name="cpu">CpuType of the PLC (select from the enum)</param>
<param name="ip">Ip address of the PLC</param>
<param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
<param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
If you use an external ethernet card, this must be set accordingly.</param>
</member>
<member name="M:S7.Net.Plc.Open">
<summary>
Open a <see cref="T:System.Net.Sockets.Socket"/> and connects to the PLC, sending all the corrected package
and returning if the connection was successful (<see cref="F:S7.Net.ErrorCode.NoError"/>) of it was wrong.
</summary>
<returns>Returns ErrorCode.NoError if the connection was successful, otherwise check the ErrorCode</returns>
</member>
<member name="M:S7.Net.Plc.Close">
<summary>
Disonnects from the PLC and close the socket
</summary>
</member>
<member name="M:S7.Net.Plc.ReadMultipleVars(System.Collections.Generic.List{S7.Net.Types.DataItem})">
<summary>
Reads multiple vars in a single request.
You have to create and pass a list of DataItems and you obtain in response the same list with the values.
Values are stored in the property "Value" of the dataItem and are already converted.
If you don't want the conversion, just create a dataItem of bytes.
DataItems must not be more than 20 (protocol restriction) and bytes must not be more than 200 + 22 of header (protocol restriction).
</summary>
<param name="dataItems">List of dataitems that contains the list of variables that must be read. Maximum 20 dataitems are accepted.</param>
</member>
<member name="M:S7.Net.Plc.ReadBytes(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
<returns>Returns the bytes in an array</returns>
</member>
<member name="M:S7.Net.Plc.Read(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte)">
<summary>
Read and decode a certain number of bytes of the "VarType" provided.
This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="varType">Type of the variable/s that you are reading</param>
<param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
<param name="varCount"></param>
</member>
<member name="M:S7.Net.Plc.Read(System.String)">
<summary>
Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct(System.Type,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
</summary>
<param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a struct that must be cast.</returns>
</member>
<member name="M:S7.Net.Plc.ReadStruct``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
</summary>
<typeparam name="T">The struct type</typeparam>
<param name="db">Address of the DB.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass(System.Object,System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<param name="sourceClass">Instance of the class that will store the values</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>The number of read bytes</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
type, the class needs a default constructor.
</summary>
<typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.ReadClass``1(System.Func{``0},System.Int32,System.Int32)">
<summary>
Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
</summary>
<typeparam name="T">The class that will be instantiated</typeparam>
<param name="classFactory">Function to instantiate the class</param>
<param name="db">Index of the DB; es.: 1 is for DB1</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
</member>
<member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Write a single bit from a DB with the specified index.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32)">
<summary>
Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
You must specify the memory area type, memory are address, byte start address and bytes count.
If the read was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<param name="bitAdr">The address of the bit. (0-7)</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.Write(System.String,System.Object)">
<summary>
Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
If the write was not successful, check <see cref="P:S7.Net.Plc.LastErrorCode"/> or <see cref="P:S7.Net.Plc.LastErrorString"/>.
</summary>
<param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
<param name="value">Value to be written to the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteStruct(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# struct to a DB in the PLC
</summary>
<param name="structValue">The struct to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.WriteClass(System.Object,System.Int32,System.Int32)">
<summary>
Writes a C# class to a DB in the PLC
</summary>
<param name="classValue">The class to be written</param>
<param name="db">Db address</param>
<param name="startByteAdr">Start bytes on the PLC</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ClearLastError">
<summary>
Sets the <see cref="P:S7.Net.Plc.LastErrorCode"/> to <see cref="F:S7.Net.ErrorCode.NoError"/> and <see cref="P:S7.Net.Plc.LastErrorString"/> to <see cref="F:System.String.Empty"/>.
</summary>
</member>
<member name="M:S7.Net.Plc.ReadHeaderPackage(System.Int32)">
<summary>
Creates the header to read bytes from the PLC
</summary>
<param name="amount"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.CreateReadDataRequestPackage(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
<summary>
Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType),
the address of the memory, the address of the byte and the bytes count.
</summary>
<param name="dataType">MemoryType (DB, Timer, Counter, etc.)</param>
<param name="db">Address of the memory to be read</param>
<param name="startByteAdr">Start address of the byte</param>
<param name="count">Number of bytes to be read</param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.WriteBytesWithASingleRequest(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
<summary>
Writes up to 200 bytes to the PLC and returns NoError if successful. You must specify the memory area type, memory are address, byte start address and bytes count.
If the write was not successful, check LastErrorCode or LastErrorString.
</summary>
<param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
<param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
<param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
<param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
<returns>NoError if it was successful, or the error is specified</returns>
</member>
<member name="M:S7.Net.Plc.ParseBytes(S7.Net.VarType,System.Byte[],System.Int32,System.Byte)">
<summary>
Given a S7 variable type (Bool, Word, DWord, etc.), it converts the bytes in the appropriate C# format.
</summary>
<param name="varType"></param>
<param name="bytes"></param>
<param name="varCount"></param>
<param name="bitAdr"></param>
<returns></returns>
</member>
<member name="M:S7.Net.Plc.VarTypeToByteLength(S7.Net.VarType,System.Int32)">
<summary>
Given a S7 <see cref="T:S7.Net.VarType"/> (Bool, Word, DWord, etc.), it returns how many bytes to read.
</summary>
<param name="varType"></param>
<param name="varCount"></param>
<returns>Byte lenght of variable</returns>
</member>
<member name="M:S7.Net.Plc.Dispose(System.Boolean)">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="M:S7.Net.Plc.Dispose">
<summary>
Releases all resources, disonnects from the PLC and closes the <see cref="T:System.Net.Sockets.Socket"/>
</summary>
</member>
<member name="T:S7.Net.TPKT">
<summary>
Describes a TPKT Packet
</summary>
</member>
<member name="M:S7.Net.TPKT.Read(System.Net.Sockets.Socket)">
<summary>
Reds a TPKT from the socket
</summary>
<param name="socket">The socket to read from</param>
<returns>TPKT Instace</returns>
</member>
<member name="T:S7.Net.Types.Bit">
<summary>
Contains the conversion methods to convert Bit from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Bit.FromByte(System.Byte,System.Byte)">
<summary>
Converts a Bit to bool
</summary>
</member>
<member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[])">
<summary>
Converts an array of bytes to a BitArray
</summary>
</member>
<member name="T:S7.Net.Types.Boolean">
<summary>
Contains the methods to read, set and reset bits inside bytes
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.GetValue(System.Byte,System.Int32)">
<summary>
Returns the value of a bit in a bit, given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.SetBit(System.Byte,System.Int32)">
<summary>
Sets the value of a bit to 1 (true), given the address of the bit
</summary>
</member>
<member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte,System.Int32)">
<summary>
Resets the value of a bit to 0 (false), given the address of the bit
</summary>
</member>
<member name="T:S7.Net.Types.Byte">
<summary>
Contains the methods to convert from bytes to byte arrays
</summary>
</member>
<member name="M:S7.Net.Types.Byte.ToByteArray(System.Byte)">
<summary>
Converts a byte to byte array
</summary>
</member>
<member name="M:S7.Net.Types.Byte.FromByteArray(System.Byte[])">
<summary>
Converts a byte array to byte
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Class">
<summary>
Contains the methods to convert a C# class to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Class.GetClassSize(System.Object)">
<summary>
Gets the size of the class in bytes.
</summary>
<param name="instance">An instance of the class</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Class.FromBytes(System.Object,System.Byte[])">
<summary>
Sets the object's values with the given array of bytes
</summary>
<param name="sourceClass">The object to fill in the given array of bytes</param>
<param name="bytes">The array of bytes</param>
</member>
<member name="M:S7.Net.Types.Class.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="sourceClass">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Counter">
<summary>
Contains the conversion methods to convert Counter from S7 plc to C# ushort (UInt16).
</summary>
</member>
<member name="M:S7.Net.Types.Counter.FromByteArray(System.Byte[])">
<summary>
Converts a Counter (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Counter.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
<member name="T:S7.Net.Types.DataItem">
<summary>
Create an instance of a memory block that can be read by using ReadMultipleVars
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DataType">
<summary>
Memory area to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.VarType">
<summary>
Type of data to be read (default is bytes)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.DB">
<summary>
Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.StartByteAdr">
<summary>
Address of the first byte to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.BitAdr">
<summary>
Addess of bit to read from StartByteAdr
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Count">
<summary>
Number of variables to read
</summary>
</member>
<member name="P:S7.Net.Types.DataItem.Value">
<summary>
Contains the value of the memory area after the read has been executed
</summary>
</member>
<member name="M:S7.Net.Types.DataItem.#ctor">
<summary>
Create an instance of DataItem
</summary>
</member>
<member name="T:S7.Net.Types.DInt">
<summary>
Contains the conversion methods to convert DInt from S7 plc to C# int (Int32).
</summary>
</member>
<member name="M:S7.Net.Types.DInt.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DInt (4 bytes) to int (Int32)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32)">
<summary>
Converts a int (Int32) to S7 DInt (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32[])">
<summary>
Converts an array of int (Int32) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.DInt.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DInt to an array of int (Int32)
</summary>
</member>
<member name="T:S7.Net.Types.Double">
<summary>
Contains the conversion methods to convert Real from S7 plc to C# double.
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Real (4 bytes) to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.Int32)">
<summary>
Converts a S7 DInt to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.FromDWord(System.UInt32)">
<summary>
Converts a S7 DWord to double
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double)">
<summary>
Converts a double to S7 Real (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToByteArray(System.Double[])">
<summary>
Converts an array of double to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Double.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Real to an array of double
</summary>
</member>
<member name="T:S7.Net.Types.DWord">
<summary>
Contains the conversion methods to convert DWord from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromByteArray(System.Byte[])">
<summary>
Converts a S7 DWord (4 bytes) to uint (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.FromBytes(System.Byte,System.Byte,System.Byte,System.Byte)">
<summary>
Converts 4 bytes to DWord (UInt32)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32)">
<summary>
Converts a uint (UInt32) to S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32[])">
<summary>
Converts an array of uint (UInt32) to an array of S7 DWord (4 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.DWord.ToArray(System.Byte[])">
<summary>
Converts an array of S7 DWord to an array of uint (UInt32)
</summary>
</member>
<member name="T:S7.Net.Types.Int">
<summary>
Contains the conversion methods to convert Int from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Int.FromByteArray(System.Byte[])">
<summary>
Converts a S7 Int (2 bytes) to short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16)">
<summary>
Converts a short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToByteArray(System.Int16[])">
<summary>
Converts an array of short (Int16) to a S7 Int byte array (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Int.ToArray(System.Byte[])">
<summary>
Converts an array of S7 Int to an array of short (Int16)
</summary>
</member>
<member name="M:S7.Net.Types.Int.CWord(System.Int32)">
<summary>
Converts a C# int value to a C# short value, to be used as word.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.StringEx">
<summary>
Contains the methods to convert from S7 strings to C# strings
there are two kinds how strings a send. This one is with a pre of two bytes
they contain the length of the string
</summary>
</member>
<member name="M:S7.Net.Types.StringEx.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.String">
<summary>
Contains the methods to convert from S7 strings to C# strings
</summary>
</member>
<member name="M:S7.Net.Types.String.ToByteArray(System.String)">
<summary>
Converts a string to S7 bytes
</summary>
</member>
<member name="M:S7.Net.Types.String.FromByteArray(System.Byte[])">
<summary>
Converts S7 bytes to a string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Struct">
<summary>
Contains the method to convert a C# struct to S7 data types
</summary>
</member>
<member name="M:S7.Net.Types.Struct.GetStructSize(System.Type)">
<summary>
Gets the size of the struct in bytes.
</summary>
<param name="structType">the type of the struct</param>
<returns>the number of bytes</returns>
</member>
<member name="M:S7.Net.Types.Struct.FromBytes(System.Type,System.Byte[])">
<summary>
Creates a struct of a specified type by an array of bytes.
</summary>
<param name="structType">The struct type</param>
<param name="bytes">The array of bytes</param>
<returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
</member>
<member name="M:S7.Net.Types.Struct.ToBytes(System.Object)">
<summary>
Creates a byte array depending on the struct type.
</summary>
<param name="structValue">The struct object</param>
<returns>A byte array or null if fails.</returns>
</member>
<member name="T:S7.Net.Types.Timer">
<summary>
Converts the Timer data type to C# data type
</summary>
</member>
<member name="M:S7.Net.Types.Timer.FromByteArray(System.Byte[])">
<summary>
Converts the timer bytes to a double
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushorts (Uint16) to an array of bytes formatted as time
</summary>
</member>
<member name="M:S7.Net.Types.Timer.ToArray(System.Byte[])">
<summary>
Converts an array of bytes formatted as time to an array of doubles
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="T:S7.Net.Types.Word">
<summary>
Contains the conversion methods to convert Words from S7 plc to C#.
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromByteArray(System.Byte[])">
<summary>
Converts a word (2 bytes) to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.FromBytes(System.Byte,System.Byte)">
<summary>
Converts 2 bytes to ushort (UInt16)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16)">
<summary>
Converts a ushort (UInt16) to word (2 bytes)
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16[])">
<summary>
Converts an array of ushort (UInt16) to an array of bytes
</summary>
</member>
<member name="M:S7.Net.Types.Word.ToArray(System.Byte[])">
<summary>
Converts an array of bytes to an array of ushort
</summary>
</member>
</members>
</doc>
packages/S7netplus.0.4.0/S7netplus.0.4.0.nupkg
Vendored
BIN
View File
Binary file not shown.