ACAPI_Element_GetUserData
요소에 부착된 사용자 데이터를 가져옵니다.
GSErrCode ACAPI_Element_GetUserData ( API_Elem_Head* elemHead, API_ElementUserData* userData, UInt32 mask );
파라미터
- elemHead
- [in] 요소를 식별합니다.
- userData
- [in/out] 사용자 데이터에 대한 포인터입니다.
- mask
- [in] 선택적인 마스크입니다. 현재 유효한 값들은
0
과APIElemMask_FloorPlan
입니다. 후자의 경우, 데이터베이스 변경 없이 평면도 데이터베이스의 요소들을 직접 셉니다.
리턴 값
NoError
- 함수가 성공적으로 완료되었습니다.
APIERR_BADPARS
- 전달된 파라미터가
NULL입니다; userData
APIERR_BADID
elemHead
가 올바르지 않습니다.APIERR_NOUSERDATA
- 지정된 서명과 함께 부착된 사용자 데이터가 없습니다.
다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.
설명
이 함수는 요소로부터 부착된 사용자 데이터를 가져오는 데 사용합니다. 요소 레코드에 데이터를 넣으려면 ACAPI_Element_SetUserData 함수들을 사용하십시오.
요소 레코드들에 데이터 저장하기 페이저에서 이 주제에 대한 내용을 더 읽어볼 수 있습니다.
요구사항
- 버전: API 4.1 또는 이후
- 헤더: ACAPinc.h
참고사항
API_ElemTypeID, API_ElementUserData,
ACAPI_Element_SetUserData,
요소 관리자, API 함수