Merge pull request #12 from waqasm78/master

Added documentation articles

Author: JonathanMagnan

docs2/pages/documentations/string/string-compare-current-culture-ignore-case.md

@@ -0,0 +1,52 @@
+# String_CompareCurrentCultureIgnoreCase
+
+`String_CompareCurrentCultureIgnoreCase` compares two specified String objects using culture-sensitive sort rules, the current culture, and ignoring the case of the strings, and returns an integer that indicates their relative position in the sort order.
+
+```csharp
+String_CompareCurrentCultureIgnoreCase (
+    @strA NVARCHAR (MAX), 
+    @strB NVARCHAR (MAX)
+    )
+RETURNS INT
+```
+
+## Parameters
+
+  - **strA**: The first string to compare.
+  - **strB**: The second string to compare.
+
+## Returns
+
+A 32-bit signed integer that indicates the lexical relationship between the two comparands.
+
+| Value        | Condition    |
+|:--------- |:--------- |
+|Less than zero        |strA precedes strB in the sort order.|
+|Zero                |strA occurs in the same position as strB in the sort order.|
+|Greater than zero    |strA follows strB in the sort order.|
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareCurrentCultureIgnoreCase('case', 'Case')
+SELECT SQLNET::String_CompareCurrentCultureIgnoreCase('encyclopædia', 'encyclopaedia')
+```
+
+# String_CompareCurrentCultureIgnoreCase4k
+
+It is equivalent to `String_CompareCurrentCultureIgnoreCase` except no NVARCHAR(MAX) parameters; it can be used when input data will never be over 4000 characters as this function offers better performance.
+
+```csharp
+String_CompareCurrentCultureIgnoreCase4k (
+    @strA NVARCHAR (4000), 
+    @strB NVARCHAR (4000)
+    )
+RETURNS INT
+```
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareCurrentCultureIgnoreCase4k('case', 'Case')
+SELECT SQLNET::String_CompareCurrentCultureIgnoreCase4k('encyclopædia', 'encyclopaedia')
+```

docs2/pages/documentations/string/string-compare-current-culture.md

@@ -0,0 +1,52 @@
+# String_CompareCurrentCulture
+
+`String_CompareCurrentCulture` compares two specified String objects using culture-sensitive sort rules and the current culture, and returns an integer that indicates their relative position in the sort order.
+
+```csharp
+String_CompareCurrentCulture (
+	@strA NVARCHAR (MAX), 
+	@strB NVARCHAR (MAX)
+	)
+RETURNS INT
+```
+
+## Parameters
+
+  - **strA**: The first string to compare.
+  - **strB**: The second string to compare.
+
+## Returns
+
+A 32-bit signed integer that indicates the lexical relationship between the two comparands.
+
+| Value		| Condition	|
+|:--------- |:--------- |
+|Less than zero		|strA precedes strB in the sort order.|
+|Zero				|strA occurs in the same position as strB in the sort order.|
+|Greater than zero	|strA follows strB in the sort order.|
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareCurrentCulture('case', 'Case')
+SELECT SQLNET::String_CompareCurrentCulture('encyclopædia', 'encyclopaedia')
+```
+
+# String_CompareCurrentCulture4k
+
+It is equivalent to `String_CompareCurrentCulture` except no NVARCHAR(MAX) parameters; it can be used when input data will never be over 4000 characters as this function offers better performance.
+
+```csharp
+String_CompareCurrentCulture4k (
+	@strA NVARCHAR (4000), 
+	@strB NVARCHAR (4000)
+	)
+RETURNS INT
+```
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareCurrentCulture4k('case', 'Case')
+SELECT SQLNET::String_CompareCurrentCulture4k('encyclopædia', 'encyclopaedia')
+```

docs2/pages/documentations/string/string-compare-ignore-case.md

@@ -0,0 +1,52 @@
+# String_CompareIgnoreCase
+
+`String_CompareIgnoreCase` compares two specified String objects, ignoring or honoring their case, and returns an integer that indicates their relative position in the sort order.
+
+```csharp
+String_CompareIgnoreCase (
+	@strA NVARCHAR (MAX), 
+	@strB NVARCHAR (MAX)
+	)
+RETURNS INT
+```
+
+## Parameters
+
+  - **strA**: The first string to compare.
+  - **strB**: The second string to compare.
+
+## Returns
+
+A 32-bit signed integer that indicates the lexical relationship between the two comparands.
+
+| Value		| Condition	|
+|:--------- |:--------- |
+|Less than zero		|strA precedes strB in the sort order.|
+|Zero				|strA occurs in the same position as strB in the sort order.|
+|Greater than zero	|strA follows strB in the sort order.|
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareIgnoreCase('case', 'Case')
+SELECT SQLNET::String_CompareIgnoreCase('Archæology', 'ARCHÆOLOGY')
+```
+
+# String_CompareIgnoreCase4k
+
+It is equivalent to `String_CompareIgnoreCase` except no NVARCHAR(MAX) parameters; it can be used when input data will never be over 4000 characters as this function offers better performance.
+
+```csharp
+String_CompareIgnoreCase4k (
+	@strA NVARCHAR (4000), 
+	@strB NVARCHAR (4000)
+	)
+RETURNS INT
+```
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareIgnoreCase4k('case', 'Case')
+SELECT SQLNET::String_CompareIgnoreCase4k('Archæology', 'ARCHÆOLOGY')
+```

