diQRcodeNet Namespace
=====================
.NET interface to diQRcode.


Classes
-------

| Class       | Description             |
| ----------- | ----------------------- |
| [QRcode](#qrcode_qrcode) | Create a QR code image. |


Enumerations
------------

| Enumeration    | Description                 |
| -------------- | --------------------------- |
| [Ecc](#ecc_ecc)       | Error correction code level |
| [ImageType](#imagetype_imagetype) | Image type                  |
| [Options](#options_options)   | Option flags                |




<a id="qrcode_qrcode"></a>


QRcode Class
============
Create a QR code image.


Inheritance Hierarchy
---------------------
System.Object  
  **diQRcodeNet.QRcode**  
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public class QRcode
```

The **QRcode** type exposes the following members.


Methods
-------

| Name                   | Description                                                        |
| ---------------------- | ------------------------------------------------------------------ |
| [CreateGif](#qrcode_creategif)         | Create a GIF file of a QR code [deprecated].                       |
| [CreateGifInUtf8](#qrcode_creategifinutf8)   | Create a GIF file of a QR code, using UTF-8 encoding [deprecated]. |
| [CreateImage](#qrcode_createimage)       | Create an image file of a QR code.                                 |
| [CreateImageInUtf8](#qrcode_createimageinutf8) | Create an image file of a QR code, using UTF-8 encoding.           |
| [CreatePdf](#qrcode_createpdf)         | Create a PDF file of a QR code.                                    |
| [CreatePdfInUtf8](#qrcode_createpdfinutf8)   | Create a PDF file of a QR code, using UTF-8 encoding.              |
| [DllInfo](#qrcode_dllinfo)           | Get information about the core diQRcode DLL.                       |
| [ErrorLookup](#qrcode_errorlookup)       | Look up description for error code.                                |
| [NetVersion](#qrcode_netversion)       | Return the version of this .NET module.                            |
| [Version](#qrcode_version)          | Get version number of core diQRcode DLL.                           |


See Also
--------


[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_creategif"></a>


QRcode.CreateGif Method
=======================
Create a GIF file of a QR code [deprecated].
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreateGif(
	string outFile,
	string inputStr,
	int nPixelsPerModule = 0,
	Ecc level = Ecc.M,
	string paramStr = "",
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output GIF file to be created.

##### *inputStr*  String
Text input to be encoded (ANSI characters only).

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm)

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction level (default = M)

##### *paramStr*  String  (Optional)
Optional parameter string. Set as `"margin=N"` to change the margin to N modules (default=4).

##### *options*  [Options](#options_options)  (Optional)
Set as [Escaped](#options_escaped) to indicate #-escaped sequences in the input string.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Remarks
-------
Deprecated. Use [QRCode.CreateImage](#qrcode_createimage)

Example
-------

```csharp
int n = QRcode.CreateGif("hello.gif", "hello world");
if (n != 0) Console.WriteLine("Error: {0}", QRcode.ErrorLookup(n));
```


See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_creategifinutf8"></a>


QRcode.CreateGifInUtf8 Method
=============================
Create a GIF file of a QR code, using UTF-8 encoding [deprecated].
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreateGifInUtf8(
	string outFile,
	string inputStr,
	int nPixelsPerModule = 0,
	Ecc level = Ecc.M,
	string paramStr = "",
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output GIF file to be created.

##### *inputStr*  String
Text input to be encoded.

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm)

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction code level (default = M)

##### *paramStr*  String  (Optional)
Optional parameter string. Set as `"margin=N"` to change the margin to N modules (default=4).

##### *options*  [Options](#options_options)  (Optional)
Option flags.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Remarks
-------
Any non-ASCII characters in `inputStr` will be encoded in UTF-8 before processing. Deprecated. Use [QRCode.CreateImageInUtf8](#qrcode_createimageinutf8)

See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_createimage"></a>


QRcode.CreateImage Method
=========================
Create an image file of a QR code.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreateImage(
	string outFile,
	string inputStr,
	ImageType imageType = ImageType.Gif,
	int nPixelsPerModule = 0,
	int margin = 0,
	Ecc level = Ecc.M,
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output image file to be created.

##### *inputStr*  String
Text input to be encoded (ANSI characters only).

##### *imageType*  [ImageType](#imagetype_imagetype)  (Optional)
Image type (GIF/SVG) (default = GIF).

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm).

##### *margin*  Int32  (Optional)
Size of margin in modules (default = 4 modules).

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction level (default = M).

##### *options*  [Options](#options_options)  (Optional)
Set as [Escaped](#options_escaped) to indicate #-escaped sequences in the input string.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Example
-------

```csharp
int n = QRcode.CreateImage("hello.gif", "hello world");
if (n != 0) Console.WriteLine("Error: {0}", QRcode.ErrorLookup(n));
n = QRcode.CreateImage("hello.svg", "hello world", ImageType.Svg);
if (n != 0) Console.WriteLine("Error: {0}", QRcode.ErrorLookup(n));
```


See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_createimageinutf8"></a>


QRcode.CreateImageInUtf8 Method
===============================
Create an image file of a QR code, using UTF-8 encoding.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreateImageInUtf8(
	string outFile,
	string inputStr,
	ImageType imageType = ImageType.Gif,
	int nPixelsPerModule = 0,
	int margin = 0,
	Ecc level = Ecc.M,
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output image file to be created.

##### *inputStr*  String
Text input to be encoded.

##### *imageType*  [ImageType](#imagetype_imagetype)  (Optional)
Image type (GIF/SVG) (default = GIF).

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm)

##### *margin*  Int32  (Optional)
Size of margin in modules (default = 4 modules).

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction code level (default = M)

##### *options*  [Options](#options_options)  (Optional)
Option flags.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Remarks
-------
Any non-ASCII characters in `inputStr` will be encoded in UTF-8 before processing.

Example
-------

```csharp
n = QRcode.CreateImageInUtf8("zz-utf8.svg", "中国", ImageType.Svg);
```


See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_createpdf"></a>


QRcode.CreatePdf Method
=======================
Create a PDF file of a QR code.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreatePdf(
	string outFile,
	string inputStr,
	int nPixelsPerModule = 0,
	Ecc level = Ecc.M,
	int nPageWidth = 0,
	int nPageHeight = 0,
	int nX = 0,
	int nY = 0,
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output PDF file to be created.

##### *inputStr*  String
Text input to be encoded.

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm)

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction code level (default = M)

##### *nPageWidth*  Int32  (Optional)
Width of PDF page in pixels (default = 0 => set width to fit QRcode image).

##### *nPageHeight*  Int32  (Optional)
Height of PDF page in pixels (default = 0 => set height to fit QRcode image).

##### *nX*  Int32  (Optional)
X-coordinate in pixels of bottom-left of QRcode image (default = 0 => at left side).

##### *nY*  Int32  (Optional)
Y-coordinate in pixels of bottom-left of QRcode image (default = 0 => at bottom).

##### *options*  [Options](#options_options)  (Optional)
Option flags.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Example
-------

```csharp
n = QRcode.CreatePdf("hello0.pdf", "Hello world!");
n = QRcode.CreatePdf("helloA4.pdf", "Hello world!", nPixelsPerModule: 6, nPageWidth: 595, nPageHeight: 842, nX: 230, nY: 380);
```


See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_createpdfinutf8"></a>


QRcode.CreatePdfInUtf8 Method
=============================
Create a PDF file of a QR code, using UTF-8 encoding.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int CreatePdfInUtf8(
	string outFile,
	string inputStr,
	int nPixelsPerModule = 0,
	Ecc level = Ecc.M,
	int nPageWidth = 0,
	int nPageHeight = 0,
	int nX = 0,
	int nY = 0,
	Options options = Options.Default
)
```

#### Parameters

##### *outFile*  String
Name of output PDF file to be created.

##### *inputStr*  String
Text input to be encoded.

##### *nPixelsPerModule*  Int32  (Optional)
Number of pixels per module (default = 2 ppm)

##### *level*  [Ecc](#ecc_ecc)  (Optional)
Error correction code level (default = M)

##### *nPageWidth*  Int32  (Optional)
Width of PDF page in pixels (default = 0 => set width to fit QRcode image).

##### *nPageHeight*  Int32  (Optional)
Height of PDF page in pixels (default = 0 => set height to fit QRcode image).

##### *nX*  Int32  (Optional)
X-coordinate in pixels of bottom-left of QRcode image (default = 0 => at left side).

##### *nY*  Int32  (Optional)
Y-coordinate in pixels of bottom-left of QRcode image (default = 0 => at bottom).

##### *options*  [Options](#options_options)  (Optional)
Option flags.

#### Return Value
Int32  
Zero on success, or a nonzero [error code](#qrcode_errorlookup).

Remarks
-------
Any non-ASCII characters in `inputStr` will be encoded in UTF-8 before processing.

See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_dllinfo"></a>


QRcode.DllInfo Method
=====================
Get information about the core diQRcode DLL.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static string DllInfo()
```

#### Return Value
String  
String with information including platform core DLL is compiled for: `Win32` or `X64`.

See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_errorlookup"></a>


QRcode.ErrorLookup Method
=========================
Look up description for error code.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static string ErrorLookup(
	int errCode
)
```

#### Parameters

##### *errCode*  Int32
Value of error code to lookup (may be positive or negative)

#### Return Value
String  
Error message, or empty string if no corresponding error code.

Example
-------

```csharp
Console.WriteLine(QRcode.ErrorLookup(-39));  // Unable to encode
```


See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_netversion"></a>


QRcode.NetVersion Method
========================
Return the version of this .NET module.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static string NetVersion()
```

#### Return Value
String  
Version string, e.g. `"03.05.00"`

See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="qrcode_version"></a>


QRcode.Version Method
=====================
Get version number of core diQRcode DLL.
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public static int Version()
```

#### Return Value
Int32  
Version number in form Major * 10000 + Minor * 100 + Release

Remarks
-------
For example, version 1.2.3 would return 10203

See Also
--------


[QRcode Class](#qrcode_qrcode)  
[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="ecc_ecc"></a>


Ecc Enumeration
===============
Error correction code level
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public enum Ecc
```


Members
-------

| Member name | Description          |
| ----------- | -------------------- |
| M           | EC level M (default) |
| L           | EC level L           |
| Q           | EC level Q           |
| H           | EC level H           |


See Also
--------


[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="imagetype_imagetype"></a>


ImageType Enumeration
=====================
Image type
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
public enum ImageType
```


Members
-------

| Member name | Description                          |
| ----------- | ------------------------------------ |
| Gif         | Output image as a GIF file (default) |
| Svg         | Output image as an SVG file          |


See Also
--------


[diQRcodeNet Namespace](#diqrcodenet-namespace)




<a id="options_options"></a>


Options Enumeration
===================
Option flags
  
**Namespace:** diQRcodeNet  
**Assembly:**  diQRcodeNet (in diQRcodeNet.dll) Version: 4.0.0.36607 (4.0.0.1)

Syntax
------

```csharp
[FlagsAttribute]
public enum Options
```


Members
-------

| Member name | Description                                        |
| ----------- | -------------------------------------------------- |
| Default     | Default options.                                   |
| Escaped     | Input string contains #-escaped sequences.         |
| Base64      | Encode image output formatted as base64 text.      |
| NoNameCheck | Do not check filename extension against file type. |


See Also
--------


[diQRcodeNet Namespace](#diqrcodenet-namespace)



***
Created: 2025-10-20 20:20:52  
Copyright (C) 2025 D.I. Management Services Pty Ltd t/a CryptoSys [https://cryptosys.net](https://cryptosys.net)