BitMapResourceEncoder: Encode

Encode

Encodes a bitmap into a ResourceKey and encoded byte array.



 Public Function Encode(
	  ByRef Value As Variant,
	  ByRef ResourceName As Variant,
	  Optional ByRef ResourceType As Variant,
	  Optional ByRef LanguageID As Variant ) As Boolean

Parameters

Value
[ByRef] Variant. The bitmap to be encoded.
ResourceName
[ByRef] Variant. The name or ID of the bitmap.
ResourceType
[ByRef] Optional. Variant. The type of value being encoded. This will always be ignored, and the value ResourceTypes.BitMapResource is used.
LanguageID
[ByRef] Optional. Variant. The LocaleID the bitmap is associated with.

Return Values

Boolean -  Returns True if the encoder was able to encode the value, False otherwise.

Remarks

Any value can be passed in. No exception is thrown. If the value is not a bitmap then the function returns False.

The ResourceName can be a String or a Numeric value.

The LanguageID can be a CultureInfo object, a culture name, or an LCID. If the LanguageID is not supplied, then the current culture is used.

See Also

Project CorLib Overview

Class BitMapResourceEncoder Overview