ACAPI_Element_SetUserData
요소에 사용자 데이터를 부착합니다.
GSErrCode ACAPI_Element_SetUserData ( API_Elem_Head* elemHead, const API_ElementUserData* userData );
파라미터
- elemHead
- [in] 요소의 헤더입니다. (typeID와 guid 필드만 사용함)
- userData
- [in] 새로운 사용자 데이터에 대한 포인터입니다.
리턴 값
NoError
- 함수가 성공적으로 완료되었습니다.
APIERR_BADPARS
- 전달된 파라미터들 중 하나 이상이
NULL
입니다. APIERR_BADPLATFORMSIGN
- 주어진 플랫폼 기호가 유효하지 않습니다. (범위 밖입니다)
APIERR_MEMFULL
- 메모리가 부족합니다.
다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.
설명
이 함수는 요소에 부착할 사용자 데이터를 넣는 데 사용합니다. 요소 레코드로부터 데이터를 가져오려면 ACAPI_Element_GetUserData 함수를 사용하십시오.
이 함수는 undoable하지 않음을 참고하십시오.
호출자는 userData->dataHdl
핸들을 할당 및 해제해야 합니다.
요구사항
- 버전: API 3.1 또는 이후
- 헤더: ACAPinc.h
참고사항
API_Elem_Head, API_ElementUserData,
ACAPI_Element_GetUserData,
요소 관리자, API 함수