Skip to content

GetNameFromResourceList.md

Latest commit

 

History

History
74 lines (60 loc) · 2.02 KB

GetNameFromResourceList.md

File metadata and controls

74 lines (60 loc) · 2.02 KB
Raw

GetNameFromResourceList

Description

Returns the name to display of the indicated item in the specified resource list. If the list has items with the same name from different files, the display name will have the filename added to it in parentheses.

FUNCTION GetNameFromResourceList(
				listID : LONGINT;
				index  : LONGINT): STRING;
def vs.GetNameFromResourceList(listID, index):
    return STRING

Parameters

Name Type Description
listID LONGINT an ID for a resouce list created by the BuildResourceList function.
index LONGINT an index into the list.

Remarks

To get the actual name use GetActualNameFromResourceList.

Examples

WorkingWithResrouceList

BEGIN
symDefCnt := symDefCnt + 1;
CheckSymDefAlloc;
symDefs[symDefCnt].folderName := folderDisplayName;
symDefs[symDefCnt].symName := GetNameFromResourceList(defaultListID, i);
symDefs[symDefCnt].folderLevel := -1;
symDefs[symDefCnt].resourceIndex := i;
IF symDefs[symDefCnt].symName = symName THEN selSymFolder := folderDisplayName;
END;

BEGIN
TempStr := GetNameFromResourceList(ResourceListID,I);
IF TempStr=gMarker1Name THEN
	BEGIN
	FoundMarker := TRUE;
	actualMarker1Name := GetActualNameFromResourceList(ResourceListID,I);

ELSE BEGIN
	gImagePopup5Str := GetNameFromResourceList( defConListID, gImagePopup5Int );
	resourceH := GetObject( gImagePopup5Str );
	PIOHand := FInSymDef( resourceH );
	gSymbolInfo [cnt].shapeName := GetName( GetRecord (PIOHand, (NumRecords(PIOHand))));
	gSymbolInfo[cnt].deleteMe := FALSE;
import vs

# Returns the name to display of the indicated item in the specified resource
# list.
listID = 1
index = 1

name = vs.GetNameFromResourceList(listID, index)
vs.Message('GetNameFromResourceList returned: ' + str(name))

See Also

VS Functions: GetActualNameFromResourceList

Version

Availability: from VectorWorks12.0

Category