MetaObject.GetSWord Method

Definition

Namespace: P1.ImageSdk

Get scalar signed word from object. Can only be used on binary metaobjects with the correct type.

public short GetSWord(ref bool error);

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not success full the error flag will be set and 0 is returned.