Sets property iterator to first property.
Syntax
GsFunStat GsPropFirst(Proplist* pProps);
Arguments
pProps Pointer to property list structure. Input.
Return Values
GS_SUCCESS
GS_ERROR
Prerequisites
GsPropListCreate()
Notes
Prior to iterating through the properties in a property list, this function sets the property list iterator to the beginning of the list.
Example
GsFunStat retval;
PropList findProps;
PropEnum propID;
PropValue propValue = {GS_UNDEF_PROP_TYPE, 0};
retval = GsPropListCreate(&findProps, GS_FIND_PROP_LIST_TYPE);
retval = GsPropSetBool(&findProps, GS_FIND_MIXED_CASE, TRUE);
retval = GsPropSetLong(&findProps, GS_FIND_MATCH_MODE, GS_MODE_CLOSE);
retval = GsPropSetLong(&findProps, GS_FIND_STREET_OFFSET, 50);
GsPropFirst(&findProps );
while (GsPropGetNext(&findProps, &propID, &propValue) == GS_SUCCESS )
{
switch (propValue.propType)
{
case GS_BOOL_PROP_TYPE:
...
break;
case GS_LONG_PROP_TYPE:
...
break;
case GS_STRING_PROP_TYPE:
...
break;
case GS_DOUBLE_PROP_TYPE:
case GS_UNDEF_PROP_TYPE:
default:
...
break;
}
}