doc.xml

包含详细例子的c#创建shape文件的开源码

            <param name="hDBF">The access handle for the file to be queried, as returned by DBFOpen(), 
            or DBFCreate().</param>
            <param name="iField">The field to be queried. This should be a number between 0 and n-1, 
            where n is the number fields on the file, as returned by DBFGetFieldCount().</param>
            <param name="szFieldName">If this pointer is not NULL the name of the requested field 
            will be written to this location. The pszFieldName buffer should be at least 12 character 
            is size in order to hold the longest possible field name of 11 characters plus a terminating 
            zero character.</param>
            <param name="pnWidth">If this pointer is not NULL, the width of the requested field will be 
            returned in the int pointed to by pnWidth. This is the width in characters. </param>
            <param name="pnDecimals">If this pointer is not NULL, the number of decimal places precision 
            defined for the field will be returned. This is zero for integer fields, or non-numeric fields.</param>
            <returns>DBFFieldType</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFGetFieldIndex(System.IntPtr,System.String)">
            <summary>
            Returns the index of the field matching this name, or -1 on failure. 
            The comparison is case insensitive. However, lengths must match exactly.
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned 
            by DBFOpen(), or DBFCreate().</param>
            <param name="szFieldName">Name of the field to search for.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFReadIntegerAttribute(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            The DBFReadIntegerAttribute() will read the value of one field and return it as an integer. 
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) from which the field value should be read.</param>
            <param name="iField">The field within the selected record that should be read.</param>
            <returns>int</returns>
            <remarks>
            This can be used even with FTString fields, though the returned value will be zero if not 
            interpretable as a number.
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.DBFReadDoubleAttribute(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            The DBFReadDoubleAttribute() will read the value of one field and return it as a double. 
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) from which the field value should be read.</param>
            <param name="iField">The field within the selected record that should be read.</param>
            <returns>double</returns>
            <remarks>
            This can be used even with FTString fields, though the returned value will be zero if not 
            interpretable as a number.
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.DBFReadStringAttribute(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            The DBFReadStringAttribute() will read the value of one field and return it as a string. 
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) from which the field value should be read.</param>
            <param name="iField">The field within the selected record that should be read.</param>
            <returns>string</returns>
            <remarks>
            This function may be used on any field type (including FTInteger and FTDouble) and will 
            return the string representation stored in the .dbf file. The returned pointer is to an 
            internal buffer which is only valid untill the next DBF function call. It's contents may 
            be copied with normal string functions such as strcpy(), or strdup(). If the 
            TRIM_DBF_WHITESPACE macro is defined in shapefil.h (it is by default) then all leading and 
            trailing space (ASCII 32) characters will be stripped before the string is returned.
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.DBFReadLogicalAttribute(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            The DBFReadLogicalAttribute() will read the value of one field and return it as a boolean. 
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) from which the field value should be read.</param>
            <param name="iField">The field within the selected record that should be read.</param>
            <returns>bool</returns>
            <remarks>
            This can be used with FTString fields, in which case it returns TRUE if the string="T";
            otherwise it returns FALSE.
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.DBFIsAttributeNULL(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            This function will return TRUE if the indicated field is NULL valued otherwise FALSE. 
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) from which the field value should be read.</param>
            <param name="iField">The field within the selected record that should be read.</param>
            <returns>int</returns>
            <remarks>
            Note that NULL fields are represented in the .dbf file as having all spaces in the field. 
            Reading NULL fields will result in a value of 0.0 or an empty string with the other 
            DBFRead*Attribute() functions.
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteIntegerAttribute(System.IntPtr,System.Int32,System.Int32,System.Int32)">
            <summary>
            The DBFWriteIntegerAttribute() function is used to write a value to a numeric field 
            (FTInteger, or FTDouble). If the write succeeds the value TRUE will be returned, 
            otherwise FALSE will be returned. If the value is too large to fit in the field, 
            it will be truncated and FALSE returned.
            </summary>
            <param name="hDBF">The access handle for the file to be written, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) to which the field value should be written.</param>
            <param name="iField">The field within the selected record that should be written.</param>
            <param name="nFieldValue">The integer value that should be written.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteDoubleAttribute(System.IntPtr,System.Int32,System.Int32,System.Double)">
            <summary>
            The DBFWriteDoubleAttribute() function is used to write a value to a numeric field 
            (FTInteger, or FTDouble). If the write succeeds the value TRUE will be returned, 
            otherwise FALSE will be returned. If the value is too large to fit in the field, 
            it will be truncated and FALSE returned.
            </summary>
            <param name="hDBF">The access handle for the file to be written, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) to which the field value should be written.</param>
            <param name="iField">The field within the selected record that should be written.</param>
            <param name="dFieldValue">The floating point value that should be written.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteStringAttribute(System.IntPtr,System.Int32,System.Int32,System.String)">
            <summary>
            The DBFWriteStringAttribute() function is used to write a value to a string field (FString). 
            If the write succeeds the value TRUE willbe returned, otherwise FALSE will be returned. 
            If the value is too large to fit in the field, it will be truncated and FALSE returned.
            </summary>
            <param name="hDBF">The access handle for the file to be written, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) to which the field value should be written.</param>
            <param name="iField">The field within the selected record that should be written.</param>
            <param name="szFieldValue">The string to be written to the field.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteNULLAttribute(System.IntPtr,System.Int32,System.Int32)">
            <summary>
            The DBFWriteNULLAttribute() function is used to clear the indicated field to a NULL value. 
            In the .dbf file this is represented by setting the entire field to spaces. If the write 
            succeeds the value TRUE will be returned, otherwise FALSE will be returned.
            </summary>
            <param name="hDBF">The access handle for the file to be written, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) to which the field value should be written.</param>
            <param name="iField">The field within the selected record that should be written.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteLogicalAttribute(System.IntPtr,System.Int32,System.Int32,System.Boolean)">
            <summary>
            The DBFWriteLogicalAttribute() function is used to write a boolean value to a logical field 
            (FTLogical). If the write succeeds the value TRUE will be returned, 
            otherwise FALSE will be returned.
            </summary>
            <param name="hDBF">The access handle for the file to be written, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="iShape">The record number (shape number) to which the field value should be written.</param>
            <param name="iField">The field within the selected record that should be written.</param>
            <param name="bFieldValue">The boolean value to be written to the field.</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFReadTuple(System.IntPtr,System.Int32)">
            <summary>
            Reads the attribute fields of a record.
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="hEntity">The entity (record) number to be read</param>
            <returns>IntPtr</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFWriteTuple(System.IntPtr,System.Int32,System.IntPtr)">
            <summary>
            Writes an attribute record to the file.
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="hEntity">The zero-based entity (record) number to be written.  If hEntity equals 
            the number of records a new record is appended.</param>
            <param name="pRawTuple">Pointer to the tuple to be written</param>
            <returns>int</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFCloneEmpty(System.IntPtr,System.String)">
            <summary>
            Copies the data structure of an xBase file to another xBase file.  
            Data are not copied.  Use Read/WriteTuple functions to selectively copy data.
            </summary>
            <param name="hDBF">The access handle for the file to be queried, as returned by 
            DBFOpen(), or DBFCreate().</param>
            <param name="szFilename">The name of the xBase (.dbf) file to create.</param>
            <returns>IntPtr</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFClose(System.IntPtr)">
            <summary>
            The DBFClose() function will close the indicated xBase file (opened with DBFOpen(), 
            or DBFCreate()), flushing out all information to the file on disk, and recovering 
            any resources associated with having the file open. The file handle (hDBF) should not 
            be used again with the DBF API after calling DBFClose().
            </summary>
            <param name="hDBF">The access handle for the file to be closed.</param>
            <returns>void</returns>
        </member>
        <member name="M:MapTools.ShapeLib.DBFGetNativeFieldType(System.IntPtr,System.Int32)">
            <summary>
            This function returns the DBF type code of the indicated field.
            </summary>
            <param name="hDBF">The access handle for the file.</param>
            <param name="iField">The field index to query.</param>
            <returns>sbyte</returns>
            <remarks>
            Return value will be one of:
            <list type="bullet">
            <item><term>C</term><description>String</description></item>
            <item><term>D</term><description>Date</description></item>
            <item><term>F</term><description>Float</description></item>
            <item><term>N</term><description>Numeric, with or without decimal</description></item>
            <item><term>L</term><description>Logical</description></item>
            <item><term>M</term><description>Memo: 10 digits .DBT block ptr</description></item>
            <item><term> </term><description>field out of range</description></item>
            </list>
            </remarks>
        </member>
        <member name="M:MapTools.ShapeLib.#ctor">
            <summary>
            private constructor:  no instantiation needed or permitted
            </summary>
        </member>
    </members>
</doc>