GetPropertyDataStruct
The GetPropertyDataStruct function retrieves information about a property in the Contacts database.
Syntax
int GetPropertyDataStruct(int fFlag, ULONG uValue, PropertyDataStruct *ppds);
At a Glance
| Header file: |
Addrstor.h |
| Platforms: |
H/PC |
| Versions: |
1.0 and later |
Parameters
- fFlag
- How GetPropertyDataStruct should retrieve the property information. This parameter must be one of the following values:
- GPDS_INDEX
- Use the property's position index to retrieve the information. Using this flag is the most efficient way to retrieve property information. The uValue parameter specifies the index.
- GPDS_NAME
- Use the property's name to retrieve the information. The uValue parameter specifies the name.
- GPDS_PROPERTY
- Use the property tag of the property to retrieve the information. The uValue parameter specifies the property tag.
- uValue
- Information to retrieve. The meaning of this parameter depends on the fFlag parameter.
- ppds
- Pointer to the PropertyDataStruct structure that receives the information about the property.
Return Values
Returns the position index of the given property if successful, or GPDS_ERR otherwise.
Remarks
Passing in a NULL value for the ppds parameter will not cause the GetPropertyDataStruct function to fail. The position index of the given property is returned; however, since ppds does not point to a valid PropertyDataStruct it is ignored.