Click or drag to resize

OidExtensionsFormat Method

Formats current OID instance to textual representation.

Namespace:  SysadminsLV.PKI.Utils.CLRExtensions
Assembly:  SysadminsLV.PKI (in SysadminsLV.PKI.dll) Version: 3.7.0.0 (3.7.0.0)
Syntax
Copy
public static string Format(
	this Oid oid,
	bool fullValue
)

Parameters

oid
Type: System.Security.CryptographyOid
Oid object to format.
fullValue
Type: SystemBoolean
Indicates whether to format both, OID friendly name and OID value.

Return Value

Type: String
Formatted OID value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Oid. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
Depending on OID value and parameters, OID object can be encoded differently.

If fullValue is set to False and FriendlyName is not null, OID friendly name is returned, otherwise returns Value.

If fullValue is set to True and FriendlyName is not null, method returns both, OID friendly name and value, otherwise returns Value.

Examples
Examples:
Copy
Oid oid = new Oid("1.2.3.4.5");
oid.Format(false); // Format is extension method here.
// outputs: 1.2.3.4.5
oid.Format(true);
// outputs: 1.2.3.4.5 -- the same as previously, because the OID is unknown.
oid = new Oid("1.3.14.3.2.26");
oid.Format(false);
// outputs: sha1
oid.Format(true);
// outputs: sha1 (1.3.14.3.2.26)
See Also