 |
PK_ATTRIB_set_ustring |
|
PK_ERROR_code_t PK_ATTRIB_set_ustring
(
--- received arguments ---
PK_ATTRIB_t attrib, --- attribute
int field_no, --- field number (>= 0)
const PK_UCHAR_t *string --- null-terminated string to set
--- (possibly NULL or "")
)
This function copies Unicode 'string' into field number 'field_no' of the
given attribute.
Specific Errors:
PK_ERROR_bad_field_number (MILD) The attribute does not have a field
with this number
PK_ERROR_field_of_wrong_type (MILD) The field is not a ustring field
PK_ERROR_bad_value (MILD) The field data is in some way
invalid for the intended field.
PK_ERROR_not_same_length (MILD) The 'attrib' is a no-roll attribute
and the length of 'string' is not
equal to the existing field length
The new data replaces any existing data stored in the field.
If a zero length string or NULL is given as the 'string' argument, the
field is set to be empty.
Unicode defines a special 16-bit character (the Byte Order Mark: U+FEFF)
which is used to signal the byte serialization used by a particular
computer architecture. If a Unicode string is presented to Parasolid
with this marker reversed (ie, the first element is the sequence U+FFFE)
then Parasolid will reverse the byte order of the given 'string';
subsequent enquiries will receive a correctly ordered sequence for the
current machine.
See here for more information about attribute processing.