docs2/pages/documentations/string/string-compare-invariant-culture.md

@@ -0,0 +1,52 @@
+# String_CompareInvariantCulture
+
+`String_CompareInvariantCulture` compares two specified String objects using culture-sensitive sort rules and the invariant culture, and returns an integer that indicates their relative position in the sort order.
+
+```csharp
+String_CompareInvariantCulture (
+	@strA NVARCHAR (MAX), 
+	@strB NVARCHAR (MAX)
+	)
+RETURNS INT
+```
+
+## Parameters
+
+  - **strA**: The first string to compare.
+  - **strB**: The second string to compare.
+
+## Returns
+
+A 32-bit signed integer that indicates the lexical relationship between the two comparands.
+
+| Value		| Condition	|
+|:--------- |:--------- |
+|Less than zero		|strA precedes strB in the sort order.|
+|Zero				|strA occurs in the same position as strB in the sort order.|
+|Greater than zero	|strA follows strB in the sort order.|
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareInvariantCulture('case', 'Case')
+SELECT SQLNET::String_CompareInvariantCulture('encyclopædia', 'encyclopaedia')
+```
+
+# String_CompareInvariantCulture4k
+
+It is equivalent to `String_CompareInvariantCulture` except no NVARCHAR(MAX) parameters; it can be used when input data will never be over 4000 characters as this function offers better performance.
+
+```csharp
+String_CompareInvariantCulture4k (
+	@strA NVARCHAR (4000), 
+	@strB NVARCHAR (4000)
+	)
+RETURNS INT
+```
+
+## Example
+
+```csharp
+SELECT SQLNET::String_CompareInvariantCulture4k('case', 'Case')
+SELECT SQLNET::String_CompareInvariantCulture4k('encyclopædia', 'encyclopaedia')
+```

docs2/pages/documentations/string/string-compare.md

@@ -0,0 +1,50 @@
+# String_Compare
+
+`String_Compare` compares two specified String objects and returns an integer that indicates their relative position in the sort order.
+
+```csharp
+String_Compare (
+	@strA NVARCHAR (MAX), 
+	@strB NVARCHAR (MAX)
+	)
+RETURNS INT
+```
+
+## Parameters
+
+  - **strA**: The first string to compare.
+  - **strB**: The second string to compare.
+
+## Returns
+
+A 32-bit signed integer that indicates the lexical relationship between the two comparands.
+
+| Value		| Condition	|
+|:--------- |:--------- |
+|Less than zero		|strA precedes strB in the sort order.|
+|Zero				|strA occurs in the same position as strB in the sort order.|
+|Greater than zero	|strA follows strB in the sort order.|
+
+## Example
+
+```csharp
+SELECT SQLNET::String_Compare('abc', 'abc')
+```
+
+# String_Compare4k
+
+It is equivalent to `String_Compare` except no NVARCHAR(MAX) parameters; it can be used when input data will never be over 4000 characters as this function offers better performance.
+
+```csharp
+String_Compare4k (
+	@strA NVARCHAR (4000), 
+	@strB NVARCHAR (4000)
+	)
+RETURNS INT
+```
+
+## Example
+
+```csharp
+SELECT SQLNET::String_Compare4k('abc', 'abc')
+```

docs2/pages/documentations/string/string.md

@@ -0,0 +1,12 @@
+# String
+
+Represents text as a sequence of UTF-16 code units.
+
+
+| Name | Description | Example |
+| :--- | :---------- | :------ |
+| [String_Compare](/string-compare) | Compares two specified String objects. | [Try it]()|
+| [String_CompareCurrentCulture](/string-compare-current-culture) | Compares two specified String objects using culture-sensitive sort rules and the current culture. | [Try it]()|
+| [String_CompareCurrentCultureIgnoreCase](/string-compare-current-culture-ignore-case) | Compares two specified String objects using culture-sensitive sort rules, the current culture, and ignoring the case of the strings. | [Try it]()|
+| [String_CompareIgnoreCase](/string-compare-ignore-case) | Compares two specified String objects ignoring their case. | [Try it]()|
+| [String_CompareInvariantCulture](/string-compare-invariant-culture) | Compares two specified String objects using culture-sensitive sort rules and the invariant culture. | [Try it]()|